liferay-npm-scripts

Usage

npm install --save-dev liferay-npm-scripts

package.json

{
	"scripts": {
		"build": "liferay-npm-scripts build"
	}
}

Scripts Available

build

Build script that compiles all necessary javascript, soy, and bundles it together using liferay-npm-bundler.

liferay-npm-scripts build

Do you have soy dependencies? build should automatically detect them.

Do you need to use liferay-npm-bridge-generator? Just add a .npmbridgerc file and follow the configuration options here.

check

liferay-npm-scripts check

Check calls prettier with the --check flag for the globs specified in your npmscripts.config.js configuration. Or default preset seen here.

fix

liferay-npm-scripts fix

Fix calls prettier with the --write flag for the globs specified in your npmscripts.config.js configuration. Or default preset seen here.

test

liferay-npm-scripts test

Runs jest with a default configuration specified in jest.json. You can override or add any additional configuration by following jest documentaion.

Additionally if you want to use any flags for jest, such as --watch you can do so.

For example

liferay-npm-scripts test --watch

theme

liferay-npm-scripts theme TASK

Inside a theme directory, runs one of the available Gulp tasks, TASK, from liferay-theme-tasks, automatically passing settings for use inside liferay-portal.

For example:

liferay-npm-scripts theme build

Runs the "build" task, providing it with the configuration it needs to find core dependencies such as the liferay-frontend-theme-styled base theme files.

Config

Note: as of v2.x the config file was renamed from .liferaynpmscriptsrc to npmscripts.config.js

If you need to add additional configuration you can do so by creating a npmscripts.config.js file at the root of your project. The default configuration of this file can be seen here.

`preset`

npmscripts.config.js allows for a preset option which is a pre-defined configuration. By default liferay-npm-scripts uses liferay-npm-scripts-preset-standard. If you want to create your own preset, you need to create an npm package or a local dependency. You can also extend from a preset by creating a npmscripts.config.js that looks something like...

module.exports = {
	preset: 'path/to/some/dependency'
};

// or npm package (this needs to also be specified in your package.json)

module.exports = {
	preset: 'my-cool-preset'
};

If you want to extend from the standard preset and then add an additional dependency, you will have to do something like...

const standardPreset = require('liferay-npm-scripts/src/presets/standard/index');

module.exports = {
	preset: 'liferay-npm-scripts/src/presets/standard/index',
	build: {
		dependencies: [...standardPreset.build.dependencies, 'asset-taglib']
	}
};

If you just set dependencies to be ['my-new-dependency'], it will override the existing dependencies from the standard preset.

Other Config

If you need more flexibility over Babel or the bundler. You can still add a .babelrc.js or .npmbundlerrc which will be merged with the default settings this tool provides. Default Babel Config, Default Bundler Config

Want to use a different NODE_ENV? Try doing something like

NODE_ENV=development liferay-npm-scripts build