-
Notifications
You must be signed in to change notification settings - Fork 72
Minor script updates and quality of life improvements #1853
Conversation
Package.lock would need to be re-generated and committed back to repo every time the component that is dependent on is updated. I think this will be a additional step for existing projects and might require additional efforts to maintenance. |
What maintenance concerns do you have? This will automatically be added/updated whenever we do In return, we'll get:
|
We had scenario where we had made fix on terra-arrange as part of impact testing we performed testing of terra-menu and other components of terra-framework by having tar.gz file of terra-menu. since we had changed the version to refer to tar.gz file version package.lock file was re-generated on local and the fix was working as expected but this fix was not available on terra-ui even after a week of terra-arrange release. Cause for fix not being available on terra-ui is package.lock file of terra-framework which was still referring to an older version of terra-arrange. So we were required open-up a PR update package.lock manually to pull in the latest version. ( so this is one of maintenance concern as it is new additional step which will be required on each of those components which has dependent components on different repo ) . Does this scripts auto updates the package.lock on timely interval to ensure latest versions are being pulled into project. |
Are you sure that the package-lock was the cause? Because that does not sound correct. The package-lock is for the terra-framework repo and Terra UI has no visibility to that. Nor should Terra UI be affected by the terra-framework repo changes as they are two independent repos. I can delete the terra-framework repo and this will have no impact on Terra UI. What Terra UI does is pull in the terra-framework-docs package and we have disabled package-lock for each individual package. Even if it wasn't, package-lock won't be be published to the npm registery (https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json). It feels like there was a different cause because Terra UI only has visibility to the terra-framework-docs package and should not be affected by the repo at all. |
I mean terra-framework site : https://engineering.cerner.com/terra-framework/components/terra-abstract-modal/abstract-modal/abstract-modal And also I would like to know time difference in build time before and after inclusion of package.lock file in repo. |
Summary
This PR makes the following changes:
- Renames the wdio scripts for consistency
The sub-scripts can now be called as
wdio:default
instead ofwdio-default
. To prevent bloat in this PR, the wdio scripts at the package level will be updated in a follow up PR.- Adds a
no-coverage
jest scriptTo help speed up testing and prevent boated output when focusing on specific tests. This was also added to the CICD to optimize the build process as the coverage report is meant to be human-readable and has no impact on the output.
- Generates the package-lock.json file
To help optimize the npm install process both locally and in the CICD.
- Updates the Dockerfile to npm 9
It was using the default npm v6.
- Adds a new
no-warnings
sub-script for scssThis script was added to suppress warnings as it was inflating output and making it difficult to spot errors.
Before:
After:
Testing
This change was tested using:
This was tested by successfully running the scripts.
Jest output
Stylelint output
Reviews
In addition to engineering reviews, this PR needs:
The Dockerfile changes will need to be tested by running a devcontainer and testing the npm version.
Additional Details
Thank you for contributing to Terra.
@cerner/terra