|
1 | 1 | Make sure you have navigated to your project root within your node command line. From this point you can use several commands. There are a few main dev commands, and then several smaller commands for more granular control. |
2 | 2 | ## Main Dev Commands |
3 | 3 |
|
4 | | -### gulp manifest |
5 | | -You should recognize this command from setting up your project. This command will update your manifest with the information provided in `gulpfile.js`. Anytime you need to update this information, for example, when changing the version number, you will need to run this command. |
| 4 | +### gulp init |
| 5 | +This command initializes all third-party dependencies utilized within **nvQuickTheme**. More specifically, it executes the following SubTask Commands in series (completes each task before the next): |
| 6 | +* **gulp fontsInit** |
| 7 | +* **gulp faFontsInit** |
| 8 | +* **gulp faCssInit** |
| 9 | +* **gulp slimMenuInit** |
| 10 | +* **gulp normalizeInit** |
| 11 | +* **gulp bsCssInit** |
| 12 | +* **gulp bsJsInit** |
6 | 13 |
|
7 | 14 | ### gulp build |
8 | | -This command error checks, concatenates, compiles and minifies all your js and scss into the `dist/` folder, as well as copies your containers to the correct folder. |
| 15 | +This command error checks, concatenates, compiles and minifies all your JS and SCSS into the `./dist/` folder, as well as copies your containers to the correct folder. More specifically, it executes the following commands in series (completes each task before the next): |
| 16 | +* **gulp init** |
| 17 | +* **gulp styles** |
| 18 | +* **gulp scripts** |
| 19 | +* **gulp images** |
| 20 | +* **gulp containers** |
| 21 | +* **gulp manifest** |
9 | 22 |
|
10 | 23 | ### gulp watch |
11 | | -This sets your node instance to watch all the js and scss in the src folder for any changes, as well as your containers. Upon changes it will automatically run the build command. Note: This command will take over your node instance, you may need to start a new instance if you want to run other commands. |
| 24 | +This sets your node instance to watch all changes of images, JS and SCSS in the `./src/` folder, as well as containers in the `./containers/` folder. Upon changes it will automatically run the **gulp build** command. |
| 25 | + |
| 26 | +**Note:** _This command will take over your node instance (in Command Prompt, PowerShell, Git Bash, VS Code Terminal, etc.). Therefore, you may want to start a new instance if you need to run other commands at the same time._ |
12 | 27 |
|
13 | 28 | ### gulp package |
14 | | -A bit confusing with all the package talk earlier, but here we're not talking about dev packages anymore. This command builds and packages up what you've created into a DNN theme installation package (zip file). It will deposit the zip file under the `[root]/build/` folder using the information provided in `gulpfile.js`: `[project]_[version]_install.zip`. |
| 29 | +This command builds and packages your custom theme into a DNN theme installation package (ZIP file). It will place the ZIP file in the `./build/` folder using the following naming convention: `[project]_[version]_install.zip` |
15 | 30 |
|
16 | 31 |
|
17 | 32 | *** |
18 | 33 |
|
19 | 34 | ## SubTask Commands |
20 | | -These commands are mostly used within the 3 over arching commands, but can be used individually if desired. |
| 35 | +These commands are mostly used within the four Main Dev Commands, but can be used individually if desired. |
21 | 36 |
|
22 | | -### gulp js |
23 | | -Error checks, concatenates, compiles, and minifies all js in the `src/js/` folder and outputs into the `dist/js/` folder. |
| 37 | +### gulp manifest |
| 38 | +You should recognize this command from setting up your project. This command will update your manifest with the information provided in `project-details.json`. Anytime you need to update this information, like when changing the version number, you will need to run this command. This command is also executed as a part of the **gulp build** and **gulp package** commands. |
24 | 39 |
|
25 | | -### gulp scss |
26 | | -Error checks, concatenates, compiles, and minifies all scss in the `src/scss/` folder and outputs into the `dist/css/` folder. |
| 40 | +### gulp scripts |
| 41 | +Error checks, concatenates, compiles, and minifies all JS in the `./src/js/` folder and distributes to the `./dist/js/` folder. |
| 42 | + |
| 43 | +### gulp styles |
| 44 | +Error checks, concatenates, compiles, and minifies all SCSS in the `./src/scss/` folder and distributes to the `./dist/css/` folder. |
27 | 45 |
|
28 | 46 | ### gulp images |
29 | | -Compresses images in the `src/images/` folder and output into the `dist/images/` folder. |
| 47 | +Compresses images in the `./src/images/` folder and distributes to the `./dist/images/` folder. |
30 | 48 |
|
31 | 49 | ### gulp containers |
32 | | -Copies the containers to the correct folder for DNN. |
| 50 | +Copies containers to the correct folder within your DNN instance (assuming you are developing within a DNN instance). This translates to `../../Containers/[your theme project name]/`. |
33 | 51 |
|
34 | 52 |
|
35 | 53 | *** |
36 | 54 |
|
37 | 55 | ## Process Commands |
38 | | -These commands are used within other commands, or for special cases. We recommend use of these only for advanced users. |
| 56 | +These commands are used within other commands and for other special situations. _We recommend use of these only for advanced users._ |
| 57 | + |
| 58 | +### gulp zipdist |
| 59 | +ZIPs contents of `./dist/` folder. Used to prepare for theme packaging. |
39 | 60 |
|
40 | | -### gulp update |
41 | | -Pulls Bootstrap, Font-Awesome, and Normalize assets from the node_modules. So if you update your dependencies, you'll want to run this. Note that this will overwrite any changes you've done to the _normalize.scss file. |
| 61 | +### gulp zipcontainers |
| 62 | +ZIPs contents of `./containers/` folder. Used to prepare for theme packaging. |
42 | 63 |
|
43 | | -### gulp buildzips |
44 | | -Zips each dist folder. Used to prep theme packaging. |
| 64 | +### gulp zipelse |
| 65 | +ZIPs contents of `./menus/` folder, `./partials/` folder, and all ASCX, XML, HTML and HTML files withinthe root folder (`./`). Used to prepare for theme packaging. |
45 | 66 |
|
46 | | -### gulp zipfiles |
47 | | -Collects all the zip files and project root files needed into the main theme zip file. |
| 67 | +### gulp zippackage |
| 68 | +ZIPs all subset ZIP files and other pertinent project files into theme package installation file using the following naming convention: `[project]_[version]_install.zip` |
48 | 69 |
|
49 | 70 | ### gulp cleanup |
50 | | -Deletes all the zip files under the project root. Used to cleanup the individual zip files created in the theme packaging task. |
| 71 | +Deletes all temporary ZIP and project files used in package tasks. |
0 commit comments