About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » npm
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:npm

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
development:npm [2023/04/20 15:00] – demiankatzdevelopment:npm [2023/05/01 17:01] (current) – demiankatz
Line 5: Line 5:
 To setup NPM to run, first install node and run "npm install" to install all the dependencies in package.json. To setup NPM to run, first install node and run "npm install" to install all the dependencies in package.json.
  
-===== npm run build:css =====+===== Build Tasks ===== 
 + 
 +These tasks build artifacts in the themes through a one-time action. 
 + 
 +==== npm run build ==== 
 + 
 +Generates any artifacts that require pre-processing inside all available themes. As of this writing, this is an alias for ''npm run build:css'', but this could change in the future. 
 + 
 +==== npm run build:css ====
  
 Generates any CSS files that require pre-processing inside all available themes. As of this writing, this is an alias for ''npm run build:less'', but as VuFind® evolves, if we migrate to different technologies, we plan to maintain this alias, so your development routines will not be disrupted. Generates any CSS files that require pre-processing inside all available themes. As of this writing, this is an alias for ''npm run build:less'', but as VuFind® evolves, if we migrate to different technologies, we plan to maintain this alias, so your development routines will not be disrupted.
  
-===== npm run build:less =====+==== npm run build:less ====
  
 :!: Using "npm run build:css" instead is recommended; see above. :!: Using "npm run build:css" instead is recommended; see above.
Line 19: Line 27:
 <code>npm run build:less</code> <code>npm run build:less</code>
  
-===== npm run build:scss =====+==== npm run build:scss ====
  
 Compiles all sass files into a compressed css file. This script will detect themes inside of your themes directory and build the proper paths for you. Compiles all sass files into a compressed css file. This script will detect themes inside of your themes directory and build the proper paths for you.
Line 25: Line 33:
 <code>npm run build:scss</code> <code>npm run build:scss</code>
  
-===== npm run lessToSass =====+==== npm run lessToSass ==== 
 + 
 +Converts all less files to sass. Mostly for the VuFind® dev team. 
 + 
 +===== Development Build Tasks ===== 
 + 
 +These tasks are equivalent to the similarly-named build tasks above, but they produce development-mode artifacts that allow more detailed debugging. 
 + 
 +  * build-dev 
 +  * build-dev:css 
 +  * build-dev:less 
 + 
 +===== Watch Tasks =====
  
-Converts all less files to sass. Mostly for the VuFind® dev team. By default does bootstrap3 and bootprint3.+These tasks run a monitoring process to automatically run the associated build / development build task whenever files are edited. This can be useful during active development.
  
 +  * watch
 +  * watch:css
 +  * watch:less
 +  * watch:lessToSass
 +  * watch-dev
 +  * watch-dev:css
 +  * watch-dev:less
 ---- struct data ---- ---- struct data ----
 properties.Page Owner :  properties.Page Owner : 
 ---- ----
  
development/npm.txt · Last modified: 2023/05/01 17:01 by demiankatz