Tidy up project links
This commit is contained in:
parent
9a5372766c
commit
60f48fbdc0
25
README.md
25
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:<package-name>` | 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 -->
|
||||
[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
|
||||
<!-- Extensions -->
|
||||
[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
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user