chore: fully type check packages/*/src files #117

JoshuaKGoldberg · 2024-09-03T21:39:24Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request?

Creates a root-level tsconfig.json that can type check all project files, along with a ci.yml step to do so in CI.

What changes did you make? (Give an overview)

This PR includes two common TypeScript practices for monorepos:

A tsconfig.base.json: to unify & share the common TSConfig settings used by all projects
A root-level tsconfig.json: so editors have that includes all files

That root-level tsconfig.json is necessary for typed linting with the recommended typescript-eslint project service, as noted by @snitin315 and myself as a followup in #90 -> #90 (comment).

Also fixes a few type errors here and there. I'm posting comments in the PR.

Notably, this PR does not set up project references. Doing so requires touching files on disk, which I'm not confident enough in this repo to do on my own unprompted. Instead, the root-level tsconfig.json has noEmit: true so it's purely used for type checking.

Related Issues

Followup to #90, which is a PR. Would the team like me to file more granular issues? I wasn't sure how much the team wants some or all of this change. My intent is to continue enabling strict TypeScript flags after this, unless directed otherwise.

Is there anything you'd like reviewers to focus on?

I'm applying the practices I see as common + good in TypeScript-land, but am not totally sure I interpreted the existing repo setup right. Very much seeking to understand. 🙂

JoshuaKGoldberg · 2024-09-03T21:40:33Z

.github/workflows/ci.yml

@@ -27,6 +27,9 @@ jobs:
 - name: Lint Files
 run: npm run lint

+ - name: Type Check Files
+ run: npm run tsc


[Question] Does the team want to type check in CI separate from the build step? As in, was it intended that npm run build should be what type-checks?

npm run build is intended to do everything in preparation for a package being published (Including tsc, running additional scripts, running Rollup, etc.).

If we want to highlight type checking errors, then I think it's fine to have as a separate CI check.

Great. I've found it to be useful to have explicit checks for each of (lint, build, test, etc.) split out. What happens over time in larger repos is that type-checking time grows to be much much longer than build times, so folks reasonably want to be able to see results from tsc on its own separately from / in parallel to build. Both in CI and locally.

JoshuaKGoldberg · 2024-09-03T21:41:07Z

CONTRIBUTING.md

[Question] I ended up writing this because I wanted to add a mention of how to type-check, and didn't know where to put it... is this the right place for rewrite contributing docs?

I think it's fine for now. I'm always torn between CONTRIBUTING.md and README.md. I think it's more important that the information exists somewhere rather than worrying about exactly where at this point.

JoshuaKGoldberg · 2024-09-03T21:41:59Z

package.json

@@ -27,6 +28,7 @@
 "!(*.{js,ts})": "prettier --write --ignore-unknown"
 },
 "devDependencies": {
+ "@types/mocha": "^10.0.7",


[Explanation] This isn't strictly necessary with "noImplicitAny": false. But it's just good to have types for dependencies in general.

JoshuaKGoldberg · 2024-09-03T21:46:52Z

packages/plugin-kit/src/config-comment-parser.js

@@ -9,7 +9,6 @@
 // Imports
 //------------------------------------------------------------------------------

-// @ts-ignore -- don't feel like fighting with TypeScript right now


[Question] I don't get any type errors in my editor or from npm run build on main after removing this comment directive. Is there another command I'm missing?

Leftover comment from before I figured out how to get it to work. 😄

JoshuaKGoldberg · 2024-09-03T21:49:28Z

scripts/build.js

- * Creates an array of directories to be built in order to sastify dependencies.
- * @param {Map<string,{name:string,dir:string,dependencies:Set<string>}} dependencies The
+ * Creates an array of directories to be built in order to satisfy dependencies.
+ * @param {Map<string,{name:string,dir:string,dependencies:Set<string>}>} dependencies The


[Fix] Typo: missing > closing out Map.

JoshuaKGoldberg · 2024-09-03T21:50:33Z

tsconfig.base.json

+ // TODO: Over time, enable these strict options
+ "noImplicitAny": false,
+ "strictNullChecks": false,
+ "useUnknownInCatchVariables": false


[Explanation] strict is generally a best practice, and has flags added to it over time. For anything that can't be added yet, the common practice is to disable them specifically with a TODO comment. Kind of like enabling a recommended preset in an ESLint config, with rules overrides.

I know there was mention of not wanting some or all of these - is here a good place to discuss?

I think strict vs. not should be opened up as a separate discussion.

JoshuaKGoldberg · 2024-09-03T21:51:06Z

types/levn.d.ts

[Question] I ended up adding as much as I could here. I plan on sending to DefinitelyTyped soon. Did I get the types right? (I've never used levn)

If you're planning on contributing to DefinitelyTyped, I'd rather wait for that than create a new top-level directory.

Also, I'm not familiar enough with levn to really know if the types make sense. I just hacked something together that made tsc happy and seemed to make sense based on the docs.

👍 DefinitelyTyped/DefinitelyTyped#70460

nzakas · 2024-09-04T15:10:19Z

.github/workflows/ci.yml

@@ -27,6 +27,9 @@ jobs:
 - name: Lint Files
 run: npm run lint

+ - name: Type Check Files
+ run: npm run tsc


npm run build is intended to do everything in preparation for a package being published (Including tsc, running additional scripts, running Rollup, etc.).

If we want to highlight type checking errors, then I think it's fine to have as a separate CI check.

CONTRIBUTING.md

nzakas · 2024-09-04T15:11:32Z

CONTRIBUTING.md

+### Linting
+
+ESLint is linted using ESLint.
+[Building](#building) the project must be done before it can lint itself.


Did you find this to be true? Linting generally happens on source files, so not sure why building would be required first.

Yes, it has a dependency on its own files right now:

$ npm run lint > eslint-rewrite@1.0.0 lint > eslint . Oops! Something went wrong! :( ESLint: 9.9.1 Error: Cannot find module '/Users/josh/repos/rewrite/node_modules/@eslint/config-array/dist/cjs/index.cjs' at createEsmNotFoundErr (node:internal/modules/cjs/loader:1256:15) at finalizeEsmResolution (node:internal/modules/cjs/loader:1244:15) at resolveExports (node:internal/modules/cjs/loader:628:14) at Module._findPath (node:internal/modules/cjs/loader:718:31) at Module._resolveFilename (node:internal/modules/cjs/loader:1205:27) at Module._load (node:internal/modules/cjs/loader:1045:27) at TracingChannel.traceSync (node:diagnostics_channel:315:14) at wrapModuleLoad (node:internal/modules/cjs/loader:215:24) at Module.require (node:internal/modules/cjs/loader:1304:12) at require (node:internal/modules/helpers:123:16)

Running a build fixes that:

$ npm run build # ... build output $ npm run lint > eslint-rewrite@1.0.0 lint > eslint . $ |

nzakas · 2024-09-04T15:12:20Z

packages/plugin-kit/src/config-comment-parser.js

@@ -9,7 +9,6 @@
 // Imports
 //------------------------------------------------------------------------------

-// @ts-ignore -- don't feel like fighting with TypeScript right now


Leftover comment from before I figured out how to get it to work. 😄

nzakas · 2024-09-04T15:13:46Z

types/levn.d.ts

If you're planning on contributing to DefinitelyTyped, I'd rather wait for that than create a new top-level directory.

Also, I'm not familiar enough with levn to really know if the types make sense. I just hacked something together that made tsc happy and seemed to make sense based on the docs.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

chore: fully type check packages/*/src files

ae9c13c

eslint-github-bot bot added the chore label Sep 3, 2024

JoshuaKGoldberg commented Sep 3, 2024

View reviewed changes

JoshuaKGoldberg added 2 commits September 3, 2024 17:48

chore: remove unnecessary type assertion

cb49807

chore: remove unnecessary unknown/object type changes

b0cbf31

JoshuaKGoldberg commented Sep 3, 2024

View reviewed changes

JoshuaKGoldberg marked this pull request as ready for review September 3, 2024 22:30

nzakas reviewed Sep 4, 2024

View reviewed changes

Update CONTRIBUTING.md

ebeb4c8

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

JoshuaKGoldberg mentioned this pull request Sep 5, 2024

Repo: Enable TypeScript's "strict" mode #118

Open

Remove strict mode

3e4c6e5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: fully type check packages/*/src files #117

chore: fully type check packages/*/src files #117

JoshuaKGoldberg commented Sep 3, 2024 •

edited

Loading

JoshuaKGoldberg Sep 3, 2024

nzakas Sep 4, 2024

JoshuaKGoldberg Sep 5, 2024

JoshuaKGoldberg Sep 3, 2024

nzakas Sep 5, 2024

JoshuaKGoldberg Sep 3, 2024

JoshuaKGoldberg Sep 3, 2024

nzakas Sep 4, 2024

JoshuaKGoldberg Sep 3, 2024

JoshuaKGoldberg Sep 3, 2024

nzakas Sep 4, 2024

JoshuaKGoldberg Sep 5, 2024

JoshuaKGoldberg Sep 3, 2024

nzakas Sep 4, 2024

JoshuaKGoldberg Sep 5, 2024

nzakas Sep 4, 2024

nzakas Sep 4, 2024

JoshuaKGoldberg Sep 5, 2024

nzakas Sep 4, 2024

nzakas Sep 4, 2024

chore: fully type check packages/*/src files #117

Are you sure you want to change the base?

chore: fully type check packages/*/src files #117

Conversation

JoshuaKGoldberg commented Sep 3, 2024 • edited Loading

Prerequisites checklist

What is the purpose of this pull request?

What changes did you make? (Give an overview)

Related Issues

Is there anything you'd like reviewers to focus on?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoshuaKGoldberg commented Sep 3, 2024 •

edited

Loading