chore: Move lint:ts check from pre-commit to GitHub workflow #195
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirtimid
changed the title
sirtimid
force-pushed
the
sirtimid/move-ts-lint-on-ci
branch
from
b0789e7 to
ccc4150
Compare
rekmarks
reviewed
Oct 24, 2024
rekmarks
approved these changes
Oct 24, 2024
rekmarks
added a commit
that referenced
this pull request
Oct 24, 2024
It appears that a better world is possible: we can both use `Node16` module resolution for builds _and_ test, lint, and develop directly from our source files. @sirtimid previously fixed #174 and #181 over several PRs: #192 #193 #194 #195 In #194, we concluded that there was no way to run type checks without building our source files. As it turns out, this is in fact possible by disabling [the `composite` config option](https://www.typescriptlang.org/tsconfig/#composite)[^1]. Having done this, we now run `lint:ts` as part of our regular lint scripts, which reliably works without building. In addition, this also fixes type errors in our `vitest.config.ts` files. So that we have this documented, let's review our config to understand why our new config works. In our root `tsconfig.json` and `tsconfig.package.json` (which package-level `tsconfig.json` files extend), we set the following: ```json { "module": "Preserve", "moduleResolution": "Node10", } ``` Using [`Node10` for `moduleResolution`](https://www.typescriptlang.org/tsconfig/#moduleResolution) causes TypeScript to ignore the `exports` field of `package.json`, which enables our [`paths` config](https://www.typescriptlang.org/tsconfig/#paths) in `tsconfig.packages.json` to correctly resolve our source files. Using [`Preserve` for `module`](https://www.typescriptlang.org/tsconfig/#preserve) simply appears to be compatible with our config. Other options, like `ES2015`, worked as well, but from the description of the setting it _sounds like_ what we want. Meanwhile, our `tsconfig.test.json` files have been renamed to `tsconfig.lint.json`, and they now look like this: ```json { "extends": "./tsconfig.json", "compilerOptions": { "composite": false, "noEmit": true, "skipLibCheck": true }, "include": ["./src"], "exclude": [] } ``` Due to [the semantics of `extends`](https://www.typescriptlang.org/tsconfig/#extends), `references` is omitted, and `include` and `exclude` _overwrite_ their inherited values. `skipLibCheck` ensures that we ignore errors in dependencies, and `noEmit` of course ensures that we don't actually produce any output files. We still use `Node16` as our `module` and `moduleResolution` options for actual builds, as is [recommended by `ts-bridge`](https://ts-bridge.dev/reference/configuration/#node16-module-resolution). There may come a time when this discrepancy causes trouble for us, but for now, it appears that we are in a happy place. [^1]: Boundless gratitude to microsoft/TypeScript#27069 (comment) for this insight
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since
yarn lint:tsdepends on the build process, running it during pre-commit would force developers to build before committing, which is not ideal for efficiency. This PR removes thelint:tscheck from thepre-commithook and adds it to the GitHub workflow, where it will be executed as part of the build step. It was moved on build step because caching the build folder for workflows took 2min on the ci so it was faster to move it after build.