From 60f48fbdc02cb820c8e0a36d140bcfe0453f7415 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Tue, 6 Aug 2019 13:58:43 -0400 Subject: [PATCH] Tidy up project links --- README.md | 25 +++++++++++++------------ maintainer-notes.md | 6 ++++++ package.json | 1 + 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9eda8d30e..b2987da54 100644 --- a/README.md +++ b/README.md @@ -122,12 +122,13 @@ These commands are available from the root directory. Each project directory als | Yarn Commands | Description | | -------------------- | ------------------------------------------------------------- | -| `dev` | Default development experience for Viewer package | +| **Develop** | | +| `dev` or `start` | Default development experience for Viewer | | `dev:` | Replace with `core`, `ui`, `i18n`, `cornerstone`, `vtk`, etc. | +| `test:unit` | Jest multi-project test runner; overall coverage | +| **Deploy** | | | `build`* | Builds production output for our PWA Viewer | | `build:package`* | Builds commonjs bundles for all projects | -| `test:unit` | Jest multi-project test runner; overall coverage | -| `start` | Alias for `dev` | \* - For more information on our different builds, check out our [Deploy Docs][deployment-docs] @@ -254,14 +255,14 @@ MIT © [OHIF](https://github.com/OHIF) [configuration-url]: https://docs.ohif.org/essentials/configuration.html [extensions-url]: https://docs.ohif.org/advanced/extensions.html -[platform-core]: https://google.com -[platform-i18n]: https://google.com -[platform-ui]: https://google.com -[platform-viewer]: https://google.com +[platform-core]: platform/core/README.md +[platform-i18n]: platform/i18n/README.md +[platform-ui]: platform/ui/README.md +[platform-viewer]: platform/viewer/README.md -[extension-cornerstone]: https://google.com -[extension-dicom-html]: https://google.com -[extension-dicom-microscopy]: https://google.com -[extension-dicom-pdf]: https://google.com -[extension-vtk]: https://google.com +[extension-cornerstone]: extensions/cornerstone/README.md +[extension-dicom-html]: extensions/dicom-html/README.md +[extension-dicom-microscopy]: extensions/dicom-microscopy/README.md +[extension-dicom-pdf]: extensions/dicom-pdf/README.md +[extension-vtk]: extensions/vtk/README.md diff --git a/maintainer-notes.md b/maintainer-notes.md index e443a164f..a16a8e503 100644 --- a/maintainer-notes.md +++ b/maintainer-notes.md @@ -8,3 +8,9 @@ These commands are less frequently used, but good to remember: # Add shared dev dependency for workspace yarn add --dev -W package-name ``` + +## TODO + +- Patch status for PRs (we care about threshold only) + - Allows us to use multiproject test runner +- Flags per project for merged coverage; easier to break down coverage per project diff --git a/package.json b/package.json index 255eb85aa..6c427da0a 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,7 @@ "dev": ".scripts/dev.sh", "build": "lerna run build:viewer", "build:package": "lerna run build:package --parallel", + "test": "yarn run test:unit && yarn run test:e2e:ci", "test:unit": "jest --collectCoverage", "test:unit:ci": "lerna run test:unit:ci --parallel", "test:e2e:ci": "cd platform/viewer && yarn run test:e2e:ci",