|
1 | 1 | # A Set of Gulp v4.0.0 Tasks for Creating Web Projects Using HTML, CSS/Sass, and JavaScript
|
2 | 2 |
|
3 |
| -(v4.0.1) |
| 3 | +(v4.0.2) |
4 | 4 |
|
5 | 5 | ---
|
6 | 6 |
|
7 | 7 | ## Installation
|
8 |
| -You need to have Java installed before continuing, as the browser refresh module requires it. Additionally, all the required Node modules need to be installed before you can use this template. From the root folder of this project, type `npm install`. This will create a folder called `node_modules` and download the plugins listed under the `devDependencies` section in the `package.json` file. If you encounter an `ERR!` message about `EACCES`, then you’ll need to run the command as the super user: `sudo npm install`. Because the Gulp tasks amount to about 112MB, expect to wait. |
| 8 | +Before continuing, make sure Java is installed, as the browser refresh module requires it. Additionally, all the required Node modules need to be installed before you can use this template. From the root folder, type `npm install`. This will create a folder called `node_modules` and download the plugins listed under the `devDependencies` section in the `package.json` file. If you encounter an `ERR!` message about `EACCES` on macOS, then run the command as the super user: `sudo npm install`. |
9 | 9 |
|
10 | 10 | ## Tasks
|
11 |
| -Typing `gulp --tasks`, or simply `gulp`, will provide you with a list of tasks included in `gulpfile.js`. Tasks such as `build` and `serve` invoke other tasks and are nested in the output of `gulp --tasks` and are executed in `<series>`. |
| 11 | +Typing `gulp --tasks`, or simply `gulp`, will render a list of tasks included in `gulpfile.js`. Tasks such as `build` and `serve` invoke other tasks and are executed in `<series>`. |
12 | 12 |
|
13 | 13 | Each task can be run on its own. For example, if all you want to do is validate your HTML, you can type `gulp validateHTML`.
|
14 | 14 |
|
15 | 15 | ## Running the Project
|
16 |
| -All your work must be added to the sub-folders under the `dev` folder: your markup in `html`, your Sass/CSS in `styles`, your JavaScript in `scripts`, and your images in `img`. |
| 16 | +All your work must be added to the sub-folders under the `dev` folder: your markup in `html`, your Sass/CSS in `styles`, your JavaScript in `scripts`, and, your images in `img`. |
17 | 17 |
|
18 | 18 | During development, run `gulp serve`, which runs multiple development-related tasks, then launches your default browser and reloads on file changes.
|
19 | 19 |
|
20 | 20 | For production-ready projects, run `build`, which creates a folder called `prod`. This is the folder you’d upload to your server if you were going live with your project.
|
| 21 | + |
| 22 | +## Issues |
| 23 | +As of this writing, 14 Oct 2021, you’ll need to have [`stylelint` installed](https://stylelint.io/user-guide/get-started) to run `gulp-stylelint`, which is included in a task called `lintCSS`. However, there’s a bug in this project that, when adding the following to the `serve` task, the browser won’t reload on changes to CSS files. |
| 24 | + |
| 25 | +```javascript |
| 26 | +watch(`dev/styles/**/*.css`, lintCSS) |
| 27 | + .on(`change`, reload); |
| 28 | +``` |
0 commit comments