README.md

@hug/eslint-config

ESLint shareable configuration with great defaults

---

Installation

npm install @hug/eslint-config --save-dev

yarn add [email protected] @hug/eslint-config --dev

Prior to version 20.2.0

Create a tsconfig.eslint.json file at the root of your project

{
    "extends": "./tsconfig.json",
    "compilerOptions": {
        "types": [
            "node",
            "jasmine"
            //
            // In case you are using WebdriverIO
            //   "@wdio/globals/types"
            //
            // In case you are using Cypress
            //   "cypress"
            //
            // Any other types that are required by your tests
            //   ...
        ]
    },
    "include": ["src/**/*.ts", "e2e/**/*.ts"]
}

For Angular >= 10.x <= 11.x

npm install @hug/[email protected] --save-dev

yarn add [email protected] @hug/[email protected] --dev

Migrating from tslint

1. Remove tslint and codelyzer from your dependencies
2. Remove any tslint.json configuration files
3. Add eslint as a dev dependency
4. Have a look at our Angular project example and modify all your tsconfig files accordingly

---

Requirements

As of now this configuration is intented to work with Angular projects only.

Projects running under Angular 10.x can safely ignore @angular-eslint warnings during installation.

• an Angular >= 10.x project

Usage

1. Create an .eslintrc.json file at the root of your project

{
    "root": true,
    "extends": [
        /**
         *  Possible values: 'recommended (strict) | moderate (less stricter)'
         */
        "@hug/eslint-config/recommended"
    ]
}

2. Modify your existing angular.json

"architect": {
    "lint": {
        "builder": "@angular-eslint/builder:lint",
        "options": {
            "lintFilePatterns": [
                "**/*.js",
                "**/*.json",
                "**/*.ts",
                "**/*.html"
            ]
        }
    }
}

3. Run ng lint

You can also skip steps 2 and 3 and simply run:

eslint *.{js,json,ts,html}

Rules

This configuration exports a recommended set of rules that enforces good practices.

They may or may not served you well as they are mainly designed to be used by the HUG organization's team.

The rules applies as follow:

Files	Rules
*/.ts	es6, typescript, angular, rxjs, no-secrets
*/.js	es6, no-secrets
*/.mjs	es6, no-secrets
*/.html	angular-template
*/.json	no-secrets
e2e/*/.ts	es6, typescript, no-secrets, [cypress, chai-friendly - in case you are using Cypress]

Development

See the developer docs.

Contributing

> Want to Help?

Want to file a bug, contribute some code or improve documentation? Excellent!

But please read up first on the guidelines for contributing, and learn about submission process, coding rules and more.

> Code of Conduct

Please read and follow the Code of Conduct, and help us keep this project open and inclusive.

Credits

Copyright (C) 2021 HUG - Hôpitaux Universitaires Genève