Merge pull request #82 from hashicorp/CC-6659

CC-6659: Auto build toolkit on changes

CONTRIBUTING.md

@@ -39,8 +39,8 @@
 
 ## Running the test application
 
-- Run `yarn prepare` after any changes to the toolkit to build it to be consumed by the documentation app.
-- Run `yarn start:documentation` to start the documentations apps server
+- Run `yarn watch:toolkit` - This will automatically re-build the toolkit to be consumed by the documentation app when toolkit file changes are detected via [fb-watchman](https://facebook.github.io/watchman).
+- In a separate terminal, run `yarn start:documentation` to start the documentations apps server
 - Visit the test application at [http://localhost:4200](http://localhost:4200).
 
 ## Adding changelog entries

Makefile

@@ -0,0 +1,3 @@
+.PHONY: build
+build:
+	@yarn prepare

documentation/app/templates/components/service-list-item.hbs

@@ -368,8 +368,8 @@
           status.</ComponentApi>
 
         <h3 id="options">Options</h3>
-          <ComponentApi @name="hideClusterPath" @type="boolean">
-            Determines whether the cluster ID, partition, and namespace are displayed in the Service List Item. Default value is <CodeInline @code="false" />.
+          <ComponentApi @name="hideClusterPath" @type="boolean" @default="false">
+            Determines whether the cluster ID, partition, and namespace are displayed in the Service List Item.
           </ComponentApi>
 
       </div>

package.json

@@ -17,7 +17,8 @@
     "start": "concurrently 'npm:start:*' --restart-after 5000 --prefix-colors cyan,white,yellow",
     "start:addon": "yarn workspace @hashicorp/consul-ui-toolkit run start",
     "start:documentation": "yarn workspace documentation run start",
-    "test": "yarn workspaces run test"
+    "test": "yarn workspaces run test",
+    "watch:toolkit": "watchman watch-del-all && watchman-make -p '**/toolkit/src/**' -t build"
   },
   "devDependencies": {
     "concurrently": "^7.2.1",