Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Commit d65c6f5

Browse files
node-sass is deprecated, use sass instead
Also sort the script list in the readme and package.json in the same order.
1 parent f807fd0 commit d65c6f5

File tree

3 files changed

+28
-826
lines changed

3 files changed

+28
-826
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -287,24 +287,24 @@ You'll notice that npm scripts can call each other which makes it easy to compos
287287
Below is a list of all the scripts this template has available:
288288

289289

290-
| Npm Script | Description |
290+
| Npm Script | Description |
291291
| ------------------------- | ------------------------------------------------------------------------------------------------- |
292-
| `start` | Does the same as 'npm run serve'. Can be invoked with `npm start` |
293-
| `build` | Full build. Runs ALL build tasks (`build-sass`, `build-ts`, `lint`, `copy-static-assets`) |
292+
| `build-sass` | Compiles all `.scss` files to `.css` files |
293+
| `build-ts` | Compiles all source `.ts` files to `.js` files in the `dist` folder |
294+
| `build` | Full build. Runs ALL build tasks (`build-sass`, `build-ts`, `lint`, `copy-static-assets`) |
295+
| `copy-static-assets` | Calls script that copies JS libs, fonts, and images to dist directory |
296+
| `debug` | Performs a full build and then serves the app in watch mode |
297+
| `lint` | Runs ESLint on project files |
298+
| `serve-debug` | Runs the app with the --inspect flag |
294299
| `serve` | Runs node on `dist/server.js` which is the apps entry point |
295-
| `watch-node` | Runs node with nodemon so the process restarts if it crashes. Used in the main watch task |
296-
| `watch` | Runs all watch tasks (TypeScript, Sass, Node). Use this if you're not touching static assets. |
300+
| `start` | Does the same as 'npm run serve'. Can be invoked with `npm start` |
297301
| `test` | Runs tests using Jest test runner |
302+
| `watch-debug` | The same as `watch` but includes the --inspect flag so you can attach a debugger |
303+
| `watch-node` | Runs node with nodemon so the process restarts if it crashes. Used in the main watch task |
304+
| `watch-sass` | Same as `build-sass` but continuously watches `.scss` files and re-compiles when needed |
298305
| `watch-test` | Runs tests in watch mode |
299-
| `build-ts` | Compiles all source `.ts` files to `.js` files in the `dist` folder |
300-
| `watch-ts` | Same as `build-ts` but continuously watches `.ts` files and re-compiles when needed |
301-
| `build-sass` | Compiles all `.scss` files to `.css` files |
302-
| `watch-sass` | Same as `build-sass` but continuously watches `.scss` files and re-compiles when needed |
303-
| `lint` | Runs ESLint on project files |
304-
| `copy-static-assets` | Calls script that copies JS libs, fonts, and images to dist directory |
305-
| `debug` | Performs a full build and then serves the app in watch mode |
306-
| `serve-debug` | Runs the app with the --inspect flag |
307-
| `watch-debug` | The same as `watch` but includes the --inspect flag so you can attach a debugger |
306+
| `watch-ts` | Same as `build-ts` but continuously watches `.ts` files and re-compiles when needed |
307+
| `watch` | Runs all watch tasks (TypeScript, Sass, Node). Use this if you're not touching static assets. |
308308

309309
## Type Definition (`.d.ts`) Files
310310
TypeScript uses `.d.ts` files to provide types for JavaScript libraries that were not written in TypeScript.
@@ -596,7 +596,7 @@ In that file you'll find two sections:
596596
| chai | Testing utility library that makes it easier to write tests |
597597
| concurrently | Utility that manages multiple concurrent tasks. Used with npm scripts |
598598
| jest | Testing library for JavaScript. |
599-
| node-sass | Allows to compile .scss files to .css |
599+
| sass | Allows to compile .scss files to .css |
600600
| nodemon | Utility that automatically restarts node process when it crashes |
601601
| supertest | HTTP assertion library. |
602602
| ts-jest | A preprocessor with sourcemap support to help use TypeScript with Jest.|

0 commit comments

Comments
 (0)