Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ShenQingchuan/tsc-err-dirs
Display tsc errors count on file tree.
https://github.com/ShenQingchuan/tsc-err-dirs
Last synced: 9 days ago
JSON representation
Display tsc errors count on file tree.
- Host: GitHub
- URL: https://github.com/ShenQingchuan/tsc-err-dirs
- Owner: ShenQingchuan
- License: mit
- Created: 2022-09-06T23:14:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T06:33:00.000Z (over 1 year ago)
- Last Synced: 2024-11-01T02:05:28.488Z (13 days ago)
- Language: TypeScript
- Size: 208 KB
- Stars: 100
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README-CN.md
- License: LICENSE
Awesome Lists containing this project
README
# tsc-err-dirs [](https://npmjs.com/package/@slackoff/tsc-err-dirs)
按文件树目录展示 tsc 错误数量，可以在更改文件后实时更新。
## 效果截图
## 环境需求
- node 版本: >=16
- tsc 版本: >=4.5.5
- 安装 [Nerd Font](https://github.com/ryanoasis/nerd-fonts)
> **Warning**
> 推荐在 Mac OS 或 Linux 下使用该 CLI 应用，在 Windows 的 shell 中可能有诸多限制导致效果无法实现。
## 安装
```bash
npm i -g @slackoff/tsc-err-dirs
```
## 使用方法
```bash
# the project root path MUST contains `tsconfig.json`
tsc-err-dirs
```
## 选项
- `--engine` 缩写： `-e`
**类型：** `'tsc' | 'vue-tsc'`
选择你想要执行哪一种 tsc。
## 原理
因为 `tsc` 无法在单独编译一个大项目中的某一个文件，我们必须找一个替代方案。
1. 使用 `tsc --noEmit --pretty false` 来获取没有美化过的报错信息。
2. 提取出 stdout 然后解析成结构化的每个文件的错误信息数据。
3. 使用 [inquirer-file-tree-selection-prompt](https://www.npmjs.com/package/inquirer-file-tree-selection-prompt) 来显示一个每个目录包含其错误数的文件树。
## License
[MIT](./LICENSE) License © 2022 [ShenQingchuan](https://github.com/ShenQingchuan)