Zoe
- No configuration necessary. Just install Zoe and you're ready to go.
- Prettier for formatting and style rules.
- Out-of-the-box support for React and TypeScript.
- Fix issues by running
zoe --fix. - Includes eslint-plugin-jest, eslint-plugin-unicorn and more.
Installation
Install locally:
yarn add --dev zoeor globally:
yarn global add zoeCreate an ESLint Config
The Zoe CLI will support React and TypeScript with no configuration. For additional ESLint tooling support, create a .eslintrc file and extend the configs that you need:
Extend from Zoe to enable all core rules, plugins, and React and TypeScript support
{
"extends": "zoe"
}Overrides
Zoe uses Prettier's defaults for style and cosmetic rules, and will respect Prettier's various configuration options and files.
Most rules can be overrided normally by adding them to your .eslintrc#rules:
{
"extends": "zoe",
"rules": {
"no-console": "error"
}
}Tips
Add Zoe to package.json#scripts
{
"scripts": {
"lint": "zoe",
"lint:fix": "zoe --fix"
}
}
Create a .prettierrc file to keep Zoe in sync with your Prettier config
Zoe will respect all custom Prettier settings
{
"singleQuote": true
}
Create a .eslintignore file to make Zoe skip certain paths
**/node_modules/**
lib
build
Badge
Add a Zoe badge to your project:
[](https://github.com/jorgegonzalez/zoe)
![dependabot-preview[bot]](https://avatars.githubusercontent.com/u/27856297?size=120)
![renovate[bot]](https://avatars.githubusercontent.com/u/29139614?size=120)
