telus/telus-standard

Standard for TELUS Digital

TELUS Standard

Standard for TELUS Digital

telus-standard is inspired by standard but with TELUS specific linting and a11y rules.

For more information please see standard.js.

Install

npm install @telus/telus-standard --save-dev

Usage

You can manually run telus-standard from your project repo:

./node_modules/.bin/telus-standard

You can also add telus-standard to your package.json scripts:

{
  "scripts": {
    "lint": "telus-standard --verbose",
    "lint:fix": "telus-standard --verbose --fix",
  }
}

Migrating from @telus/eslint-config

1. Remove unnecessary packages

   npm rm @telus/eslint-config \
     eslint-config-airbnb \
     eslint-config-prettier \
     eslint-plugin-import \
     eslint-plugin-jest \
     eslint-plugin-jsx-a11y \
     eslint-plugin-react

2. Install telus-standard

   npm i --save-dev @telus/telus-standard

3. Update or add the these scripts in your package.json

   {
     "scripts": {
       "lint": "telus-standard --verbose",
       "lint:fix": "telus-standard --verbose --fix",
     }
   }

4. Run the lint command

   npm run lint

Removing eslint-loader

telus-standard does not work with eslint-loader. If you are unaware, eslint-loader runs in your webpack pipeline so that eslint rules are forced to run prior to the application working.

eslint-loader has been removed from telus-isomorphic-starter-kit, you can read more about the decision from the Pull Request.

1. Remove the package:

   npm rm eslint-loader

2. Remove references to the package in your project:

       rules: [
   -      {
   -        test: /\.(js|jsx)$/,
   -        enforce: 'pre',
   -        use: ['eslint-loader'],
   -        include: path.join(__dirname, 'src')
   -      },
          {

---

Github: @telus • Twitter: @telusdigital