Package Exports
- @roots/bud-eslint
Readme
@roots/bud-eslint
Adds eslint support to Bud
- Installation
- Usage
- Configuration
- Configure using bud.eslint
- Configure using the extensions api
- Contributing
- Bud sponsors
- Community
Installation
yarn add @roots/bud-eslint --devUsage
bud.use(require("@roots/bud-eslint"));Configuration
Default config:
| key | value |
|---|---|
| cache | true |
| cacheLocation | storage directory |
| context | src directory |
| cwd | project directory |
| exclude | node_modules |
| extensions | `['js', 'jsx', 'ts', 'tsx', 'vue'] |
| failOnError | true |
Configure using bud.eslint
bud.eslint.config({
cache: false,
});Configure using the extensions api
Configure eslint options using the extensions api
bud.extensions.get("eslint-webpack-plugin").options = {
// ... options
};Or, using hooks
bud.hooks.on("extension/eslint-webpack-plugin/options", (options) => ({
...options,
// overrides
}));Learn more about configuring eslint rules in the official Eslint user guide.
Contributing
Contributions are welcome from everyone.
We have contributing guidelines to help you get started.
Bud sponsors
Help support our open-source development efforts by becoming a patron.
Community
Keep track of development and community news.
- Participate on the Roots Discourse
- Follow @rootswp on Twitter
- Read and subscribe to the Roots Blog
- Subscribe to the Roots Newsletter
- Listen to the Roots Radio podcast