Installations
npm install @cerner/duplicate-package-checker-webpack-plugin
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
10 || 12 || 14
Typescript Support
No
Node Version
14.21.3
NPM Version
lerna/6.6.2/node@v14.21.3+x64 (linux)
Statistics
32 Stars
859 Commits
37 Forks
30 Watching
76 Branches
67 Contributors
Updated on 22 May 2024
Bundle Size
58.32 kB
Minified
19.82 kB
Minified + Gzipped
Languages
JavaScript (91.84%)
MDX (8.09%)
SCSS (0.05%)
Dockerfile (0.01%)
CSS (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
3,870,586
Last day
23.3%
3,683
Compared to previous day
Last week
-6.9%
19,712
Compared to previous week
Last month
2.3%
97,347
Compared to previous month
Last year
24.8%
1,599,763
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
4
Peer Dependencies
1
Terra Toolkit
Terra Toolkit is a Lerna repository for common development packages necessary for developing Terra projects.
- Notice
- Package Status
- Versioning
- Contributing
- Local Development
- Local Development using Docker (Dev Containers)
- LICENSE
Notice
The code for the terra-toolkit npm dependency has been moved to terra-toolkit-boneyard.
Package Status
Package | Version | Status | Dependencies |
---|---|---|---|
@cerner/browserslist-config-terra | |||
@cerner/eslint-config-terra | |||
@cerner/terra-functional-testing |
Versioning
Terra-toolkit packages are considered to be stable and will follow SemVer for versioning.
- MAJOR versions represent breaking changes
- MINOR versions represent added functionality in a backwards-compatible manner
- PATCH versions represent backwards-compatible bug fixes
Consult the component CHANGELOGs, related issues, and PRs for more information.
Contributing
Please read through our contributing guidelines. Included are directions for issue reporting and pull requests.
Local Development
- Install docker https://www.docker.com/ to run browser tests.
- Install dependencies and run tests.
1npm install 2npm run test
Local Development using Docker (Dev Containers)
- Install Rancher or Docker.
- Rancher is free and open-source and is highly recommended whereas Docker may require a license for use.
- Install Microsoft VS Code.
- Install the Dev Container extension.
- Navigate to View -> Extension -> Search for and install Dev Containers (or "ms-vscode-remote.remote-containers")
- More information on Dev Containers
- Build the dev container:
- (Option 1) - Opening local workspace in dev container
- Clone the repository (or fork) locally and open the project in Visual Studio Code
- Navigate to View -> Command Palette and run Dev Containers: Open Workspace in Container
- (Option 2) - Recommended for Windows for hot-reloading to work during development and improved performance: Creating the dev container using dev volumes (for more information and guidance, see the Official Guide)
- If you have git setup and have global config file ~/.gitconfig locally, these settings should automatically be transferred to the dev container
- Navigate to View -> Command Palette and run Dev Containers: Clone Repository in Container Volume
- Paste the GitHub URL of this repository (or fork)
- VS Code will now reload the workspace and create/start the dev container and volume
- Please note: changes made using this option will only update files in the Docker volume. It is recommended to commit changes often in case the volume is deleted or dev container gets removed.
- (Option 1) - Opening local workspace in dev container
- You're now running in a dev container. Use the terminal of the dev container in Visual Studio Code to issue any npm or bash commands.
- Before running any WDIO tests, make sure to perform the following steps:
- Open a new terminal (outside the dev container) and navigate to ".devcontainer/" path in your repository.
- Execute the command
"docker compose -f docker-compose-wdio.yml up"
. Selenium hub should spin up. Leave this running in the background. If you see errors saying "container name already exists", run"docker container prune"
command followed by pressing "y" to clear up any unused containers and try running the previous command again. - You can now run
npm run test:docker
ornpm run wdio:docker
commands to run WDIO tests from inside the Dev Container. - NOTE: Optionally, if you want to run other WDIO commands in the dev container, you can also edit the root package.json file WDIO scripts to include
--disableSeleniumService=true
flag. This will disable the selenium service from spinning up again. For example:1"scripts": { 2 "wdio-fusion": "terra wdio --disable-selenium-service=true --themes orion-fusion-theme", 3 }
- To terminate a dev container:
- Use command line or Rancher/Docker Desktop OR
- Using Visual Studio Code
- Select the Remote Explorer icon in the Activity Bar or View -> Command Palette and run Remote Explorer: Focus on Containers View
- Locate the terra-toolkit_devcontainer or currently running dev container under "Dev Containers"
- Right click and select Stop Container and close the workspace
- You can also select Rebuild Container to restart the dev container
- To reopen a dev container:
- Existing local workspace (for Option 1)
- Open the project in Visual Studio Code
- Ensure the workspace contains the .devcontainer folder
- Navigate to View -> Command Palette and run Dev Containers: Open Workspace in Container
- Isolated dev container volume (for Option 2)
- Open Visual Studio Code
- Use the Remote Explorer icon in the Activity Bar or View -> Command Palette and run Remote Explorer: Focus on Containers View to view containers
- Locate the terra-toolkit_devcontainer under "Dev Containers"
- Hover over the dev container and click the Folder icon labelled Open Folder in Container or by right clicking and selecting Open Folder in Container
- Existing local workspace (for Option 1)
LICENSE
Copyright 2017 - present Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
Found 27/30 approved changesets -- score normalized to 9
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci-cd.yml:1
- Warn: no topLevel permission defined: .github/workflows/pr-close.yml:1
- Warn: no topLevel permission defined: .github/workflows/pr-preview.yml:1
- Info: no jobLevel write permissions found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/ci-cd.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-close.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-close.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-close.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-close.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-close.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-close.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-preview.yml:117: update your workflow using https://app.stepsecurity.io/secureworkflow/cerner/terra-toolkit/pr-preview.yml/main?enable=pin
- Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:1
- Warn: containerImage not pinned by hash: Dockerfile:2
- Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 13 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 27 are checked with a SAST tool
Reason
29 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-pwfr-8pq7-x9qv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-x565-32qp-m3vf
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.7
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More