README.MD

ESLINT Config

Default configs

• Eslint configs recommended
• Typescript-Eslint configs recommended
• Prettier
• Jest recommended
• Vscode workspace settings for code formatting
• Editorconfig settings

How to use?

1. Install the dependencies

    npm install eslint jest @types/jest @caiocezarqueiroz/eslint-config --save-dev

    or

    yarn add eslint jest @types/jest @caiocezarqueiroz/eslint-config -D

2. To use the eslint and prettier

2.1. Create a .eslintrc.json file extending the config:

{
    "extends": "@caiocezarqueiroz/eslint-config/settingsGenerator/eslint/node.js"
}

2.2. Add the .prettier command in the package.json scripts

{
    "create-prettier-config": "node ./node_modules/@caiocezarqueiroz/eslint-config/settingsGenerator/prettier/index.js"
}

2.3. Run the .prettier command in the terminal with npm or yarn.

{
    npm run create-prettier-config

    or

    yarn create-prettier-config
}

3. To use vscode workspace settings

3.1. Add the create-workspace-vscode command in the package.json scripts.

{
    "create-workspace-vscode": "node ./node_modules/@caiocezarqueiroz/eslint-config/settingsGenerator/vscode/index.js"
}

3.2. Run the create-workspace-vscode command in the terminal with npm or yarn.

{
    npm run create-workspace-vscode

    or

    yarn create-workspace-vscode
}

4. To use .editorconfig settings

4.1. Add the .editorconfig command in the package.json scripts.

{
    "create-editor-config": "node ./node_modules/@caiocezarqueiroz/eslint-config/settingsGenerator/editorconfig/index.js"
}

4.2. Run the .editorconfig command in the terminal with npm or yarn.

{
    npm run create-editor-config

    or

    yarn create-editor-config
}