Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/privatenumber/tc-passing
TypeScript migration tool: only type check previously passing files
https://github.com/privatenumber/tc-passing
baseline check lint type typescript
Last synced: 2 months ago
JSON representation
TypeScript migration tool: only type check previously passing files
- Host: GitHub
- URL: https://github.com/privatenumber/tc-passing
- Owner: privatenumber
- License: mit
- Created: 2024-06-27T07:55:41.000Z (6 months ago)
- Default Branch: develop
- Last Pushed: 2024-06-27T23:31:57.000Z (6 months ago)
- Last Synced: 2024-10-19T01:11:30.564Z (3 months ago)
- Topics: baseline, check, lint, type, typescript
- Language: TypeScript
- Homepage:
- Size: 69.3 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
tc-passing
A command that uses TypeScript to only type check previously passing files
### Why?
When integrating TypeScript into a large codebase, using `tsc --noEmit` type-checks all files and can result in an overwhelming flood of errors. This can make it difficult to spot new errors in files that were previously error-free.
`tc-passing` records the list of files that pass type check so you can be sure your type safe files remain type safe!
## 🚀 Install
```bash
npm i tc-passing
```
Note: `typescript` (or `vue-tsc`) is assumed to be installed already
## Usage
### 1. Setup (Optional)
You can use `tc-passing` directly with [npx](https://docs.npmjs.com/cli/v10/commands/npx), but for your convenience, it's recommend to add the following commands to your `package.json`:
```json5
{
"scripts": {
// ...
"type-check": "tc-passing",
"type-check:update": "tc-passing --update"
},
"lint-staged": {
"**/*.{js,ts}": "tc-passing"
}
}
```
You can also add it to a commit hook or `lint-staged`, but note `tc-passing` does not accept any arguments (e.g. for staged files).
### 2. Recording passing files
Start by running `tc-passing --update` to record the list of files that pass type check. This creates a `.tc-passing` file in your current working directory serving as a baseline for when you type check.
Here's an example of what this file looks like:
```
# Files passing type check (33.33%) (Generated by tc-passing)
path/to/file-a.ts
path/to/file-b.js
```
The first line shows a percentage of how much of the codebase is passing.
Make sure to check this file into version control: `git add .tc-passing`
### 3. Type check
Simply run `tc-passing` and it will only type check files in `.tc-passing`.
Make sure you run `tc-passing --update` periodically or whenever you fix types in a file.
### Type checker
By default, `tc-passing` will expect you to have [`typescript`](https://www.npmjs.com/package/typescript) installed for `tsc`. If you have [`vue-tsc`](https://www.npmjs.com/package/vue-tsc) installed, it will use that instead.
## FAQ
### How does `tc-passing` compare to [`tsc-baseline`](https://npmjs.com/package/tsc-baseline)?
Both tools aim to streamline TypeScript integration, but they approach baselining differently:
#### tsc-baseline
- **Focus**
Show only the new type errors since last baseline update.
- **Baseline file**
JSON file of errors. Can grow large and may lead to merge conflicts in team settings.
- **Workflow impact**
Requires frequent updates to maintain an accurate baseline, often necessitating updates with every TypeScript-related commit. Running `tsc` on every commit can slow down development. A notable issue is it doesn't propagate errors to the exit code so CI doesn't fail.
#### tc-passing
- **Focus**
Only type check files that were previously passing to ensure they remain error-free.
- **Baseline file**
Text file of passing files. Readable and easy to manage, reducing merge conflicts. Also shows progress to 100% type safety.
- **Workflow impact**
Updating the baseline is generally optional. Recommended when failing files are now passing. Necessary when more type errors are being introduced and they need to be ignored.
## Sponsors
