2.3.0 • Published 4 years ago

tslint-plugin-prettier v2.3.0

Weekly downloads
172,678
License
MIT
Repository
github
Last release
4 years ago

tslint-plugin-prettier

npm build coverage

Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.

Changelog

Sample

a();;;
    ~~
;;;
~~~ [Delete `;;⏎;;;`]
var foo = ''
          ~~ [Replace `''` with `"";⏎`]
var foo= "";
       ~ [Insert `·`]

Install

# using npm
npm install --save-dev tslint-plugin-prettier prettier

# using yarn
yarn add --dev tslint-plugin-prettier prettier

(require prettier@^1.9.0)

Usage

(tslint.json)

for tslint@^5.2.0

{
  "rulesDirectory": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": true
  }
}

for tslint@^5.0.0

{
  "extends": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": true
  }
}

NOTE: To use this plugin, it'd better to also use tslint-config-prettier to disable all prettier-related rules, so as to avoid conflicts between existed rules.

Options

  • If there is no option provided, it'll try to load config file and/or .editorconfig if possible, uses Prettier's default option if not found.

    {
      "extends": ["tslint-plugin-prettier"],
      "rules": {
        "prettier": true
      }
    }

    If you don't want to load .editorconfig, disable it in the third argument.

    {
      "extends": ["tslint-plugin-prettier"],
      "rules": {
        "prettier": [true, null, { "editorconfig": false }]
      }
    }
  • If you'd like to specify which config file to use, just put its path (relative to process.cwd()) in the second argument, the following example shows how to load the config file from <cwd>/configs/.prettierrc:

    {
      "extends": ["tslint-plugin-prettier"],
      "rules": {
        "prettier": [true, "configs/.prettierrc"]
      }
    }
  • If you'd like to specify options manually, just put Prettier Options in the second argument, for example:

    {
      "extends": ["tslint-plugin-prettier"],
      "rules": {
        "prettier": [true, { "singleQuote": true }]
      }
    }

Ignoring files

  • It will respect your .prettierignore file in your project root ( process.cwd() ) but if you would like to use a different file you can provide it in the third argument, for example:

    {
      "extends": ["tslint-plugin-prettier"],
      "rules": {
        "prettier": [true, null, { "ignorePath": "otherDirectory/.prettierignore" }]
      }
    }

Development

# lint
yarn run lint

# build
yarn run build

# test
yarn run test

Related

License

MIT © Ika

@katalabut/react-scripts@piratuks/lint-code-style@radar/tslint-config@teachers/tslint-config-tptreact-bootjstslint-config-levi@infinitebrahmanuniverse/nolb-tsl@everything-registry/sub-chunk-2982liberoadipiscigoodpoint.jsgrpc-exceptionlbglisting-cliirstea-typescript-configitalia-tslint-rulesmonowebjpnestin-plugin-restfulneutrino-preset-bestylededrc-backendeslint-config-akkadureact-coat-dev-pkgreact-redux-express-template-emptypicpay-tslint-rules@dvhb/tslint-config@esyoil-gmbh/config-tslint@eth-optimism/dev@hellroot/tslint-config@ferum/aave-deploy-v3@icelandair/tslint-config@ikscodes/tslint-config@itajaja/typescript@j.u.p.iter/jupiter-scriptstslint-config-gitbooktslint-config-fishbraintslint-config-aroundustslint-config-crowdrifftslint-config-dawntslint-config-activepipetslint-config-lemontslint-config-lmltslint-config-macklinutslint-config-nineyitslint-config-nokatslint-config-visibacaretslint-config-radiosilencetslint-config-slytrunktslint-config-stoplighttslint-config-suiyobivue-starter-service@jsapp/preset-apollo@jsapp/preset-apollo-ts@kj/tslint-ruleswerk85-tslint-rulestue-tue-clitheme-creativeshopts-goodeggs@limina/tslint-config@nauto/web-apps-archetype@navch/scaffold@m-fe/tslint-config@maboroshi/tslint-configrecommended-tslint-rulesshared-tslint-config-wseus-scripts@mrmartineau/scripts@lego/tslint-config-prettier@noliaki/tslint-config-prettier@phaser-cli/scripts@manuscripts/tslint-config@kurosame/tslint-config-react@kurosame/tslint-config-vue@lingua-franca/interfaces@oupdev/tslint-config-mymaths@trapts/core@trapts/route-decorator@trapts/schedule@somo/tslint-preset@recore/tslint-config@uhc/tslint-config-uhc@ukho/ts-codestyle@tira/tira-deps-dev@urbandoor/lint@verticalstrategy/tslint-config@tomblcode/cfgmgr-typescript@vermilion/tslint-config@privacycloud/linter@privacycloud/tslint-config@shoplo/tour-vue@skyrpex/tslint-config-base@radarrelay/tslint-config@springworks/tslint-config@socialgouv/tslint-config-recommended@straw-hat/cli@symfoni/buidler-react@symfoni/buidler-storage@screamz/aurora@scalio-oss/tslint-configajustor-phaser-cli-scripts@wisekingdom/tslint-config@yandex-lms-ext/tslint-config-base@xobotyi/presets
3.0.0-beta.0

4 years ago

2.3.0

4 years ago

2.2.0

4 years ago

2.1.0

4 years ago

2.0.1

5 years ago

2.0.0

6 years ago

1.3.0

7 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.0

7 years ago