add scripts for testing locally consul-ui-toolkit (#16794)

hashicorp · Mar 28, 2023 · 12be12f · 12be12f
1 parent e5d58c5
commit 12be12f
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/ui/packages/consul-ui/.gitignore b/ui/packages/consul-ui/.gitignore
@@ -19,6 +19,7 @@
 /npm-debug.log*
 /testem.log
 /yarn-error.log
+/yalc.lock
 
 # ember-try
 /.node_modules.ember-try/

diff --git a/ui/packages/consul-ui/README.md b/ui/packages/consul-ui/README.md
@@ -160,6 +160,13 @@ OSS only tests can also be run using:
 
 See `.eslintrc.js` and `.eslintignore` for specific configuration.
 
+### Testing local changes to `@hashicorp/consul-ui-toolkit`
+
+| Command                | Description                                                          |
+|------------------------|----------------------------------------------------------------------|
+| `yarn toolkit:link`    | Similar to `npm link` it adds the dependency locally from yalc store |
+| `yarn toolkit:remove"` | It will remove package info from package.json and yarn.lock file     |
+
 ### Building
 
 * `make build` builds the UI for production usage (env=production)

diff --git a/ui/packages/consul-ui/package.json b/ui/packages/consul-ui/package.json
@@ -38,6 +38,8 @@
     "test:coverage": "COVERAGE=true ember test --environment test --filter=Unit --test-port=${EMBER_TEST_PORT:-7357}",
     "test:coverage:ci": "COVERAGE=true ember test --environment test --filter=Unit --path dist --test-port=${EMBER_TEST_PORT:-7357}",
     "test:coverage:view": "COVERAGE=true ember test --server --environment test --filter=Unit --test-port=${EMBER_TEST_PORT:-7357}",
+    "toolkit:link": "yalc link @hashicorp/consul-ui-toolkit",
+    "toolkit:remove": "yalc remove @hashicorp/consul-ui-toolkit",
     "steps:list": "node ./lib/commands/bin/list.js",
     "storybook": "start-storybook -p 6006 -s dist",
     "build-storybook": "build-storybook -s dist"