Typescript typings

[gaurishhs]

From: #1052

Please suggest changes (if any)
All this has been taken from the documentation.

[cossssmin]

Thanks! Can we start with fixing the linting issues please? 😇

[gaurishhs]

How do you enable intellisense for these issues? I do have the ESLint extension installed

[cossssmin]

We’re using XO, you’ll need the linter plugin, here it is for VS Code:

https://github.com/xojs/vscode-linter-xo

[gaurishhs]

i guess we're ready to go now.

[gaurishhs]

hi @cossssmin any updates?

[cossssmin]

Hey, sorry for the delay, I've been a little busy with life offline but I'll try to go through it this week. Thanks 🙏

[cossssmin]

Getting the same error for both imports:

And for example prettify doesn't show any suggestions:

markdown is missing from the Config interface (it's only defined for the method in the RenderOptions, but I can add that no worries.

[cossssmin]

Actually on the markdown note, if I do this:

interface MarkdownConfig {
  root?: string;
  encoding?: string;
  markdownit?: Options;
  plugins?: [];
}

Then add it to the Config interface:

interface Config {
  markdown?: MarkdownConfig;
}

... I'm not seeing it autocomplete/suggested when doing Ctrl+Space?

I'm sorry, I have no experience with TS this is all new to me.

[cossssmin]

Nevermind, need to import the correct interface, going through it now 👍

/** @type {import('@maizzle/framework').Config} */

[gaurishhs]

yeah, you were importing the whole module instead of the interface. I made sure to have the same interface name as tailwind's.

[cossssmin]

Working on adding JSDoc to everything so you can see a short description in the suggestions dropdown or when hovering over a key. What do you think of using @defaultValue like this, to let the user know what the default is in Maizzle?

interface LayoutsConfig {
  /**
   * Name of the fill tag, where the content will be injected.
   * This is typically used in a Template file, to extend a Layout.
   * @defaultValue `'block'`
   */
  fillTagName?: string;
}

Looks like this:

[gaurishhs]

I did that as well but i removed it later, it seemed like a waste of time to me because I just copied text from docs which the user should read. That's a great option but imo it's just a waste of time to maintain that along with the upcoming changes (it adds more work for a developer to get a release with a lot of changes out fast). Also, it's @default not @DefaultValue microsoft/tsdoc#27

…

On Sun, 3 Sept 2023, 16:33 Cosmin Popovici, ***@***.***> wrote: Working on adding JSDoc to everything so you can see a short description in the suggestions dropdown or when hovering over a key. What do you think of using @DefaultValue like this, to let the user know what the default is in Maizzle? interface LayoutsConfig { /** * Name of the fill tag, where the content will be injected. * This is typically used in a Template file, to extend a Layout. * @DefaultValue `'block'` */ fillTagName?: string;} — Reply to this email directly, view it on GitHub <#1053 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASZRZB4QDYH76CFQZ4B4OQTXYRPX5ANCNFSM6AAAAAA3YV54WE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[cossssmin]

I really like that you can 'read the docs' right in the editor this way, looks pretty good and I'm OK with added maintenance because it adds value to the user.

Also, thanks for the pointer about @default 👍

[cossssmin]

Made some changes:

• added new types (i.e. for query-string)
• created some new intefaces for config types
• added JSDoc so the IDE shows a description and defaults/examples

The file is pretty big now so I'm thinking of splitting it up into multiple files, what do you think? We can release v4.6.0 as it is now, we can refactor/split it later.

[gaurishhs]

Yeah, that seems good.

…

On Sun, 3 Sept 2023, 21:55 Cosmin Popovici, ***@***.***> wrote: Made some changes: - added new types (i.e. for query-string) - created some new intefaces for config types - added JSDoc so the IDE shows a description and defaults/examples The file is pretty big now so I'm thinking of splitting it up into multiple files, what do you think? We can release v4.6.0 as it is now, we can refactor/split it later. — Reply to this email directly, view it on GitHub <#1053 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASZRZB22QVTAVUXISB4EFETXYSVQDANCNFSM6AAAAAA3YV54WE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[cossssmin]

Cool, merging and will release v4.6.0 tomorrow. Thank you for your contribution!