Intellisense (typedefs) for your eleventy configuration file

[binyamin]

I just thought this would be useful for people. I'd love to see a short blog post on this, if someone has time.

/**
 * @typedef {import("@11ty/eleventy/src/UserConfig")} EleventyConfig
 * @typedef {ReturnType<import("@11ty/eleventy/src/defaultConfig")>} EleventyReturnValue
 * 
 * @type {(eleventyConfig: EleventyConfig) => EleventyReturnValue}
 */
module.exports = function(eleventyConfig) {
    // write some code...
}

Edit: Shorter version

/**
 *  @param {import("@11ty/eleventy/src/UserConfig")} eleventyConfig
 *  @returns {ReturnType<import("@11ty/eleventy/src/defaultConfig")>}
 */
module.exports = function(eleventyConfig) {
    // some code...
}

[cfjedimaster]

Is this right? @type {(eleventyConfig: EleventyConfig)) => EleventyReturnValue} Looks like an extra )

[pdehaan]

I've used the @param {import("@11ty/eleventy/src/UserConfig")} eleventyConfig version before, but the defaultConfig bit is new to me and not something I would have thought to try and solve, so thanks for that!

[wommy]

so is there supposed to be a second ) or is that a typo?

in @binyamin 's example he only uses one )

seems like a mistake

[binyamin]

@wommy fixed, thanks!

[wommy]

@binyamin you mentioned earlier that YMMV with @returns

is that still true? or can we rely on it

cc: BenDMyers/serverless-contrast-starter#1

[binyamin]

@wommy Yeah, it does work. I just edited the comment. Thanks.

[pdehaan]

I'd love to see a short blog post on this, if someone has time.

I think we should file this as an official documentation request in https://github.com/11ty/11ty-website. Not sure where the final docs would love (Getting Started? somewhere else?) but having code hinting documented would be a huge improvement to my workflows and help me from mistyping eleventyConfig.setDataDeepMerge(true) wrong about 2/3rds of the time (although that will change in v1.0.0 anyways since that's the new default, if I remember correctly).

[wommy]

just found this: #577 (comment)

[zachleat]

For future folks this is on the docs here: https://www.11ty.dev/docs/config/#type-definitions