Nice Philanthropist Metalhead
    Have ideas to improve npm?Join in the discussion! »

    eslint-config-universe

    7.0.1 • Public • Published

    eslint-config-universe

    Shared ESLint configs for Node, Web, and universal Expo projects.

    Installation

    yarn add --dev eslint-config-universe

    You will also need to install eslint, prettier, @typescript-eslint/eslint-plugin, and @typescript-eslint/parser:

    yarn add --dev eslint prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser

    Usage

    Import this config into your own ESLint configuration using the extends option. ESLint checks both package.json and .eslintrc.* files for its configuration:

    package.json

    {
      "eslintConfig": {
        // Choose from universe/native, universe/node, universe/web
        "extends": "universe"
      }
    }

    .eslintrc.js

    module.exports = {
      extends: 'universe',
    };

    Customizing Prettier

    If you would like to customize the Prettier settings, create a file named .prettierrc in your project directory. An example of Prettier configuration file:

    {
      "printWidth": 100,
      "tabWidth": 2,
      "singleQuote": true,
      "jsxBracketSameLine": true,
      "trailingComma": "es5"
    }

    Read more about configuring prettier and all of the available options.

    Support for Different Platforms

    There are several configs for different platforms. They are:

    • universe: the basic config for JavaScript projects for which there isn't a more specific config
    • universe/native: the config for React Native projects, including Expo projects, with support for React and JSX
    • universe/web: the config for code that runs in web browsers, with support for React and JSX
    • universe/node: the config for code that runs in Node

    For an Expo project, your configuration might look like this:

    "eslintConfig": {
      "extends": "universe/native"
    }

    You also can extend multiple configs, which is useful for projects that span several platforms:

    "eslintConfig": {
      "extends": ["universe/node", "universe/web"]
    }

    Optional Additional TypeScript Typed Linting

    Universe also provides optional additional config for typescript-eslint rules that make use of the parsed type information. Note that this may increase the time it takes to run lint for large projects. More information can be found at https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md

    To enable the additional config, the following changes to your config are required:

    .eslintrc.js

    module.exports = {
      extends: [
        'universe',
    +   'universe/shared/typescript-analysis',
      ],
    + overrides: [
    +   {
    +     files: [
    +       '*.ts',
    +       '*.tsx',
    +       '*.d.ts'
    +     ],
    +     parserOptions: {
    +       project: './tsconfig.json'
    +     },
    +   },
    + ],
    };

    More info on parserOptions.project can be found at https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsproject

    Philosophy

    This config is designed to mark severe problems (ex: syntax errors) as errors and stylistic issues as warnings. This lets your team apply policies like, "make sure a commit has no errors but ignore warnings if the commit didn't introduce them."

    It's also designed to be a more lenient config for teams who are stronger at decision-making and have a culture of osmotically learning coding guidelines and benefit more from flexibility than rigid rules.

    Install

    npm i eslint-config-universe

    DownloadsWeekly Downloads

    9,287

    Version

    7.0.1

    License

    MIT

    Unpacked Size

    23.1 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar