Npm Commands (Scripts)
NPM scripts are powerful tools that help automate repetitive tasks in development, such as minification, compilation, unit testing, linting, and more. In the Geeks UI build system, this is achieved through a well-organized collection of JavaScript files, each dedicated to specific tasks.
List of available Npm commands (Scripts)
Command | Description |
---|---|
npm install |
This command installs all the Node.js packages and their dependencies specified in the project's
package.json
file, located in the root directory. It includes packages listed under both
dependencies
and
devDependencies
objects.
|
npm run scss |
This script runs the
scss
task using Gulp. It typically compiles SCSS (Sass) files into CSS, possibly including additional steps like autoprefixing or minification.
|
npm run vendorJs |
This script runs the
vendorJs
task using Gulp. It usually involves bundling, minifying, or processing third-party JavaScript libraries (vendor scripts) that the project relies on.
|
npm run images |
This script runs the
images
task using Gulp. It generally involves optimizing image files (e.g., compressing or resizing) to reduce file size and improve load times.
|
npm run fonts |
This script runs the
fonts
task using Gulp. It might involve copying, optimizing, or otherwise processing font files used in the project.
|
npm run html |
This script runs the
html
task using Gulp. It typically processes HTML files, which could include tasks like minification, templating, or injecting assets.
|
npm run fileincludeTask |
This script runs the
fileincludeTask
task using Gulp. It likely involves including partial HTML or other files into a main HTML file, helping to modularize the codebase.
|
npm run copyLibs |
This script runs the
copyLibs
task using Gulp. It usually involves copying library files, such as JavaScript or CSS frameworks, from one location to another (e.g., from node_modules to a dist
directory).
|
npm run cleanTemp |
This script runs the
cleanTemp
task using Gulp. It likely removes temporary files and directories created during the build process, helping to keep the workspace clean.
|
npm run cleanDist |
This script runs the
cleanDist
task using Gulp. It typically involves deleting the distribution folder (dist), which holds the final build output, to ensure a clean slate before a new build.
|
npm run build |
This script runs the
build
task using Gulp. It likely triggers a series of tasks (e.g., compiling SCSS, bundling JS, optimizing assets) to produce the final, production-ready output.
|
npm run start |
This script runs the default
Gulp task
, often named default. It typically kicks off the main build process or a set of common tasks, depending on how the Gulpfile is configured.
|
npm run serve |
This script explicitly runs the
default
task in Gulp serve , often named default.It might start a development server, watch files for changes, and automatically rebuild or reload the project as necessary.
|