Skip to content

NewOrbit standard typescript ready eslint configuration

License

Notifications You must be signed in to change notification settings

NewOrbit/eslint-config

Repository files navigation

eslint-config-neworbit

ESLint configuration for NewOrbit

Installation

npm install eslint eslint-config-neworbit --save-dev

Setup

Add eslint.config.js or extend existing one. Documentation: Eslint documentation

// @ts-check
import NewOrbitEslintConfig from "eslint-config-neworbit";

export default [
    ...NewOrbitEslintConfig,
    /* rest of your config, e.g.:
    {
        plugins: {
            "react-refresh": ReactRefreshPlugin,
        },
        rules: {
            "react-refresh/only-export-components": "warn",
        },
    },
    */
];

You are ready to use it from eslint CLI, by e.g. adding a script to your package.json

{
    ...
    "scripts": {
        ...
        "lint:ts": "eslint --max-warnings 0 -c eslint.config.js \"./**/*.{js,jsx,ts,tsx, mjs, mts, mjsx, mtsx}\"",
    }
}

Or you can use it from VS Code by downloading Microsoft ESLint extension

License

Made with 💖 by NewOrbit in Oxfordshire, and licensed under the MIT Licence.