Skip to content

chore(repo): update cspell to ignore all node_modules#4886

Merged
rwaskiewicz merged 1 commit intomainfrom
rwaskiewicz/spellcheck-jest-subdir
Oct 4, 2023
Merged

chore(repo): update cspell to ignore all node_modules#4886
rwaskiewicz merged 1 commit intomainfrom
rwaskiewicz/spellcheck-jest-subdir

Conversation

@rwaskiewicz
Copy link
Member

@rwaskiewicz rwaskiewicz commented Oct 3, 2023

What is the current behavior?

See 'new behavior' section
GitHub Issue Number: N/A

What is the new behavior?

update the cspell configuration to ignore all node_modules directories. when we introduced new jest-version subdirectories in #4847, we failed to update cspell's configuration. as a result, cspell would run against the node_modules directory in
src/testing/jest/jest-27-and-under (e.g. npm run spellcheck). this change excludes all node_modules cspell's eyes

Does this introduce a breaking change?

  • Yes
  • No

Testing

Prior to this commit, if you run npm run spellcheck, you get something like:

 npm run spellcheck

...
./src/testing/jest/jest-27-and-under/node_modules/xmlchars/xmlchars.d.ts:9:31 - Unknown word (Dubeau)
./src/testing/jest/jest-27-and-under/node_modules/xmlchars/xmlns/1.0/ed3.d.ts:4:28 - Unknown word (Dubeau)
./src/testing/jest/jest-27-and-under/node_modules/xmlchars/xmlns/1.0/ed3.d.ts:6:31 - Unknown word (Dubeau)
CSpell: Files checked: 1445, Issues found: 835 in 139 files

After this commit, npm run spellcheck gives you:

 npm run spellcheck

> @stencil/core@4.4.0 spellcheck
> cspell --no-progress "src/**/*.ts" "src/**/*.tsx" "scripts/**/*.ts" "*.md"

CSpell: Files checked: 774, Issues found: 0 in 0 files

I did also introduce an error locally to verify I hadn't broken this entirely:

npm run spellcheck

> @stencil/core@4.4.0 spellcheck
> cspell --no-progress "src/**/*.ts" "src/**/*.tsx" "scripts/**/*.ts" "*.md"

./src/cli/task-test.ts:37:13 - Unknown word (abcwe've)
CSpell: Files checked: 774, Issues found: 1 in 1 files

I also checked out the commit prior to #4847 (the PR that introduced these node_modules/) to verify that we were checking the right number of files:

git checkout cb3eac3a2b7795a5c8d3f9100812337d1a8d8a9d
rm -rf src/testing/jest/jest-27-and-under/node_modules
npm run spellcheck

> @stencil/core@4.3.0 spellcheck
> cspell --no-progress "src/**/*.ts" "src/**/*.tsx" "scripts/**/*.ts" "*.md"

CSpell: Files checked: 774, Issues found: 0 in 0 files

Other information

update the cspell configuration to ignore all node_modules directories.
when we introduced new `jest`-version subdirectories in #4847,
we failed to update cspell's configuration. as a result, cspell would
run against the `node_modules` directory in
`src/testing/jest/jest-27-and-under` (e.g. `npm run spellcheck`). this
change excludes _all_ `node_modules` cspell's eyes
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1439 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/mock-doc/serialize-node.ts 36
src/dev-server/server-process.ts 32
src/compiler/build/build-stats.ts 27
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts 25
src/compiler/style/test/optimize-css.spec.ts 23
src/testing/puppeteer/puppeteer-element.ts 23
src/compiler/prerender/prerender-main.ts 22
src/runtime/vdom/vdom-render.ts 20
src/runtime/client-hydrate.ts 19
src/screenshot/connector-base.ts 19
src/compiler/config/test/validate-paths.spec.ts 16
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/compiler/transpile/transpile-module.ts 14
src/runtime/vdom/vdom-annotations.ts 14
src/sys/node/node-sys.ts 14
src/compiler/build/build-finish.ts 13
src/compiler/prerender/prerender-queue.ts 13
Our most common errors
Typescript Error Code Count
TS2345 437
TS2322 409
TS18048 321
TS18047 100
TS2722 38
TS2532 36
TS2531 24
TS2454 15
TS2352 13
TS2769 10
TS2790 10
TS2538 8
TS2344 5
TS2416 4
TS2493 3
TS18046 2
TS2684 1
TS2488 1
TS2464 1
TS2430 1

Unused exports report

There are 12 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 21 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 140 CUSTOM
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 114 Env
src/compiler/app-core/app-data.ts 116 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 110 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 62 satisfies
src/compiler/types/validate-primary-package-output-target.ts 62 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

@rwaskiewicz rwaskiewicz marked this pull request as ready for review October 3, 2023 13:11
@rwaskiewicz rwaskiewicz requested a review from a team as a code owner October 3, 2023 13:11
@rwaskiewicz rwaskiewicz added this pull request to the merge queue Oct 4, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 4, 2023
@rwaskiewicz rwaskiewicz added this pull request to the merge queue Oct 4, 2023
Merged via the queue into main with commit 7adcfa5 Oct 4, 2023
@rwaskiewicz rwaskiewicz deleted the rwaskiewicz/spellcheck-jest-subdir branch October 4, 2023 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants