{"id":13495698,"url":"https://github.com/prettier/tslint-config-prettier","last_synced_at":"2025-04-11T03:28:22.720Z","repository":{"id":21668616,"uuid":"93621682","full_name":"prettier/tslint-config-prettier","owner":"prettier","description":"Use TSLint with Prettier without any conflict","archived":false,"fork":false,"pushed_at":"2023-01-03T16:36:41.000Z","size":2059,"stargazers_count":1232,"open_issues_count":23,"forks_count":42,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-10T00:26:39.773Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prettier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-07T10:14:02.000Z","updated_at":"2025-03-08T06:28:43.000Z","dependencies_parsed_at":"2023-01-12T03:30:26.571Z","dependency_job_id":null,"html_url":"https://github.com/prettier/tslint-config-prettier","commit_stats":null,"previous_names":["alexjoverm/tslint-config-prettier"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettier%2Ftslint-config-prettier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettier%2Ftslint-config-prettier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettier%2Ftslint-config-prettier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettier%2Ftslint-config-prettier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prettier","download_url":"https://codeload.github.com/prettier/tslint-config-prettier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248281386,"owners_count":21077423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T19:01:37.273Z","updated_at":"2025-04-11T03:28:22.701Z","avatar_url":"https://github.com/prettier.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","`👷 Configuring Your Project`","others"],"sub_categories":["Prettier"],"readme":"# tslint-config-prettier\n\n[![npm](https://img.shields.io/npm/v/tslint-config-prettier.svg)](https://www.npmjs.com/package/tslint-config-prettier)\n[![Travis](https://img.shields.io/travis/alexjoverm/tslint-config-prettier.svg)](https://travis-ci.org/prettier/tslint-config-prettier)\n[![downloads](https://img.shields.io/npm/dm/tslint-config-prettier.svg)](https://www.npmjs.com/package/tslint-config-prettier)\n[![dependencies Status](https://img.shields.io/david/prettier/tslint-config-prettier.svg)](https://david-dm.org/prettier/tslint-config-prettier)\n[![devDependencies Status](https://img.shields.io/david/dev/prettier/tslint-config-prettier.svg)](https://david-dm.org/prettier/tslint-config-prettier?type=dev)\n\n\u003ch3\u003e :cop: TSLint  +  :nail_care: Prettier = :heart_eyes: \u003c/h3\u003e\n\nDo you want to use [TSLint](https://palantir.github.io/tslint/) and [Prettier](https://github.com/prettier/prettier) without conflicts? `tslint-config-prettier` disables all [conflicting rules](https://unpkg.com/tslint-config-prettier) that may cause such problems. Prettier takes care of the formatting whereas tslint takes care of all the other things.\n\n\u003e Check how it works in **[this tutorial](https://alexjoverm.github.io/2017/06/12/Use-Prettier-with-TSLint-and-be-happy/)**.\n\n### Get started\n\n```bash\nyarn add --dev tslint-config-prettier\n# or\nnpm install --save-dev tslint-config-prettier\n```\n\nMake sure you've already set up [TSLint](https://palantir.github.io/tslint/) and [Prettier](https://github.com/prettier/prettier).\n\nThen, extend your `tslint.json`, and make sure `tslint-config-prettier` is **at the end**:\n\n```json\n{\n  \"extends\": [\n    \"tslint:latest\",\n    \"tslint-config-prettier\"\n  ]\n}\n```\n\n### More configuration\n\n`tslint-config-prettier` also turns off formatting rules from the following rulesets, so you can use them safely.\n\n- [codelyzer](https://github.com/mgechev/codelyzer)\n- [tslint](https://github.com/palantir/tslint)\n- [tslint-consistent-codestyle](https://github.com/ajafff/tslint-consistent-codestyle)\n- [tslint-divid](https://github.com/jonaskello/tslint-divid)\n- [tslint-eslint-rules](https://github.com/buzinas/tslint-eslint-rules)\n- [tslint-immutable](https://github.com/jonaskello/tslint-immutable)\n- [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib)\n- [tslint-misc-rules](https://github.com/jwbay/tslint-misc-rules)\n- [tslint-react](https://github.com/palantir/tslint-react)\n- [vrsource-tslint-rules](https://github.com/vrsource/vrsource-tslint-rules)\n\n```json\n{\n  \"extends\": [\n    \"tslint:latest\",\n    \"tslint-react\",\n    \"tslint-eslint-rules\",\n    \"tslint-config-prettier\"\n  ]\n}\n```\n\n### CLI helper tool\n\n`tslint-config-prettier` is shipped with a little CLI tool to help you check if your configuration contains any rules that are in conflict with Prettier. (require `tslint` installed)\n\nIn order to execute the CLI tool, first add a script for it to `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"tslint-check\": \"tslint-config-prettier-check ./tslint.json\"\n  }\n}\n```\n\nThen run `yarn tslint-check` or `npm run tslint-check`.\n\nOr simply run `npx tslint-config-prettier-check ./tslint.json`.\n\n### Tutorials\n\n- [Using TSlint with Prettier](https://alexjoverm.github.io/2017/06/12/Use-Prettier-with-TSLint-and-be-happy/)\n- [Use Prettier with TSLint without conflicts (video)](https://egghead.io/lessons/typescript-use-prettier-with-tslint-without-conflicts-c39670eb/)\n\n### Contributing\n\nPlease read [CONTRIBUTING.md](https://github.com/prettier/tslint-config-prettier/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n### Related\n\n- [tslint-plugin-prettier](https://github.com/ikatyang/tslint-plugin-prettier) - Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.\n\n### Credits\n\nMade with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all its [contributors](https://github.com/prettier/tslint-config-prettier/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprettier%2Ftslint-config-prettier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprettier%2Ftslint-config-prettier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprettier%2Ftslint-config-prettier/lists"}