Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(repo): add package.json jest install script #5074

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

rwaskiewicz
Copy link
Contributor

@rwaskiewicz rwaskiewicz commented Nov 15, 2023

What is the current behavior?

Knowing where the shell script for jest scripts shouldn't necessarily be on one's mind when trying to develop for Stencil + Jest

GitHub Issue Number: N/A

What is the new behavior?

add an install.jest script to package.json to make it easier to install jest dependencies within the project. the motivator for this change is the following suggestion in a pull request that was a child PR of the one that implemented this functionality - #5068 (review)

Does this introduce a breaking change?

  • Yes
  • No

Testing

Manual testing

I was able to run npm run install.jest locally

CI

I tailed the logs and found the command still runs:

  npm ci \
  && npm run install.jest
  shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}

added 947 packages, and audited 948 packages in 11s

131 packages are looking for funding
  run `npm fund` for details

1 moderate severity vulnerability

To address all issues, run:
  npm audit fix

Run `npm audit` for details.

> @stencil/core@4.7.2 install.jest
> bash ./src/testing/jest/install-dependencies.sh

Installing dependencies in jest-27-and-under
npm WARN deprecated w3c-hr-time@1.0.2: Use your platform's native performance.now() and performance.timeOrigin.

added 342 packages, and audited 343 packages in 2s

30 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

/home/runner/work/stencil/stencil/src/testing/jest
Installing dependencies in jest-28

added 289 packages, and audited 290 packages in 2s

32 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

/home/runner/work/stencil/stencil/src/testing/jest
Installing dependencies in jest-29

added 291 packages, and audited 292 packages in 2s

32 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

/home/runner/work/stencil/stencil/src/testing/jest

Other information

Copy link
Contributor

github-actions bot commented Nov 15, 2023

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1367 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 23
src/compiler/style/test/optimize-css.spec.ts 23
src/testing/puppeteer/puppeteer-element.ts 23
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts 22
src/compiler/prerender/prerender-main.ts 22
src/runtime/client-hydrate.ts 19
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 18
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 403
TS2322 384
TS18048 310
TS18047 100
TS2722 38
TS2532 34
TS2531 23
TS2454 14
TS2352 13
TS2769 10
TS2790 10
TS2538 8
TS2416 6
TS2344 5
TS2493 3
TS2488 2
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 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 145 CUSTOM
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

@rwaskiewicz rwaskiewicz force-pushed the rwaskiewicz/install-jest-cmd branch from 7158716 to 2c3966f Compare November 15, 2023 16:11
@rwaskiewicz rwaskiewicz marked this pull request as ready for review November 15, 2023 16:26
@rwaskiewicz rwaskiewicz requested a review from a team as a code owner November 15, 2023 16:27
@rwaskiewicz rwaskiewicz added this pull request to the merge queue Nov 15, 2023
@rwaskiewicz rwaskiewicz removed this pull request from the merge queue due to a manual request Nov 15, 2023
add an `install.jest` script to `package.json` to make it easier to
install jest dependencies within the project. the motivator for this
change is the following suggestion in a pull request that was a child PR
of the one that implemented this functionality -
#5068 (review)
@rwaskiewicz rwaskiewicz force-pushed the rwaskiewicz/install-jest-cmd branch from 51762c2 to dd35f4d Compare November 15, 2023 20:46
@rwaskiewicz rwaskiewicz added this pull request to the merge queue Nov 15, 2023
Merged via the queue into main with commit 54875ff Nov 15, 2023
@rwaskiewicz rwaskiewicz deleted the rwaskiewicz/install-jest-cmd branch November 15, 2023 21:02
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