Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 1.58 KB

README.md

File metadata and controls

53 lines (42 loc) · 1.58 KB

@josundt/eslint-config

ESLint ruleset including required ESLint plugins for jorundt TypeScript projects

Usage

  1. Make sure you have installed and configured @josundt/prettier-config first

  2. Install this package

    npm install @josundt/eslint-config
  3. Create an .eslintrc file in the root directory of your project with the following content:

    {
        "extends": ["@josundt"]
    }

    ["@josundt"] is the default configuration for typescript web projects with jasmine unit tests

    Other configurations:

    • ["@josundt/eslint-config/typescript-web"] (same as default; only without jasmine linting support).

    • ["@josundt/eslint-config/typescript-node-jasmine"] (same as default; but without browser environment).

    • ["@josundt/eslint-config/typescript-node"] (same as default; but without browser environment and jasmine linting support) .

  4. Add lint:ts script to your project's package.json file:

    {
        // ...
        "scripts": {
            // ...
            "lint:ts": "eslint ./src --format visualstudio --ext .ts,.tsx"
            // ...
        }
        // ...
    }
  5. Test the script:

    npm run lint:ts
  6. Live Code Analysis in Visual Studio Code:

    • Add a .eslintignore file in the root directory of your project with the following content:
      # Ignore js files; only analyze typescript files:
      **/*.js
      
    • Install extension for VSCode: ESLint (dbaeumer.vscode-eslint)