{"id":23107506,"url":"https://github.com/pixelmatters/ts-check-filter","last_synced_at":"2025-07-02T08:38:48.389Z","repository":{"id":97172498,"uuid":"416296357","full_name":"Pixelmatters/ts-check-filter","owner":"Pixelmatters","description":"Filter TS type-check errors based on rules.","archived":false,"fork":false,"pushed_at":"2024-03-04T16:13:59.000Z","size":400,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-03T22:43:29.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pixelmatters.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-12T10:48:41.000Z","updated_at":"2024-05-06T05:56:32.000Z","dependencies_parsed_at":"2025-02-09T10:40:24.190Z","dependency_job_id":"b36d9cd9-4950-4f63-80d1-9142a5d06616","html_url":"https://github.com/Pixelmatters/ts-check-filter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Pixelmatters/ts-check-filter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pixelmatters%2Fts-check-filter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pixelmatters%2Fts-check-filter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pixelmatters%2Fts-check-filter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pixelmatters%2Fts-check-filter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pixelmatters","download_url":"https://codeload.github.com/Pixelmatters/ts-check-filter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pixelmatters%2Fts-check-filter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263105433,"owners_count":23414653,"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-12-17T01:14:15.725Z","updated_at":"2025-07-02T08:38:48.365Z","avatar_url":"https://github.com/Pixelmatters.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"80\" src=\"./img/pixelmatters-logo.jpeg\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"./img/pixelmatters-name.svg\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\n  TS Check Filter\n\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003e\n  A filter for TypeScript errors.\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\nThis is useful when using code-generation tools or while migrating to a strict \u003ccode\u003etsconfig.json\u003c/code\u003e, allowing a smother and incremental transition.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Pixelmatters/ts-check-filter/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/@pixelmatters/ts-check-filter\" alt=\"ts-check-filter license.\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@pixelmatters/ts-check-filter\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@pixelmatters/ts-check-filter.svg\" alt=\"Current npm package version.\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Pixelmatters/ts-check-filter/blob/main/CONTRIBUTING.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\" alt=\"PRs welcome!\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/intent/follow?screen_name=pixelmatters_\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/follow/pixelmatters_.svg?label=Follow%20@pixelmatters_\" alt=\"Follow @pixelmatters_\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n* Ignore files based on relative path or regular expression\n* Ignore specific TS errors\n\n## Why can not be excluded on TypeScript?\n\nThe `exclude` option in `tsconfig.json` makes tsc not directly check the file. Unfortunately, if the file is used from another checked file, it will report an error. This way, it will not solve some use cases.\n\n## Usage\n\nTo install:\n\n```bash\nnpm i @pixelmatters/ts-check-filter\n```\n\nTo use the filter pipe the results into `ts-check-filter`:\n\n```bash\ntsc --noEmit | npx ts-check-filter\n```\n\nTo define the paths to be ignored create a new `ts-check-filter.js` file on the project root:\n\n```js\nmodule.exports = {\n  pathFilterRules: [/src\\/__generated__\\/.*/],\n}\n```\n\nThe `pathFilterRules` is an array of `string`s or `RegExp`. In the example above, we use a regular expression to ignore all the files under the `__generated__` directory.\n\n\u003e **Note:** If you don't pep anything into the filter it will be waiting for ever for an input.\n\n### Options\n\nDisplay the list of options by executing:\n\n```\nnpx ts-check-filter --help\n```\n\n## Development\n\nFor the development is recommended to use [PNPM](https://pnpm.io/), since is the tool that is being used to manage dependencies. So to install just run:\n\n```bash\npnpm install\n```\n\nTo test implementation and check if the code follows the right guidelines, please run:\n\n```bash\npnpm test\n```\n\n## 🤝 How to Contribute\n\nWhether you're helping us fix bugs, improve the docs, or spread the word, thank you! 💪 🧡\n\nCheck out our [**Contributing Guide**](https://github.com/Pixelmatters/tes-check-filter/blob/main/CONTRIBUTING.md) for ideas on contributing and setup steps.\n\n## 📝 License\n\nLicensed under the [BSD-2 License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelmatters%2Fts-check-filter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixelmatters%2Fts-check-filter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelmatters%2Fts-check-filter/lists"}