eslint-config-joyn

    0.28.0 • Public • Published

    NPM Version GitHub Actions status peerDependencies

    eslint-config-joyn

    Shareable ESLint config presets for Joyn.

    This config aims for ES2015+ or TypeScript code. It supports various environments (e.g. node or browser).

    Install and Setup

    • Make sure to install all required peer dependencies along with this config: npm i -D eslint-config-joyn eslint-plugin-prettier prettier eslint-plugin-unicorn eslint-plugin-promise eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-optimize-regex eslint-plugin-no-secrets eslint-plugin-array-func
    • Add extends: "joyn" to your ESLint config.

    Specify Environments

    Example:

    The following .eslintrc.json config file configures a node project with mixed commonjs script and typescript files.

    {
        "extends": [ "joyn", "joyn/presets/node" ],
        "overrides": [
            {
                "files": [ "**/*.js" ],
                "extends": [ "joyn/presets/commonjs" ]
            },
            {
                "files": [ "**/*.ts" ],
                "extends": [ "joyn/presets/typescript" ]
            },
            {
                "files": [ "test/unit/**/*.spec.js", "test/unit/**/*.spec.ts" ],
                "extends": [ "joyn/presets/mocha-chai" ]
            }
        ]
    }

    Environments:

    • joyn/presets/browser
    • joyn/presets/node: requires additional dependencies npm i -D eslint-plugin-node
    • joyn/presets/commonjs
    • joyn/presets/esm
    • joyn/presets/typescript: requires additional dependencies npm i -D @typescript-eslint/parser @typescript-eslint/eslint-plugin and the use of --ext ESLint CLI option in order to lint .ts files
    • joyn/presets/ava: requires additional dependencies npm i -D eslint-plugin-ava
    • joyn/presets/mocha-chai: requires additional dependencies npm i -D eslint-plugin-mocha
    • joyn/presets/jest: requires additional dependencies npm i -D eslint-plugin-jest
    • joyn/presets/react: requires additional dependencies npm i -D eslint-plugin-react eslint-plugin-react-hooks

    Install

    npm i eslint-config-joyn

    DownloadsWeekly Downloads

    3,593

    Version

    0.28.0

    License

    Apache-2.0

    Unpacked Size

    67.4 kB

    Total Files

    28

    Last publish

    Collaborators

    • sharaal
    • lo1tuma
    • doque
    • janek26