cross-let
v2.1.1
Published
- [cross-var](https://www.npmjs.com/package/cross-var) - [cross-var-no-babel](https://www.npmjs.com/package/cross-var-no-babel?activeTab=readme) - [@appicanis/cross-var](https://www.npmjs.com/package/@appicanis/cross-var?activeTab=readme)
Downloads
81
Readme
cross-let
Version of cross-var
with updates
I.e cross-let
is cross-var
with some fixes and improvements.
Overview
When using npm scripts
it creates a lot of environment variables that are available for you to leverage when executing scripts.
If you'd like to take a look at all of the variables then you can run npm run env
in your terminal.
> npm run env
npm_package_name=cross-let
npm_package_author_name=MWT
npm_package_version=2.0.0
... lots more ...
Now you can use those environment variables in your npm scripts
by referencing them like the following
{
"name": "World",
"scripts": {
"//": "The following only works on Mac OS X/Linux (bash)",
"bash-script": "echo Hello $npm_package_name"
"//": "The following only works on a Windows machine",
"win-script": "echo Hello %npm_package_name%"
}
}
> npm run bash-script
Hello World
However, this won't work on Windows... because it expects the variables to be surrounded by percent signs, so we can change our script just slightly.
cross-let
to the Rescue!
The goal of cross-let
is to let you use one script syntax to work either on a Mac OS X/Linux (bash) or Windows. Reference the Usage documention below on how to use cross-let
in your scripts.
Usage
Simple Commands
{
"version": "1.0.0",
"config": {
"port": "1337"
},
"scripts": {
"prebuild": "cross-let rimraf public/$npm_package_version",
"build:html": "cross-let jade --obj data.json src/index.jade --out public/$npm_package_version/",
"server:create": "cross-let http-server public/$npm_package_version -p $npm_package_config_port",
"server:launch": "cross-let opn http://localhost:$npm_package_config_port"
}
}
Complex Commands
{
"version": "1.0.0",
"scripts": {
"build:css": "cross-let \"node-sass src/index.scss | postcss -c .postcssrc.json | cssmin > public/$npm_package_version/index.min.css\"",
"build:js": "cross-let \"mustache data.json src/index.mustache.js | uglifyjs > public/$npm_package_version/index.min.js\"",
}
}
But What About!?!
Click on one of the following questions to reveal a detailed answer
However, if you want to support older Windows versions, then you might consider using cross-env
or another approach to leverage environment variables in your scripts.