Build tools
The Select2 Bootstrap 5 Theme uses Gulp to compile the assets, see below for the included npm scripts and Gulp tasks and what they do;
npm script | Gulp task | Description |
---|---|---|
start |
default |
Cleans the dist directory, lints the SCSS, compiles the dev and min versions and starts watching the SCSS for changes |
start:full |
N/A | Cleans, lints, compiles and watches the SCSS (theme & docs) and serves the docs for development |
clean |
clean |
Cleans the dist directory, removing the directory and it's contents |
lint |
lint |
Lints the SCSS files using Stylelint, see .stylelintrc and stylelint-config-twbs-bootstrap for linting rules |
compile |
compile |
Cleans the dist directory, lints the SCSS, compiles the LTR and RTL dev and min versions. Does the same for the docs |
compile:main |
compile:main |
Compiles all LTR versions |
compile:rtl |
compile:rtl |
Compiles all RTL versions |
watch |
watch |
Watches all files in src , compiling the SCSS when changes are detected |
docs |
docs |
Cleans the docs/assets/css directory, lints the docs SCSS, compiles the docsSCSS and starts watching the docs SCSS for changes |
docs:clean |
docs:clean |
Cleans the docs/assets/css directory, removing the directory and it's contents |
docs:lint |
docs:lint |
Lints the docs SCSS files using Stylelint, see .stylelintrc and stylelint-config-twbs-bootstrap for linting rules |
docs:compile |
docs:compile |
Cleans the docs/assets/css directory, lints the docs SCSS and compiles the LTR and RTL versions |
docs:compile:main |
docs:compile:main |
Compiles the LTR version of the docs SCSS |
docs:compile:rtl |
docs:compile:rtl |
Compiles the RTL version of the docs SCSS |
docs:watch |
docs:watch |
Watches all files in docs/_sass , compiling the SCSS when changes are detected |
docs:build |
N/A | Builds the docs using Jekyll |
docs:serve |
N/A | Serves the docs using Jekyll for development |