diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 000000000..7d9fafb39 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,11 @@ +.DS_Store +.git +.gitignore +.idea +build +generated-themes +lib +log/* +node_modules +packages/*/node_modules +tmp diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 000000000..cc8afe6c3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,6 @@ +**/aggregated-translations/*.* +build +coverage +generated-themes +lib +node_modules diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..74b58d9bd --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# This will treat all files as text files and convert to OS's line ending on checkout +# and back to LF on commit automatically. +# It also leaves all files detected as binary untouched. +* text=auto + + +# These files are text and should be normalized (Convert crlf => lf) +.gitignore text +*.gitattributes text +*.js text eol=lf +*.jsx text eol=lf +*.md text diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..9617574e5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Set default code owners for all files in repo +* @mjhenkes @ryanthemanuel @tbiethman @dkasper-was-taken @mraplumb diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..5a6f8c349 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ + + +# Issue Description + + +## Additional Context / Screenshots + diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 000000000..a4a8e763a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,54 @@ +--- +name: "\U0001F41B Bug Report" +about: If something isn't working as expected +title: '' +labels: ":construction: Blocked: Accessibility Input, :construction: Blocked: Engineering + Input, :construction: Blocked: Functional Input, :construction: Blocked: UX Input" +assignees: '' + +--- + +# Bug Report + +## Description + + + +### Graphs affected + +* [ ] Bar graph +* [ ] Bubble graph +* [ ] Gantt chart +* [ ] Line graph +* [ ] Paired result +* [ ] Pie chart +* [ ] Scatter plot +* [ ] Timeline + +## Steps to Reproduce + + +1. +2. +3. +4. + +## Additional Context / Screenshots + + +## Expected Behavior + + +## Possible Solution + + +## Environment + +* Component Name and Version: +* Browser Name and Version: +* Node/npm Version: [e.g. Node 8/npm 5] +* Webpack Version: +* Operating System and version (desktop or mobile): + +## @ Mentions + diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 000000000..c539e9935 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,20 @@ +--- +name: "\U0001F680 Feature Request" +about: Submit a proposal for a new feature +title: '' +labels: ":construction: Blocked: Accessibility Input, :construction: Blocked: Engineering + Input, :construction: Blocked: Functional Input, :construction: Blocked: UX Input" +assignees: '' + +--- + +# Feature Request + +## Description + + +## Additional Context / Screenshots + + +## @ Mentions + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..329a61f5c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ +### Summary + + + + +Closes # + +### Deployment Link + + +https://terra-graphs-deployed-pr-#.herokuapp.com/ + +### Testing + + +### Additional Details + + + + +Thank you for contributing to Terra. +@cerner/terra +@cerner/carbon diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 000000000..617e60a23 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,49 @@ +on: + issues: + types: [milestoned] +jobs: + Move_Milestoned_Issue_On_Project_Board: + runs-on: ubuntu-latest + steps: + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2020 Q2" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2020 Q3" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2020 Q4" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2021 Q1" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2021 Q2" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2021 Q3" + - uses: konradpabjan/move-labeled-or-milestoned-issue@v2.0 + with: + action-token: "${{ secrets.MOVING_ISSUES_TOKEN }}" + project-url: "https://github.com/orgs/cerner/projects/4" + column-name: "Planned" + milestone-name: "2021 Q4" diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..5d8494a49 --- /dev/null +++ b/.gitignore @@ -0,0 +1,63 @@ +# From https://github.com/github/gitignore +# - Node.gitignore +# - Ruby.gitignore +# - Sass.gitignore + +.dat* +.DS_Store +.grunt +.idea +.lock-wscript +.node_repl_history +.npm +.nyc_output +.repl_history +.rvmrc +.sass-cache/ +.vscode/ +*.bridgesupport +*.css.map +*.gem +*.log +*.pid +*.pid.lock +*.rbc +*.seed +**/__snapshots__/diff +**/__snapshots__/latest +**/aggregated-translations/*.* +/_yardoc/ +/.bundle/ +/.config +/.yardoc/ +/coverage/ +/doc/ +/InstalledFiles +/lib/bundler/man/ +/pkg/ +/rdoc/ +/spec/examples.txt +/spec/reports/ +/test/tmp/ +/test/version_tmp/ +/tmp/ +/vendor/bundle +build-iPhoneOS/ +build-iPhoneSimulator/ +build/ +build/Release +coverage +errorScreenshots +generated-themes +jspm_packages +lib +lib-cov +logs +node_modules +npm-debug.log* +package-lock.json +pids +props-table +reports +screenshots +target diff --git a/.npmrc b/.npmrc new file mode 100644 index 000000000..43c97e719 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 000000000..03128968b --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +lts/dubnium diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..1c5736572 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,172 @@ +language: node_js +sudo: required +services: + - docker +branches: + only: + - main +cache: + directories: + - travis-build +before_install: + # Clean install on any new build + - npm run clean +jobs: + include: + - stage: danger lint jest and compile + script: + # clear the cache of any old build artifacts + - rm -rf ./travis-build + - npm run danger + - npm run lint + - npm run jest + # These can't be built in parallel because the cache is a single object and you can't add to it in parallel + - npm run compile:prod -- --env.disableAggregateThemes --output-path $TRAVIS_BUILD_DIR/travis-build/default + - npm run compile:lowlight -- --output-path $TRAVIS_BUILD_DIR/travis-build/lowlight + - npm run compile:fusion -- --output-path $TRAVIS_BUILD_DIR/travis-build/fusion + # Split out all the sizes to not eat up all the travis executors at once. + + - stage: tiny & small + name: tiny default-theme + # Don't clean install + before_install: skip + # Rely on the cache for node_modules.. this won't work for any node modules in the packages dir but works for running wdio + install: skip + script: + # we start up our own standalone chrome instance because the Selenium Docker Service doesn't seem to work here. + - docker-compose up -d standalone-chrome-travis + # using the travis env section to set env variables seems to break cache + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=tiny npm run wdio-default + - name: tiny lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=tiny npm run wdio-lowlight + - name: tiny fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=tiny npm run wdio-fusion + - name: small default-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=small npm run wdio-default + - name: small lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=small npm run wdio-lowlight + - name: small fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=small npm run wdio-fusion + + - stage: medium & large + name: medium default-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=medium npm run wdio-default + - name: medium lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=medium npm run wdio-lowlight + - name: medium fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=medium npm run wdio-fusion + - name: large default-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=large npm run wdio-default + - name: large lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=large npm run wdio-lowlight + - name: large fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=large npm run wdio-fusion + + - stage: huge & enormous + name: huge default-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=huge npm run wdio-default + - name: huge lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=huge npm run wdio-lowlight + - name: huge fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=huge npm run wdio-fusion + - name: enormous default-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/default FORM_FACTOR=enormous npm run wdio-default + - name: enormous lowlight-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/lowlight FORM_FACTOR=enormous npm run wdio-lowlight + - name: enormous fusion-theme + before_install: skip + install: skip + script: + - docker-compose up -d standalone-chrome-travis + - SITE=$TRAVIS_BUILD_DIR/travis-build/fusion FORM_FACTOR=enormous npm run wdio-fusion + + - stage: publish & deploy + script: + - rm -rf ./travis-build + # add auth token to .npmrc for lerna publish + - echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" >> $HOME/.npmrc 2> /dev/null + # Publish to npm write output to file + - npx lerna publish from-package --yes > publish-output.txt + # push tags to github based on output written to file + - node ./scripts/release/gitTagMonoRepo.js + before_deploy: + # Build again for deployment because we need the Public path to be updated. + - TERRA_DEV_SITE_NEW_RELIC_LICENSE_KEY='c494ac44c8' TERRA_DEV_SITE_NEW_RELIC_APPLICATION_ID='144458769' TERRA_DEV_SITE_PUBLIC_PATH='/terra-graphs/' npm run compile:prod + deploy: + provider: pages + skip_cleanup: true + github_token: $GITHUB_TOKEN # Set in travis-ci.com dashboard + local_dir: $TRAVIS_BUILD_DIR/build + on: + branch: main +stages: + - danger lint jest and compile + - tiny & small + - medium & large + - huge & enormous + - name: publish & deploy + if: type != pull_request diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..2ac410e92 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. We also have the right to temporarily or permanently ban any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at DL_TERRA_CORE_TEAM@cerner.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]. + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..ee79965f2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a [github issue][1] or submitting a pull request. + +Before you contribute, please review these guidelines to help ensure a smooth process for everyone. + +Thanks. + +## Issue Reporting + +* Please browse our [existing issues][1] before logging new issues. +* Check that the issue has not already been fixed in the `main` branch. +* Open an issue with a descriptive title and a summary. +* Please be as clear and explicit as you can in your description of the problem. +* Please state the version of Operating System, Browser, and terra-graphs you are using in the description. +* Include any relevant code in the issue summary. +* If an issue already exists, please add a comment to help indicate that multiple people are facing the issue. + +## Pull Requests + +* Read [how to properly contribute to open source projects on Github][2]. +* Fork the project. +* Use a feature branch. +* Write [good commit messages][3]. +* Use the same coding conventions as the rest of the project. +* Commit locally and push to your fork until you are happy with your contribution. +* Make sure to add tests and verify all the tests are passing when merging upstream. +* Please add your name to the [CONTRIBUTORS.md][7] file. Adding your name to the [CONTRIBUTORS.md][7] file signifies agreement to all rights and reservations provided by the [License][4]. +* [Squash related commits together][5]. +* Open a [pull request][6]. +* The pull request will be reviewed by the community and merged by the project committers. + +## Project Governance +* This project is maintained and governed following the [terra governance document](https://github.com/cerner/terra-ui/blob/main/GOVERNANCE.md). + +[1]: https://github.com/cerner/terra-graphs/issues +[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request +[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[4]: ./LICENSE +[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html +[6]: https://help.github.com/articles/using-pull-requests +[7]: ./CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 000000000..da3fef201 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,23 @@ +# Cerner Corporation + +- Abhijit Rao [@abhijit945] +- Dinesh Singh [@Dinesh94Singh] +- Veronica Mazur [@veronimazur] +- Swati Kode [@swatikode] +- Sharath M H [@SharathAlur] +- Pranav Agarwal [@pranav300] +- Prashant Kamboj [@prashant-kamboj] +- Avinash Gupta [@avinashg1994] +- Ben Cai [@benbcai] +- Matt Henkes [@mjhenkes] + +[@abhijit945]: https://github.com/abhijit945 +[@dinesh94singh]: https://github.com/Dinesh94Singh +[@veronimazur]: https://github.com/veronimazur +[@swatikode]: https://github.com/swatikode +[@sharathalur]: https://github.com/SharathAlur +[@pranav300]: https://github.com/pranav300 +[@prashant-kamboj]: https://github.com/Prashant-Kamboj +[@avinashg1994]: https://github.com/avinashg1994 +[@benbcai]: https://github.com/benbcai +[@mjhenkes]: https://github.com/mjhenkes diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..e1af5a457 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,2 @@ +# use terra-node as base image +FROM cerner/terra-node-ci:1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..16389e408 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..45c088e2f --- /dev/null +++ b/NOTICE @@ -0,0 +1,13 @@ +Copyright 2020 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. diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..d13e27b60 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: npm run start-heroku diff --git a/README.md b/README.md index b643f357c..88326ff5f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,109 @@ -# terra-graphs -A lightweight, JavaScript visualization API built using D3. Includes a vanilla javascript and react implementation. + +

+ +

+ + +

+ Terra Graphs +

+ +[![Cerner OSS](https://badgen.net/badge/Cerner/OSS/blue)](http://engineering.cerner.com/2014/01/cerner-and-open-source/) +[![License](https://badgen.net/github/license/cerner/terra-graphs)](https://github.com/cerner/terra-graphs/blob/main/LICENSE) +[![Build Status](https://badgen.net/travis/cerner/terra-graphs)](https://travis-ci.com/cerner/terra-graphs) +[![devDependencies status](https://badgen.net/david/dev/cerner/terra-graphs)](https://david-dm.org/cerner/terra-graphs?type=dev) +[![lerna](https://badgen.net/badge/maintained%20with/lerna/cc00ff)](https://lerna.js.org/) + +- [Supported Browsers](#supported-browsers) +- [Packages](#packages) + - [Versioning](#versioning) + - [Status](#status) + - [Deprecated](#deprecated) +- [Supported Browsers](#supported-browsers) +- [Internationalization (I18n)](#internationalization-i18n) + - [Packages Requiring I18n](#packages-requiring-i18n) +- [Contributing](#contributing) +- [Local Development](#local-development) +- [LICENSE](#license) + +

+ Packages +

+ +

+ Versioning +

+ +When a component reaches v1.0.0., it is considered to be stable and will follow [SemVer](http://semver.org/) for versioning. +1. MAJOR versions represent breaking changes +2. MINOR versions represent added functionality in a backwards-compatible manner +3. PATCH versions represent backwards-compatible bug fixes + +Consult the component CHANGELOGs, related issues, and PRs for more information. + +We view the React.js props API of our components as our main public API. We use this to guide us when versioning components. + +Prior to components reaching v1.0.0, a component is considered to be in a beta stage. +Components in beta stage may include breaking changes, new features, and bug fixes all within v0.x.x releases. + +

+ Status +

+ +![Stable](https://badgen.net/badge/status/Stable/green) +![Beta](https://badgen.net/badge/status/Beta/orange) +![Deprecated](https://badgen.net/badge/status/Deprecated/grey) + + +| Terra Package | Version | Status | Dependencies | +|--------------------|---------|--------|--------------| + + + +

+ Supported Browsers +

+ +| Browser | Version | +|-----------------------------|---------| +| Chrome & Chrome for Android | Current | +| Edge | Current | +| Firefox | Current | +| Internet Explorer | 10 & 11 | +| Safari & Mobile Safari | Current | + +

+ Internationalization (I18n) +

+ +Please review [Terra's Internationalization documentation](https://engineering.cerner.com/terra-ui/#/getting-started/terra-ui/internationalization) for more information. Included are directions on consumption and how internationalization is setup. + + +

+ Contributing +

+ +Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for issue reporting and pull requests. + +

+ Local Development +

+ +1. Install docker https://www.docker.com/ to run browser tests. +2. Install dependencies and run tests. +```sh +npm install +npm run test +``` + +

+ LICENSE +

+ +Copyright 2020 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. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..8c23c734a --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,13 @@ +# How to release + +This project is hosted on NPM. You can find the terra packages [here][project-url]. + +Below is a guide for releasing packages: + +1. Update the versions of the components via `npm run version` +2. Update change logs to have the current date for the release of the affected components. +3. Create a Release PR, Get approvals +4. Merge PR to `main` +5. Watch main to ensure releases get pushed to npm and tagged in github appropriately + +[project-url]: https://www.npmjs.com/org/cerner diff --git a/app.json b/app.json new file mode 100644 index 000000000..938ad7556 --- /dev/null +++ b/app.json @@ -0,0 +1,34 @@ +{ + "name": "terra-graphs", + "description": "Heroku reviews app for terra-graphs development", + "keywords": [ + "productivity" + ], + "website": "https://engineering.cerner.com/terra-graphs/", + "repository": "https://github.com/cerner/terra-graphs", + "success_url": "/", + "scripts": {}, + "env": { + "NODE_ENV": { + "description": "node environment", + "value": "production" + }, + "NPM_CONFIG_PRODUCTION": { + "description": "development environment", + "value": "false" + }, + "NODE_MODULES_CACHE": { + "description": "No cache", + "value": "false" + } + }, + "formation": { + "web": { + "quantity": 1, + "size": "free" + } + }, + "stack": "heroku-16", + "addons": [], + "buildpacks": [] +} diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 000000000..fefc0fabb --- /dev/null +++ b/babel.config.js @@ -0,0 +1,20 @@ +module.exports = (api) => { + api.cache(false); + api.assertVersion('^7.4.4'); + + const presets = [ + '@babel/preset-env', + '@babel/preset-react', + ]; + + const plugins = [ + '@babel/plugin-proposal-object-rest-spread', + '@babel/plugin-transform-object-assign', + '@babel/plugin-transform-runtime', + ]; + + return { + presets, + plugins, + }; +}; diff --git a/dangerfile.js b/dangerfile.js new file mode 100644 index 000000000..6e9f5feef --- /dev/null +++ b/dangerfile.js @@ -0,0 +1,31 @@ +// eslint-disable-next-line import/no-extraneous-dependencies +import { danger, fail } from 'danger'; + +const CHANGELOG_PATTERN = /^packages\/terra-([a-z-])*\/CHANGELOG\.md/i; + +const changedFiles = danger.git.created_files.concat(danger.git.modified_files); + +const changedChangelogs = new Set(); +const changedPackages = new Set(); + +changedFiles.forEach((file) => { + // file isn't in a package so it has no changelog, skip further processing + if (file.substring(0, 9) !== 'packages/') { + return; + } + + const packageName = file.split('packages/')[1].split('/')[0]; + + if (CHANGELOG_PATTERN.test(file)) { + changedChangelogs.add(packageName); + } else { // file is in a package and was changed - we need a changelog + changedPackages.add(packageName); + } +}); + +const missingChangelogs = [...changedPackages].filter(packageName => !changedChangelogs.has(packageName)); + +// Fail if there are package changes without a CHANGELOG update +if (missingChangelogs.length > 0) { + fail(`Please include a CHANGELOG entry for each changed package this PR. Looks like a CHANGELOG is missing for: \n\n - ${missingChangelogs.join('\n - ')}`); +} diff --git a/dev-site-config/site.config.js b/dev-site-config/site.config.js new file mode 100644 index 000000000..7ea8b9560 --- /dev/null +++ b/dev-site-config/site.config.js @@ -0,0 +1,12 @@ +const siteConfig = { + appConfig: { + themes: { + 'Default Theme': '', + 'Clinical Low Light Theme': 'clinical-lowlight-theme', + 'Orion Fusion Theme': 'orion-fusion-theme', + }, + }, + includeTestEvidence: false, +}; + +module.exports = siteConfig; diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 000000000..e2abba2b7 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,32 @@ +version: '3' + +services: + standalone-chrome: + image: 'selenium/standalone-chrome:3.14.0-helium' + ports: + - '4444' + # Necessary due to some issues with chrome in docker. See https://github.com/SeleniumHQ/docker-selenium#running-the-images + volumes: + - '/dev/shm:/dev/shm' + # Necessary to lock down screen sizes for our screen shot comparisons. + environment: + TZ: 'America/Chicago' + + dev: + image: cerner/terra-node-dev:1 + ports: + - 8080:8080 + depends_on: + - standalone-chrome + volumes: + - .:/opt/module + + standalone-chrome-travis: + image: selenium/standalone-chrome:3.14.0-helium + ports: + - 4444:4444 + # Necessary due to some issues with chrome in docker. See https://github.com/SeleniumHQ/docker-selenium#running-the-images + volumes: + - '/dev/shm:/dev/shm' + environment: + TZ: 'America/Chicago' diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 000000000..a5db2edca --- /dev/null +++ b/jest.config.js @@ -0,0 +1,30 @@ +module.exports = { + collectCoverageFrom: [ + 'packages/**/src/*.js', + 'packages/**/src/*.jsx', + ], + globalSetup: './jestGlobalSetup.js', + setupFiles: [ + 'raf/polyfill', + './jestsetup.js', + ], + testMatch: [ + '**/jest/**/*.test.js?(x)', + ], + roots: [process.cwd()], + snapshotSerializers: [ + './node_modules/enzyme-to-json/serializer', + ], + moduleDirectories: [ + 'aggregated-translations', + 'packages', + 'node_modules', + ], + moduleNameMapper: { + '\\.(css|scss|svg)$': 'identity-obj-proxy', + }, + testURL: 'http://localhost', + transform: { + '^.+\\.(js|jsx)$': './jestBabelTransform', + }, +}; diff --git a/jestBabelTransform.js b/jestBabelTransform.js new file mode 100644 index 000000000..4c3c2caf9 --- /dev/null +++ b/jestBabelTransform.js @@ -0,0 +1,13 @@ +/* eslint-disable import/no-extraneous-dependencies */ +const babelJest = require('babel-jest'); + +/** + * Jest uses babel.config.js to compile during the test runs. To correctly resolve babel's config root + * (because terra-clinical is a mono-repo), a custom transformer is needed for jest. + * See: https://babeljs.io/docs/en/config-files#jest + */ +const customTransformer = babelJest.createTransformer({ + rootMode: 'upward-optional', +}); + +module.exports = customTransformer; diff --git a/jestGlobalSetup.js b/jestGlobalSetup.js new file mode 100644 index 000000000..050e7f32d --- /dev/null +++ b/jestGlobalSetup.js @@ -0,0 +1,6 @@ +/* eslint-disable import/no-extraneous-dependencies */ +const aggregateTranslations = require('terra-aggregate-translations'); + +module.exports = () => { + aggregateTranslations(); +}; diff --git a/jestsetup.js b/jestsetup.js new file mode 100644 index 000000000..e2d16e3a5 --- /dev/null +++ b/jestsetup.js @@ -0,0 +1,13 @@ +// Make Enzyme functions available in all test files without importing +/* eslint-disable import/no-extraneous-dependencies */ +import Enzyme, { mount, render, shallow } from 'enzyme'; +import Adapter from 'enzyme-adapter-react-16'; + +Enzyme.configure({ adapter: new Adapter() }); + +global.shallow = shallow; +global.render = render; +global.mount = mount; + +const htmlTag = document.getElementsByTagName('html')[0]; +htmlTag.setAttribute('dir', 'ltr'); diff --git a/lerna.json b/lerna.json new file mode 100644 index 000000000..3a698f8ef --- /dev/null +++ b/lerna.json @@ -0,0 +1,11 @@ +{ + "version": "independent", + "packages": ["packages/*"], + "command": { + "publish": { + "ignoreChanges": [ + "packages/terra-graphs/**" + ] + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 000000000..2c5cb896b --- /dev/null +++ b/package.json @@ -0,0 +1,145 @@ +{ + "name": "terra-graphs", + "private": true, + "version": "0.1.0", + "description": "terra-graphs", + "engines": { + "node": ">=8.9.2 <12" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/cerner/terra-graphs.git" + }, + "keywords": [ + "Cerner", + "Terra", + "Terra Graphs", + "terra-graphs" + ], + "author": "Cerner Corporation", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/cerner/terra-graphs/issues" + }, + "browserslist": [ + "extends @cerner/browserslist-config-terra" + ], + "eslintConfig": { + "extends": "@cerner/terra", + "overrides": [ + { + "files": [ + "**/*/terra-dev-site/**/*.jsx" + ], + "rules": { + "import/no-extraneous-dependencies": "off", + "import/no-unresolved": "off", + "import/extensions": "off" + } + }, + { + "files": [ + "*.doc.jsx" + ], + "rules": { + "import/no-webpack-loader-syntax": "off", + "import/first": "off", + "import/no-duplicates": "off" + } + } + ], + "rules": { + "react/forbid-prop-types": "off" + }, + "parser": "babel-eslint", + "settings": { + "polyfills": [ + "Promise", + "Map" + ] + } + }, + "stylelint": { + "extends": "stylelint-config-terra", + "rules": { + "scss/at-mixin-pattern": "^(terra-)[a-z]+([a-z0-9-]+[a-z0-9]+)?$" + } + }, + "scripts": { + "bootstrap:hoist": "lerna bootstrap --hoist", + "clean": "lerna clean --yes && rm -rf node_modules || true", + "clean:install": "npm run clean && npm install", + "clean:obsolete-snapshots": "npm test -- -u", + "compile": "npm run compile:clean && npm run compile:build", + "compile:build": "lerna ls | sed 's/@cerner\\///g' | cut -d ' ' -f1 | xargs -I {} babel packages/{}/src --out-dir packages/{}/lib --copy-files", + "compile:clean": "rm -rf packages/**/lib", + "compile:src": "lerna run compile", + "compile:prod": "rm -rf ./build; NODE_ENV=production webpack -p", + "compile:lowlight": "rm -rf ./build; THEME=clinical-lowlight-theme webpack -p", + "compile:fusion": "rm -rf ./build; THEME=orion-fusion-theme webpack -p", + "danger": "danger ci", + "dependency-markdown": "node scripts/dependency-markdown-generator/DependencyMarkdownGenerator.js", + "docs": "node scripts/root-readme-updater/index.js", + "docs:peerDependencies": "node scripts/peer-dependency-generator/index.js", + "heroku-prebuild": "npx lerna init", + "heroku-postbuild": "npm install --only=dev && npm run compile:prod", + "jest": "jest", + "jest:coverage": "jest --coverage", + "link-parent-bin": "link-parent-bin", + "lint": "npm run lint:js && npm run lint:scss", + "lint:js": "eslint --ext .js,.jsx .", + "lint:scss": "stylelint 'packages/**/src/**/*.scss' --syntax scss", + "pretest": "npm run lint", + "postinstall": "link-parent-bin && npm run compile && npm run bootstrap:hoist", + "start": "tt-serve", + "start-heroku": "tt-serve-static --port $PORT --site './build' ", + "start-prod": "tt-serve --env.disableHotReloading -p", + "start-static": "npm run compile:prod && tt-serve-static --site ./build", + "test": "npm run lint && npm run jest && npm run wdio", + "wdio-default": "wdio", + "wdio-lowlight": "NODE_OPTIONS=--max-old-space-size=2048 THEME=clinical-lowlight-theme wdio", + "wdio-fusion": "THEME=orion-fusion-theme wdio", + "wdio": "npm run wdio-default && npm run wdio-lowlight && npm run wdio-fusion", + "version": "lerna version --no-git-tag-version && node ./scripts/changelog-updater/index.js" + }, + "devDependencies": { + "@babel/cli": "^7.5.0", + "@babel/core": "^7.5.0", + "@babel/plugin-proposal-object-rest-spread": "^7.5.0", + "@babel/plugin-transform-object-assign": "^7.2.0", + "@babel/plugin-transform-runtime": "^7.5.0", + "@babel/preset-env": "^7.5.0", + "@babel/preset-react": "^7.0.0", + "@cerner/eslint-config-terra": "^4.0.0", + "@cerner/browserslist-config-terra": "^3.0.0", + "babel-eslint": "^10.1.0", + "babel-jest": "^24.8.0", + "check-installed-dependencies": "^1.0.0", + "core-js": "^3.1.3", + "danger": "^9.1.0", + "enzyme": "^3.3.0", + "enzyme-adapter-react-16": "^1.1.1", + "enzyme-to-json": "^3.2.2", + "eslint": "^6.1.0", + "glob": "^7.1.1", + "identity-obj-proxy": "^3.0.0", + "jest": "^24.8.0", + "lerna": "^3.16.4", + "link-parent-bin": "^1.0.0", + "raf": "^3.4.1", + "react": "^16.8.5", + "react-dom": "^16.8.5", + "react-test-renderer": "^16.4.2", + "regenerator-runtime": "^0.13.2", + "stylelint": "^11.0.0", + "stylelint-config-terra": "^3.2.0", + "terra-aggregate-translations": "^1.0.0", + "terra-dev-site": "^6.5.0", + "terra-disclosure-manager": "^4.9.0", + "terra-enzyme-intl": "^3.0.0", + "terra-toolkit": "^6.2.0", + "webpack": "^4.30.0", + "webpack-cli": "^3.3.2", + "webpack-dev-server": "^3.3.1" + } +} diff --git a/packages/terra-graphs/.npmignore b/packages/terra-graphs/.npmignore new file mode 100644 index 000000000..218efb2be --- /dev/null +++ b/packages/terra-graphs/.npmignore @@ -0,0 +1,8 @@ +*.log +target +reports +tests/**/__snapshots__/ +aggregate_translations +dev-site-config +screenshots +errorScreenshots diff --git a/packages/terra-graphs/.npmrc b/packages/terra-graphs/.npmrc new file mode 100644 index 000000000..43c97e719 --- /dev/null +++ b/packages/terra-graphs/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/packages/terra-graphs/CHANGELOG.md b/packages/terra-graphs/CHANGELOG.md new file mode 100644 index 000000000..cc7d1d6a2 --- /dev/null +++ b/packages/terra-graphs/CHANGELOG.md @@ -0,0 +1,5 @@ +# ChangeLog + +## Unreleased + +* Initial stable release diff --git a/packages/terra-graphs/LICENSE b/packages/terra-graphs/LICENSE new file mode 100644 index 000000000..cee84e650 --- /dev/null +++ b/packages/terra-graphs/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright <%= currentYear %> 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. diff --git a/packages/terra-graphs/NOTICE b/packages/terra-graphs/NOTICE new file mode 100644 index 000000000..45c088e2f --- /dev/null +++ b/packages/terra-graphs/NOTICE @@ -0,0 +1,13 @@ +Copyright 2020 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. diff --git a/packages/terra-graphs/README.md b/packages/terra-graphs/README.md new file mode 100644 index 000000000..2662832a0 --- /dev/null +++ b/packages/terra-graphs/README.md @@ -0,0 +1,24 @@ +# Terra Graphs + +[![NPM version](https://badgen.net/npm/v/terra-graphs)](https://www.npmjs.com/package/terra-graphs) +[![Build Status](https://badgen.net/travis/cerner/terra-core)](https://travis-ci.com/cerner/terra-graphs) + +A react graphing library built using d3 based on Cerner design standards. + +- [Getting Started](#getting-started) +- [Documentation](https://github.com/cerner/terra-core/tree/main/packages/terra-graphs/docs) +- [LICENSE](#license) + +## Getting Started + +- Install from [npmjs](https://www.npmjs.com): `npm install terra-graphs` + +## LICENSE + +Copyright 2020 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. diff --git a/packages/terra-graphs/package.json b/packages/terra-graphs/package.json new file mode 100644 index 000000000..ee99c4974 --- /dev/null +++ b/packages/terra-graphs/package.json @@ -0,0 +1,47 @@ +{ + "name": "@cerner/terra-graphs", + "main": "lib/Graphs.js", + "version": "0.0.0", + "description": "A react graphing library built using d3 based on Cerner design standards", + "repository": { + "type": "git", + "url": "git+https://github.com/cerner/terra-graphs.git", + "directory": "packages/terra-graphs" + }, + "keywords": [ + "Cerner", + "Terra", + "terra-graphs", + "carbon", + "graphs", + "UI" + ], + "author": "Cerner Corporation", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/cerner/terra-graphs/issues" + }, + "homepage": "https://github.com/cerner/terra-graphs#readme", + "peerDependencies": { + "react": "^16.8.5", + "react-dom": "^16.8.5" + }, + "dependencies": { + "classnames": "^2.2.5", + "prop-types": "^15.5.8", + "terra-theme-context": "^1.0.0" + }, + "scripts": { + "compile": "babel --root-mode upward src --out-dir lib --copy-files", + "lint": "npm run lint:js && npm run lint:scss", + "lint:js": "eslint --ext .js,.jsx . --ignore-path ../../.eslintignore", + "lint:scss": "stylelint src/**/*.scss", + "precompile": "rm -rf lib", + "test": "npm run lint && npm run jest && npm run wdio", + "jest": "jest --config ../../jest.config.js", + "wdio-default": "cd ../.. && npx wdio", + "wdio-lowlight": "cd ../.. && THEME=clinical-lowlight-theme npx wdio", + "wdio-fusion": "cd ../.. && THEME=orion-fusion-theme npx wdio", + "wdio": "npm run wdio-default && npm run wdio-lowlight && npm run wdio-fusion" + } +} diff --git a/packages/terra-graphs/src/Graphs.jsx b/packages/terra-graphs/src/Graphs.jsx new file mode 100644 index 000000000..101e248d6 --- /dev/null +++ b/packages/terra-graphs/src/Graphs.jsx @@ -0,0 +1,37 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import classNames from 'classnames'; +import classNamesBind from 'classnames/bind'; +import ThemeContext from 'terra-theme-context'; +import styles from './Graphs.module.scss'; + +const cx = classNamesBind.bind(styles); + +const propTypes = { + /** + * Content to be displayed as the name + */ + name: PropTypes.string, +}; + +const defaultProps = { + name: 'default', +}; + +const Graphs = ({ name, ...customProps }) => { + const theme = React.useContext(ThemeContext); + const GraphsClassNames = classNames( + cx([ + 'graphs', + theme.className, + ]), + customProps.className, + ); + + return (
{name}
); +}; + +Graphs.propTypes = propTypes; +Graphs.defaultProps = defaultProps; + +export default Graphs; diff --git a/packages/terra-graphs/src/Graphs.module.scss b/packages/terra-graphs/src/Graphs.module.scss new file mode 100644 index 000000000..565e80da5 --- /dev/null +++ b/packages/terra-graphs/src/Graphs.module.scss @@ -0,0 +1,9 @@ +//Themes +@import './clinical-lowlight-theme/Graphs.module'; +@import './orion-fusion-theme/Graphs.module'; + +:local { + .graphs { + background-color: var(--terra-graphs-graphs-background-color, #0079be); + } +} diff --git a/packages/terra-graphs/src/clinical-lowlight-theme/Graphs.module.scss b/packages/terra-graphs/src/clinical-lowlight-theme/Graphs.module.scss new file mode 100644 index 000000000..525225cd3 --- /dev/null +++ b/packages/terra-graphs/src/clinical-lowlight-theme/Graphs.module.scss @@ -0,0 +1,5 @@ +:local { + .clinical-lowlight-theme { + --terra-graphs-graphs-background-color: #ffa500; + } +} diff --git a/packages/terra-graphs/src/orion-fusion-theme/Graphs.module.scss b/packages/terra-graphs/src/orion-fusion-theme/Graphs.module.scss new file mode 100644 index 000000000..8028c4186 --- /dev/null +++ b/packages/terra-graphs/src/orion-fusion-theme/Graphs.module.scss @@ -0,0 +1,5 @@ +:local { + .orion-fusion-theme { + --terra-graphs-graphs-background-color: #9400d3; + } +} diff --git a/packages/terra-graphs/src/terra-dev-site/doc/Graphs/ChangeLog.2.doc.mdx b/packages/terra-graphs/src/terra-dev-site/doc/Graphs/ChangeLog.2.doc.mdx new file mode 100644 index 000000000..912c26765 --- /dev/null +++ b/packages/terra-graphs/src/terra-dev-site/doc/Graphs/ChangeLog.2.doc.mdx @@ -0,0 +1,6 @@ +import { Badge } from '@cerner/terra-graphs/package.json?dev-site-package'; +import ChangeLog from '@cerner/terra-graphs/CHANGELOG.md'; + + + + \ No newline at end of file diff --git a/packages/terra-graphs/src/terra-dev-site/doc/Graphs/Graphs.1.doc.mdx b/packages/terra-graphs/src/terra-dev-site/doc/Graphs/Graphs.1.doc.mdx new file mode 100644 index 000000000..8fcdf026b --- /dev/null +++ b/packages/terra-graphs/src/terra-dev-site/doc/Graphs/Graphs.1.doc.mdx @@ -0,0 +1,34 @@ +import { Badge } from '@cerner/terra-graphs/package.json?dev-site-package'; + +import DefaultGraphs from '../example/DefaultGraphs?dev-site-example'; + +import PropsTable from '@cerner/terra-graphs/src/Graphs?dev-site-props-table'; + + + +# Terra Graphs + +A react graphing library built using d3 based on Cerner design standards. + +## Getting Started + +- Install with [npmjs](https://www.npmjs.com): + - `npm install terra-graphs` + +## Usage + +```jsx +import React from 'react'; +import Graphs from 'terra-graphs'; +``` + +## Component Features + +* [Cross-Browser Support](https://engineering.cerner.com/terra-ui/contributing/terra-ui/component-standards#cross-browser-support) +* [LTR/RTL Support](https://engineering.cerner.com/terra-ui/contributing/terra-ui/component-standards#ltr--rtl-support) + +## Examples + + +## Props + diff --git a/packages/terra-graphs/src/terra-dev-site/doc/example/DefaultGraphs.jsx b/packages/terra-graphs/src/terra-dev-site/doc/example/DefaultGraphs.jsx new file mode 100644 index 000000000..a3b101531 --- /dev/null +++ b/packages/terra-graphs/src/terra-dev-site/doc/example/DefaultGraphs.jsx @@ -0,0 +1,4 @@ +import React from 'react'; +import Graphs from '@cerner/terra-graphs'; + +export default () => ; diff --git a/packages/terra-graphs/src/terra-dev-site/test/graphs/DefaultGraphs.test.jsx b/packages/terra-graphs/src/terra-dev-site/test/graphs/DefaultGraphs.test.jsx new file mode 100644 index 000000000..709b4df3a --- /dev/null +++ b/packages/terra-graphs/src/terra-dev-site/test/graphs/DefaultGraphs.test.jsx @@ -0,0 +1,5 @@ +import React from 'react'; + +import Graphs from '../../../Graphs'; + +export default () => ; diff --git a/packages/terra-graphs/tests/jest/Graphs.test.jsx b/packages/terra-graphs/tests/jest/Graphs.test.jsx new file mode 100644 index 000000000..3b42e028b --- /dev/null +++ b/packages/terra-graphs/tests/jest/Graphs.test.jsx @@ -0,0 +1,24 @@ +import React from 'react'; +import Graphs from '../../src/Graphs'; + +describe('Graphs', () => { + const defaultRender = ; + + // Snapshot Tests + it('should render a default component', () => { + const wrapper = shallow(defaultRender); + expect(wrapper).toMatchSnapshot(); + }); + + // Prop Tests + it('should use the default value when no value is given', () => { + const wrapper = shallow(defaultRender); + expect(wrapper.find('.graphs').text()).toEqual('default'); + }); + + // Structure Tests + it('should have the class graphs', () => { + const wrapper = shallow(defaultRender); + expect(wrapper.prop('className')).toContain('graphs'); + }); +}); diff --git a/packages/terra-graphs/tests/jest/__snapshots__/Graphs.test.jsx.snap b/packages/terra-graphs/tests/jest/__snapshots__/Graphs.test.jsx.snap new file mode 100644 index 000000000..9fe509e68 --- /dev/null +++ b/packages/terra-graphs/tests/jest/__snapshots__/Graphs.test.jsx.snap @@ -0,0 +1,17 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Graphs should render a default component 1`] = ` +
+ default +
+`; + +exports[`Graphs should render a default component 1`] = ` +
+ default +
+`; diff --git a/packages/terra-graphs/tests/wdio/graphs-spec.js b/packages/terra-graphs/tests/wdio/graphs-spec.js new file mode 100644 index 000000000..62b768b56 --- /dev/null +++ b/packages/terra-graphs/tests/wdio/graphs-spec.js @@ -0,0 +1,9 @@ +// Terra.describeViewports('Graphs', ['tiny', 'medium', 'large'], () => { +// describe('Default', () => { +// before(() => browser.url('/raw/tests/terra-graphs/docs/default-graphs')); + +// it('validates the element', () => { +// Terra.validates.element(); +// }); +// }); +// }); diff --git a/scripts/changelog-updater/index.js b/scripts/changelog-updater/index.js new file mode 100644 index 000000000..e69f6ee56 --- /dev/null +++ b/scripts/changelog-updater/index.js @@ -0,0 +1,74 @@ +#!/usr/bin/env node +/* eslint-disable no-console */ +const fs = require('fs'); +const path = require('path'); +const { exec } = require('child_process'); + +exec('npx lerna changed', (error, stdout) => { + if (error) { + console.error(`exec error: ${error}`); + return; + } + + // Clean up lerna updated output and convert to an array + const updatedPackages = stdout.split('\n').map(x => `packages/${x.replace('@cerner/', '')}`); + updatedPackages.pop(); // Remove last item as it is an empty string + + // Update release version in changelog files + updatedPackages.forEach((packagePath) => { + const packageFile = path.resolve(packagePath, 'package.json'); + const changelogFile = path.resolve(packagePath, 'CHANGELOG.md'); + const releaseDate = new Date().toLocaleString('en-us', { month: 'long', year: 'numeric', day: 'numeric' }); + + if (!fs.existsSync(packageFile) || !fs.existsSync(changelogFile)) { + return; + } + + // Read package.json and pull out version + fs.readFile(packageFile, 'utf8', (err, packageJson) => { + if (err) { + console.error(`Error reading file ${packageFile} ${err}\n`); + } else { + // This is expected to be run after the packages are versioned. + const { version } = JSON.parse(packageJson); + + const regex = /## Unreleased\n*([^#]*)/; + + const changelog = fs.readFileSync(changelogFile, 'utf8'); + + // Grab any content in the unreleased section until the next heading (#). + const unreleasedContent = changelog.match(regex); + + // Default message + let releaseContent = [ + '* Changed', + ' * Minor dependency version bump', + '', + '', + ].join('\n'); + + const [, captureGroup] = unreleasedContent; + + // If there was content, don't use the default content. + if (captureGroup) { + releaseContent = captureGroup; + } + + // setup change log entry + const changelogDoc = [ + '## Unreleased', + '', + `## ${version} - (${releaseDate})`, + '', + releaseContent, + ].join('\n'); + + // Swap in change log entry + const updatedChangelog = changelog.replace(regex, changelogDoc); + + // write out file. + fs.writeFileSync(changelogFile, updatedChangelog, { encoding: 'utf8', flag: 'w' }); + } + }); + }); +}); diff --git a/scripts/common/findAndReplace.js b/scripts/common/findAndReplace.js new file mode 100644 index 000000000..80801185b --- /dev/null +++ b/scripts/common/findAndReplace.js @@ -0,0 +1,24 @@ +/* eslint-disable no-console */ +/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */ +const fs = require('fs'); + +const findAndReplace = (options) => { + /* eslint-disable-next-line consistent-return */ + fs.readFile(options.file, 'utf8', (errMsg, data) => { + if (errMsg) { + return console.log(errMsg); + } + + const result = data.replace(options.regex, options.content); + + fs.writeFile(options.file, result, 'utf8', (error) => { + if (error) { + console.error(`Error writing content to ${options.file} ${error}\n`); + } else { + console.log(`Content written to ${options.file}`); + } + }); + }); +}; + +module.exports = findAndReplace; diff --git a/scripts/common/getPackagePaths.js b/scripts/common/getPackagePaths.js new file mode 100644 index 000000000..b43eea8d1 --- /dev/null +++ b/scripts/common/getPackagePaths.js @@ -0,0 +1,17 @@ +/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */ +const fs = require('fs'); +const glob = require('glob'); +const lernaJson = require('../../lerna.json'); + +const packagePaths = ['./']; + +// Get the base directory paths for each package +lernaJson.packages.forEach((globPath) => { + glob.sync(globPath).forEach((packagePath) => { + if (fs.existsSync(packagePath)) { + packagePaths.push(packagePath); + } + }); +}); + +module.exports = packagePaths; diff --git a/scripts/peer-dependency-generator/generatePeerDependencyDoc.js b/scripts/peer-dependency-generator/generatePeerDependencyDoc.js new file mode 100644 index 000000000..aa9e674ef --- /dev/null +++ b/scripts/peer-dependency-generator/generatePeerDependencyDoc.js @@ -0,0 +1,24 @@ +const generatePeerDependencyDoc = (peerDependencies) => { + const tableHeader = '| Peer Dependency | Version |'; + const tableHeaderBottom = '|-|-|'; + + const dependencyRows = Object.keys(peerDependencies).sort().map((dependency) => { + // Use the peer dependency version specified in the package.json + const specifiedVersion = peerDependencies[dependency]; + + return `| ${dependency} | ${specifiedVersion} |`; + }); + + const dependencyTableMarkdown = `\n${tableHeader}\n${tableHeaderBottom}\n${dependencyRows.join('\n')}\n`; + + const peerDependenciesContent = ` +## Peer Dependencies + +This component requires the following peer dependencies be installed in your app for the component to properly function. +${dependencyTableMarkdown} +`; + + return peerDependenciesContent; +}; + +module.exports = generatePeerDependencyDoc; diff --git a/scripts/peer-dependency-generator/index.js b/scripts/peer-dependency-generator/index.js new file mode 100644 index 000000000..dde614e7e --- /dev/null +++ b/scripts/peer-dependency-generator/index.js @@ -0,0 +1,43 @@ +#!/usr/bin/env node +/* eslint-disable no-console */ +/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */ +const fs = require('fs'); +const path = require('path'); +const packagePaths = require('../common/getPackagePaths'); +const generatePeerDependenciesDoc = require('./generatePeerDependencyDoc'); +const findAndReplace = require('../common/findAndReplace'); + +// Generate the markdown to display peerDependencies information for each package +packagePaths.forEach((packagePath) => { + const packageFile = path.resolve(packagePath, 'package.json'); + const readmeFile = path.resolve(packagePath, 'README.md'); + const docReadmeFile = path.resolve(packagePath, 'docs/README.md'); + + if (!fs.existsSync(packageFile) || !fs.existsSync(readmeFile) || !fs.existsSync(docReadmeFile)) { + return; + } + + // Read package.json and pull out peerDependencies + fs.readFile(packageFile, 'utf8', (err, packageJson) => { + if (err) { + console.error(`Error reading file ${packageFile} ${err}\n`); + } else { + const { peerDependencies } = JSON.parse(packageJson); + + if (peerDependencies) { + const peerDependenciesDoc = generatePeerDependenciesDoc(peerDependencies); + const regex = /(.|\n)*/g; + + // Update peerDependencies in ./README.md + findAndReplace({ + file: readmeFile, regex, content: peerDependenciesDoc, + }); + + // Update peerDependencies in ./docs/README.md + findAndReplace({ + file: docReadmeFile, regex, content: peerDependenciesDoc, + }); + } + } + }); +}); diff --git a/scripts/release/gitTagMonoRepo.js b/scripts/release/gitTagMonoRepo.js new file mode 100644 index 000000000..7cefb3c19 --- /dev/null +++ b/scripts/release/gitTagMonoRepo.js @@ -0,0 +1,50 @@ +#!/usr/bin/env node + +const fs = require('fs'); +const { execSync } = require('child_process'); + +const filePath = './publish-output.txt'; + +// If on travis setup git to be able to push the tags +const setupGit = () => { + const travis = process.env.TRAVIS; + + if (travis) { + execSync('git config --global user.email "travis@travis-ci.org"'); + execSync('git config --global user.name "Travis CI"'); + const remoteUrl = execSync('git config --get remote.origin.url', { encoding: 'utf8' }).trim(); + const token = process.env.GITHUB_TOKEN; + const newUrl = remoteUrl.replace('https://', `https://${token}@`); + execSync(`git remote set-url origin "${newUrl}" > /dev/null 2>&1`); + } +}; + +// Manipulate lerna publish output to find what packages were released and need to be tagged. +const getTags = (output) => { + const successString = 'Successfully published:\n'; + const lastIndexOf = output.lastIndexOf(successString); + if (lastIndexOf < 0) { + return null; + } + const substring = output.substring(lastIndexOf + successString.length); + const withoutDashes = substring.replace(/ - /g, '').trim(); + return withoutDashes.split('\n'); +}; + +// If the publish output exists create a tag for each released component and pus it to main +if (fs.existsSync(filePath)) { + const output = fs.readFileSync(filePath, 'utf8'); + // eslint-disable-next-line no-console + console.log(output); + const tags = getTags(output); + if (tags) { + setupGit(); + // eslint-disable-next-line no-console + console.log('tags', JSON.stringify(tags, null, 2)); + tags.forEach(tag => execSync(`git tag -a ${tag} -m "${tag}"`)); + execSync('git push origin --tags'); + } else { + // eslint-disable-next-line no-console + console.log('Nothing to tag'); + } +} diff --git a/scripts/root-readme-updater/index.js b/scripts/root-readme-updater/index.js new file mode 100644 index 000000000..d4d77ea9f --- /dev/null +++ b/scripts/root-readme-updater/index.js @@ -0,0 +1,29 @@ +#!/usr/bin/env node +/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */ +const path = require('path'); +const packagePaths = require('../common/getPackagePaths'); +const findAndReplace = require('../common/findAndReplace'); + +const rootReadMe = path.join(__dirname, '../../README.md'); + +// Clean up package entries array +const packages = packagePaths + .map(component => component.replace('packages/', '')) + .filter(component => component.startsWith('terra-')); + +// Generate package listing template +const packageListing = packages.map(component => `| [${component}](https://github.com/cerner/terra-graphs/tree/main/packages/${component}) | [![NPM version](https://badgen.net/npm/v/${component})](https://www.npmjs.org/package/${component}) | ![Stable](https://badgen.net/badge/status/Stable/green) | [![${component}](https://badgen.net/david/dep/cerner/terra-graphs/packages/${component})](https://david-dm.org/cerner/terra-graphs?path=packages/${component}) |`); + +const content = [ + '', + '| Terra Package | Version | Status | Dependencies |', + '|--------------------|---------|--------|--------------|', + ...packageListing, + '', +]; +const regex = /(.|\n)*/g; + +// Update package listing in ./README.md +findAndReplace({ + file: rootReadMe, regex, content: content.join('\n'), +}); diff --git a/terra-theme.config.js b/terra-theme.config.js new file mode 100644 index 000000000..f56bd9f01 --- /dev/null +++ b/terra-theme.config.js @@ -0,0 +1,5 @@ +const themeConfig = { + scoped: ['clinical-lowlight-theme', 'orion-fusion-theme'], +}; + +module.exports = themeConfig; diff --git a/terra.png b/terra.png new file mode 100644 index 000000000..27b9912ca Binary files /dev/null and b/terra.png differ diff --git a/wdio.conf.js b/wdio.conf.js new file mode 100644 index 000000000..4ae601150 --- /dev/null +++ b/wdio.conf.js @@ -0,0 +1,17 @@ +const path = require('path'); +// eslint-disable-next-line import/no-extraneous-dependencies +const defaultWdioConfig = require('terra-toolkit/config/wdio/wdio.conf'); + +const wdioConfig = defaultWdioConfig.config; + +if (process.env.npm_package_name !== 'terra-graphs') { + wdioConfig.specs = [path.join(__dirname, 'packages', process.env.npm_package_name, 'tests', 'wdio', '**', '*-spec.js')]; +} + +const travis = process.env.TRAVIS; + +if (travis) { + wdioConfig.host = 'localhost'; +} + +exports.config = wdioConfig; diff --git a/webpack.config.js b/webpack.config.js new file mode 100644 index 000000000..91cadf694 --- /dev/null +++ b/webpack.config.js @@ -0,0 +1,3 @@ +const terraDevSiteWebpackConfig = require('terra-dev-site/config/webpack/webpack.config'); + +module.exports = terraDevSiteWebpackConfig;