From 69b3f08fed3f9287d50c3ccde76c95524f06dbba Mon Sep 17 00:00:00 2001 From: Colin Rotherham Date: Thu, 23 Mar 2023 14:03:08 +0000 Subject: [PATCH] Update tasks documentation for review app --- docs/contributing/tasks.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/contributing/tasks.md b/docs/contributing/tasks.md index 8fb5bc32b7..2b08630222 100644 --- a/docs/contributing/tasks.md +++ b/docs/contributing/tasks.md @@ -26,15 +26,13 @@ npm scripts are defined in `package.json`. These trigger a number of Gulp tasks. - start up Express, restarting when `.mjs`, `.json` or `.yaml` files change -**`npm run build:app` will do the following:** +**`npm run build:app` will trigger `npm run build --workspace app` that will:** - clean the `./app/dist` folder - output files into `./app/dist` - copy fonts and images -- run sub tasks from `gulp styles` without StyleLint code quality checks -- run sub tasks from `gulp scripts` without ESLint code quality checks -- compile Sass documentation into `./app/dist/docs/sassdoc` -- compile JavaScript documentation into `./app/dist/docs/jsdoc` +- compile Sass to CSS, including documentation +- compile JavaScript ESM to CommonJS, including documentation **`npm run build:package` will do the following:** @@ -58,7 +56,7 @@ npm scripts are defined in `package.json`. These trigger a number of Gulp tasks. ## Gulp tasks -Gulp tasks are defined in `gulpfile.mjs` and .`/tasks/` folder. +Project Gulp tasks are defined in [`gulpfile.mjs`](../../gulpfile.mjs) and the [`tasks/`](../../tasks) folder. **`gulp --tasks`** @@ -66,7 +64,11 @@ This task will: - list out all available tasks -**`gulp styles`** +Review app Gulp tasks are defined in [`app/gulpfile.mjs`](../../app/gulpfile.mjs) and the [`app/tasks/`](../../app/tasks) folder. + +Gulp tasks from npm workspaces (such as the review app) can be run as shown: + +**`npx --workspace app -- gulp styles`** This task will: @@ -74,7 +76,7 @@ This task will: - compile Sass to CSS into `./app/dist/stylesheets` - compile Sass documentation into `./app/dist/docs/sassdoc` -**`gulp scripts`** +**`npx --workspace app -- gulp scripts`** This task will: