typescript - Create Eslint plugin as part of library? - Stack Overflow

admin管理员组

文章数量:1022956

I don't want to publish an eslint plugin as an own npm artifact to share it with other projects.

Instead I already have a npm package published which other projects use. So is it possible I put the Eslint plugin there, and the other projects can extend it ? Instead of having 2 npm artifacts published and having to maintain , I still have only the original one.

Thanks for your help!

I don't want to publish an eslint plugin as an own npm artifact to share it with other projects.

Instead I already have a npm package published which other projects use. So is it possible I put the Eslint plugin there, and the other projects can extend it ? Instead of having 2 npm artifacts published and having to maintain , I still have only the original one.

Thanks for your help!

• typescript
• eslint
• typescript-eslint
• eslintrc

Share Improve this question Follow asked Nov 19, 2024 at 7:17 Steve CleverSteve Clever 11711 gold badge11 silver badge77 bronze badges

Add a comment  | 

1 Answer 1

Sorted by: Reset to default 0

Yes, this is possible. ESLint's new "flat" config (https://eslint./docs/latest/use/configure/configuration-files) allows importing plugins as plain old JavaScript. See https://eslint./docs/latest/use/configure/plugins.

For example, if your plugin is located in ./packages/eslint-plugin-example, your config might look something like:

// eslint.config.js
import example from "./path/to/eslint-plugin-example";

export default [
    {
        plugins: {
            example
        },
        rules: {
            "example/rule1": "warn"
        }
    }
];

If you're using using workspaces such as through npm (https://docs.npmjs/cli/v8/using-npm/workspaces) or another package manager, that import path might just be "eslint-plugin-example" instead. It depends on how you've structured your repository.

I don't want to publish an eslint plugin as an own npm artifact to share it with other projects.

Instead I already have a npm package published which other projects use. So is it possible I put the Eslint plugin there, and the other projects can extend it ? Instead of having 2 npm artifacts published and having to maintain , I still have only the original one.

Thanks for your help!

I don't want to publish an eslint plugin as an own npm artifact to share it with other projects.

Instead I already have a npm package published which other projects use. So is it possible I put the Eslint plugin there, and the other projects can extend it ? Instead of having 2 npm artifacts published and having to maintain , I still have only the original one.

Thanks for your help!

• typescript
• eslint
• typescript-eslint
• eslintrc

Share Improve this question Follow asked Nov 19, 2024 at 7:17 Steve CleverSteve Clever 11711 gold badge11 silver badge77 bronze badges

Add a comment  | 

1 Answer 1

Sorted by: Reset to default 0

Yes, this is possible. ESLint's new "flat" config (https://eslint./docs/latest/use/configure/configuration-files) allows importing plugins as plain old JavaScript. See https://eslint./docs/latest/use/configure/plugins.

For example, if your plugin is located in ./packages/eslint-plugin-example, your config might look something like:

// eslint.config.js
import example from "./path/to/eslint-plugin-example";

export default [
    {
        plugins: {
            example
        },
        rules: {
            "example/rule1": "warn"
        }
    }
];

If you're using using workspaces such as through npm (https://docs.npmjs/cli/v8/using-npm/workspaces) or another package manager, that import path might just be "eslint-plugin-example" instead. It depends on how you've structured your repository.

本文标签： typescriptCreate Eslint plugin as part of libraryStack Overflow