Negatively Proportional Model

    @side/prettier-config

    0.0.0 • Public • Published

    @side/prettier-config

    This is a shared configuration for Prettier that is used within JavaScript, Node.js, and TypeScript projects across reside-eng.

    Setup

    Install Prettier with Shared Configuration

    Install Prettier and this shared configuration package.

    yarn add -D prettier @side/prettier-config

    Then, update package.json to instruct Prettier to use the shared configuration.

    // package.json
    {
      "prettier": "@side/prettier-config"
    }

    Configure ESLint

    If using ESLint, install Prettier's ESLint config.

    yarn add -D eslint-config-prettier

    Then, include it in your ESLint configuration file.

    // .eslintrc.json (or .eslintrc, .eslintrc.js, etc.)
    {
      "extends": [
        "foo",
        "bar",
        "prettier" // `prettier` should always be last in `extends`
      ]
    }

    Configure lint-staged

    If using lint-staged, update its configuration to run Prettier after ESLint.

    // package.json
    {
      "lint-staged": {
        "*.{js,ts}": ["eslint --fix"],
        "*.{js,jsx,ts,tsx,yaml,yml,json,html,css}": ["prettier --write"]
      }
    }

    Add Helper Scripts

    It can be helpful to have scripts that apply and validate formatting with Prettier. Here are two examples that can be added to package.json:

    // package.json
    {
      "scripts": {
        "format": "prettier --write .",
        "format:check": "prettier --check ."
      }
    }

    The format:check script can be used within a CI workflow to validate formatting. If a file does not have the correct formatting, the script will return a failing exit code.

    Keywords

    none

    Install

    npm i @side/prettier-config

    DownloadsWeekly Downloads

    3,276

    Version

    0.0.0

    License

    MIT

    Unpacked Size

    2.51 kB

    Total Files

    4

    Last publish

    Collaborators

    • reside-eng