This packages is a set of eslint rules, recommended for all node.js Projects (including serverless lambda)
ESLint statically analyzes your code to quickly find problems. ESLint is built into most text editors and you can run ESLint as part of your continuous integration pipeline. More Info
This Project is also bundled with Prettier in order to ensure company wide Code formatting.
yarn add eslint typescript @epilot/eslint-config-react -D
Now add the config to either your package.json
:
{
"eslintConfig": {
"extends": "@epilot/eslint-config"
}
}
to your .eslintrc
:
{
"extends": "@epilot/eslint-config"
}
or .eslintrc.js
:
module.exports = {
extends: '@epilot/eslint-config'
}
Its recommended to install eslint Extension. and configure your settings like
"eslint.alwaysShowStatus": true,
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
You properly have a Prettier Extension installed. This might cause conflicts with the eslint formatter. I'd recommend to deactivate or uninstall it.
This ESLint configuration comes with some fundamental assumptions:
- node environment
- parser: typescript
- node.js (12/14 recommended)
- yarn
git clone [email protected]:e-pilot/cookie-cutter/epilot-eslint-config.git
cd epilot-eslint-config
yarn
yarn test
other useful scripts
yarn run
or check package.json
Create a Tag on master by one of these scripts
yarn release