Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: declare "types" in package.json to make consuming types easier #2091

Merged
merged 1 commit into from
Dec 7, 2022
Merged

feat: declare "types" in package.json to make consuming types easier #2091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"access": "public"
},
"main": "src/Eleventy.js",
"types": "src/index.d.ts",
"bin": {
"eleventy": "./cmd.js"
},
Expand Down
3 changes: 3 additions & 0 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import UserConfig from "./UserConfig";

export { UserConfig };
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per #2089, do we want to reexport the defaultConfig as well?

 * @typedef {import("@11ty/eleventy/src/UserConfig")} EleventyConfig
 * @typedef {ReturnType<import("@11ty/eleventy/src/defaultConfig")>} EleventyReturnValue

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good question, I don't think so yet. I was thinking of keeping the scope of this PR down to just setting up the initial type declaration file with the UserConfig (which is a well-defined class, making it a good initial type to export). I was thinking exporting additional types can come after this, wanted to keep this one small, easier for @zachleat to review (and hopefully merge 😄 ).

BTW, getting that EleventyReturnValue brings up a few questions... should it return a Partial of that return type (since user config doesn't require all those types, they are all optional - they get merged with the defaultConfig)? Should we make an actual explicit interface for EleventyReturnValue (the ReturnType<typeof defaultConfig> method of inferring types is missing some properties, like dir.layouts)? Does this project want to have explicitly defined types/interfaces or just let typescript infer types based on the JS? I personally like the "contract" of having explicitly defined types, but I'm just some random dude so I didn't want to include such decisions in this PR 😀