twilio-labseslint-config-twilio
Twilio's approach to JavaScript styling.
Plugins and Extensions
This config includes the following plugins and extensions:
eslint-config-twilio-baseprettiereslint-plugin-importeslint-plugin-no-only-testseslint-plugin-sonarjs
Installation
$ npm install eslint eslint-config-twilio --save-devUsage
Add the ESLint config to either your package.json or your .eslintrc:
package.json
{
"name": "my-project",
"eslintConfig": {
"extends": [
"twilio"
]
}
}.eslintrc
{
"extends": [
"twilio"
]
}Then add the following two scripts for running and fixing your codebase:
{
"scripts": {
"lint": "eslint --ext js src/",
"lint:fix": "npm run lint -- --fix"
}
}Prettier
This package makes use of Prettier for setting specific code formatting rules in your project.
If you want to allow your IDE to auto-format your code as you save it, then create a .prettierrc.js
and import the base configuration from the eslint-config-twilio.
const baseConfig = require('./node_modules/eslint-config-twilio/rules/prettier');
module.exports = {
...baseConfig,
};You might also want to edit/extend those rules according to your project style-guide. To do that, you will need to make ESLint aware of the changes.
From your .eslintrc file, add the following override rules:
"prettier/prettier": ["warn", {}, {
"usePrettierrc": true
}],