Allow to use the builder with jsdoc

[raphaelkieling]

Today if we run:

module.exports = ({ builder }) => {
   // builder. do not have any intellisense
}

[dakshsinghrathore]

Seems interesting, kindly assign me this issue would love to work on it ! @raphaelkieling

[dakshsinghrathore]

To enable IntelliSense support for JSDoc in JavaScript code that uses a builder function, we can provide type information and documentation through JSDoc comments. Here's an example of how we can achieve this:

/**
 * @param {Object} options - The options object.
 * @param {function} options.builder - The builder function.
 */
module.exports = ({ builder }) => {
   // Now, you should have IntelliSense support for 'builder'.
   builder.someMethod(); // IntelliSense should work here.
}

Above, we use @param to describe the parameter options, which is an object. Within this object, we specify that builder is a function. By providing this information, we should get IntelliSense support for the builder function and its methods.

[raphaelkieling]

This is very interesting and a very good first step, but i suppose that this @param should make reference for our real Builder to have any king of IntelliSense like:

/**
 * @param {object} params - config params
 * @param {import("../src/index").Builder} params.builder - the builder instance
 */
module.exports = ({ builder }) => {
   // Now, you should have IntelliSense support for 'builder'.
   builder.someMethod(); // IntelliSense should work here.
}

It works perfectly 😄

But we have some small issues here. Today the idea would be to avoid require the user to install the tool locally since we do not have any huge advantage doing it. It means that it will work only for who installed in their dependencies? Since they need to use the flah import("doctorenv-cli") i suppose.

/**
 * @param {object} params - config params
 * @param {import("doctorenv-cli").Builder} params.builder - the builder instance
 */
module.exports = ({ builder }) => {
   // Now, you should have IntelliSense support for 'builder'.
   builder.someMethod(); // IntelliSense should work here.
}

Final thoughts:

• Should it be a recommendation? Install locally if you want intellisense?
• Is it possible to have remote objects? Like an object from an external URL, with this the dev will not need to install the library to use the intellisense

What do you think?

[dakshsinghrathore]

1. Recommendation to Install Locally:

   • It's a good idea to suggest that users install a library locally if they want to have better code suggestions (IntelliSense) while using it. It makes their development experience smoother.

2. Remote Objects for IntelliSense:

   • Providing code suggestions for libraries not installed locally can be tricky. Typically, users can install type information separately to enable IntelliSense. There isn't a common way to offer IntelliSense for remote libraries without some local setup. However, some online tools might help with this in specific situations.