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

Jump to bottom

fix: expose plugin.configs in types #59

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: expose plugin.configs in types #59

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
24 changes: 13 additions & 11 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,21 @@ const plugin = {
"no-empty-keys": noEmptyKeys,
"no-unsafe-values": noUnsafeValues,
},
configs: {},
};

Object.assign(plugin.configs, {
recommended: {
plugins: { json: plugin },
rules: {
"json/no-duplicate-keys": "error",
"json/no-empty-keys": "error",
"json/no-unsafe-values": "error",
configs: {
recommended: {
plugins: {
get json() {
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure we want to change this into a getter. We're essentially replacing a property lookup with a function call on a key that is retrieved a lot during config calculation.

Maybe we could leave plugins as an empty object here and just assign json into the object later?

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we could leave plugins as an empty object here and just assign json into the object later?

With that change, TypeScript code will not be able to access plugin.configs.recommended.plugins.json. I think that's fine since consumers should not have to look into that property but I'm not totally sure.

Another option to expose plugin.configs.recommended.plugins.json with the correct type is using a getter in the plugin declaration and replacing it later with a plain value using Reflect.defineProperty.

Finally we could override the type inferred by tsc with a custom type (or interface) for plugin. That would make maintenance more complicated though because we'd need to update the types every time something in the plugin changes, so probably not our favorite solution.

Copy link

Choose a reason for hiding this comment

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

I mean, Typescript doesn't need plugins to be non-empty, so that could work. Would be enough to just iterate over all configs (for..in) and assign json plugin to them. This could work...

return plugin;
},
},
rules: {
"json/no-duplicate-keys": "error",
"json/no-empty-keys": "error",
"json/no-unsafe-values": "error",
},
},
},
});
};

export default plugin;
export { JSONLanguage, JSONSourceCode };