Skip to content

Commit

Permalink
Update tasks documentation for review app
Browse files Browse the repository at this point in the history
  • Loading branch information
colinrotherham committed Mar 30, 2023
1 parent dd5d6c0 commit 7887cab
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/contributing/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand All @@ -58,23 +56,27 @@ 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`**

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:

- check Sass code quality via Stylelint (`npm run lint:scss`)
- 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:

Expand Down

0 comments on commit 7887cab

Please sign in to comment.