Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akabekobeko/npm-cross-conf-env
To cross-platform the "config" and root variable reference of package.json in npm-scripts.
https://github.com/akabekobeko/npm-cross-conf-env
cross-platform environment-variables node npm npm-scripts package-json
Last synced: 3 months ago
JSON representation
To cross-platform the "config" and root variable reference of package.json in npm-scripts.
- Host: GitHub
- URL: https://github.com/akabekobeko/npm-cross-conf-env
- Owner: akabekobeko
- License: mit
- Created: 2016-05-17T11:34:43.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T05:27:56.000Z (4 months ago)
- Last Synced: 2024-03-16T06:29:54.490Z (4 months ago)
- Topics: cross-platform, environment-variables, node, npm, npm-scripts, package-json
- Language: TypeScript
- Homepage:
- Size: 48.8 KB
- Stars: 25
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-nodejs-cross-platform-cli - cross-conv-env - Set config to package.json for npm-scripts. (Packages)
- awesome-stars - akabekobeko/npm-cross-conf-env - To cross-platform the "config" and root variable reference of package.json in npm-scripts. (npm)
README
# cross-conf-env
[](https://nodejs.org/)
[](https://badge.fury.io/js/cross-conf-env)
[](https://github.com/akabekobeko/npm-cross-conf-env/actions/workflows/test.yml)
[](https://github.com/akabekobeko/npm-cross-conf-env/blob/master/LICENSE)
To cross-platform the `config` and `root` variable reference of package.json in npm-scripts.
## Installation
This npm is installed on npm-scripts only a so `devDependencies`.
```
$ npm install --save--dev cross-conf-env
```
## Usage
To the `config` of package.json to set the value.
```js
{
"name": "sample",
"version": "1.0.0",
"config": {
"app": "MyApp"
},
"scripts": {
"var": "cross-conf-env echo npm_package_config_app npm_package_version",
"var:bash": "cross-conf-env echo $npm_package_config_app $npm_package_version",
"var:win": "cross-conf-env echo %npm_package_config_app% %npm_package_version%",
"var:cross": "cross-conf-env echo npm_package_config app-npm_package_version",
"var:cross-multiple": "cross-conf-env echo npm_package_config_app-npm_package_version"
},
"devDependencies": {
"cross-conf-env": "^1.0.6"
}
}
```
Value of `npm_package_config_` or `npm_package_` will be executed after being replaced.
```
$ npm run var
MyApp 1.0.0
$ npm run var:bash
MyApp 1.0.0
$ npm run var:win
MyApp 1.0.0
$ npm run var:cross
MyApp 1.0.0
$ npm run var:cross-multiple
MyApp-1.0.0
```
The format of the environment variable in npm-scripts are different for each platform. **OS X** or **Linux** (bash) is `$variable`, **Windows** (cmd.exe or PowerShell) is `%variable%`.
It supports all of the format by using this npm in npm-scripts, format that support is below.
| Platform | Format |
| :---------------------------------- | :------------------------------------------------------------------------------- |
| **OS X**, **Linux** (bash) | `$npm_package_` or `$npm_package_config_` |
| **Windows** (cmd.exe or PowerShell) | `%npm_package_%` or `%npm_package_config_%` |
| `cross-conf-env` original | `npm_package_` or `npm_package_config_`, without special charactors (`$` or `%`) |
npm-scripts environment variable that has been expanded by the execution platform is used as it is. Otherwise, to expand the `cross-conf-env`.
Definition of npm-scripts:
```
cross-conf-env command param1 param2 ...etc
```
# Limitations
`cross-conf-env` converts the value specified in `process.env`.
It will not work if run from pipe in npm-scripts.
```json
{
"config": {
"app": "MyApp",
"test": "Test"
},
"scripts": {
"pipe": "cross-conf-env echo npm_package_config_var | cross-conf-env echo keep npm_package_config_test"
}
}
```
results:
```
$ npm run pipe
Test
echo: write: Broken pipe
```
If concatenating npm-scripts we recommend [npm-run-all](https://www.npmjs.com/package/npm-run-all) rather than pipe. If it is `npm-run-all` can concatenate npm-scripts to cross platforms, and `cross-conf-env` will work as well.
# ChangeLog
- [CHANGELOG](CHANGELOG.md)