basant307/AI_Governance_Project
045
1<div align="center">2<h1>cross-env 🔀</h1>3 4<p>Run scripts that set and use environment variables across platforms</p>5</div>6 7**🚨 NOTICE: cross-env still works well, but is in maintenance mode. No new8features will be added, only serious and common-case bugs will be fixed, and9it will only be kept up-to-date with Node.js over time.10[Learn more](https://github.com/kentcdodds/cross-env/issues/257)**11 12---13 14<!-- prettier-ignore-start -->15[![Build Status][build-badge]][build]16[![Code Coverage][coverage-badge]][coverage]17[![version][version-badge]][package]18[![downloads][downloads-badge]][npmtrends]19[![MIT License][license-badge]][license]20[![All Contributors][all-contributors-badge]](#contributors-)21[![PRs Welcome][prs-badge]][prs]22[![Code of Conduct][coc-badge]][coc]23<!-- prettier-ignore-end -->24 25## The problem26 27Most Windows command prompts will choke when you set environment variables with28`NODE_ENV=production` like that. (The exception is [Bash on Windows][win-bash],29which uses native Bash.) Similarly, there's a difference in how windows and30POSIX commands utilize environment variables. With POSIX, you use: `$ENV_VAR`31and on windows you use `%ENV_VAR%`.32 33## This solution34 35`cross-env` makes it so you can have a single command without worrying about36setting or using the environment variable properly for the platform. Just set it37like you would if it's running on a POSIX system, and `cross-env` will take care38of setting it properly.39 40<!-- START doctoc generated TOC please keep comment here to allow auto update -->41<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->42 43- [Installation](#installation)44- [Usage](#usage)45- [`cross-env` vs `cross-env-shell`](#cross-env-vs-cross-env-shell)46- [Windows Issues](#windows-issues)47- [Inspiration](#inspiration)48- [Other Solutions](#other-solutions)49- [Contributors](#contributors)50- [LICENSE](#license)51 52<!-- END doctoc generated TOC please keep comment here to allow auto update -->53 54## Installation55 56This module is distributed via [npm][npm] which is bundled with [node][node] and57should be installed as one of your project's `devDependencies`:58 59```60npm install --save-dev cross-env61```62 63> WARNING! Make sure that when you're installing packages that you spell things64> correctly to avoid [mistakenly installing malware][malware]65 66> NOTE : Version 7 of cross-env only supports Node.js 10 and higher, to use it on67> Node.js 8 or lower install version 6 `npm install --save-dev cross-env@6`68 69## Usage70 71I use this in my npm scripts:72 73```json74{75 "scripts": {76 "build": "cross-env NODE_ENV=production webpack --config build/webpack.config.js"77 }78}79```80 81Ultimately, the command that is executed (using [`cross-spawn`][cross-spawn])82is:83 84```85webpack --config build/webpack.config.js86```87 88The `NODE_ENV` environment variable will be set by `cross-env`89 90You can set multiple environment variables at a time:91 92```json93{94 "scripts": {95 "build": "cross-env FIRST_ENV=one SECOND_ENV=two node ./my-program"96 }97}98```99 100You can also split a command into several ones, or separate the environment101variables declaration from the actual command execution. You can do it this way:102 103```json104{105 "scripts": {106 "parentScript": "cross-env GREET=\"Joe\" npm run childScript",107 "childScript": "cross-env-shell \"echo Hello $GREET\""108 }109}110```111 112Where `childScript` holds the actual command to execute and `parentScript` sets113the environment variables to use. Then instead of run the childScript you run114the parent. This is quite useful for launching the same command with different115env variables or when the environment variables are too long to have everything116in one line. It also means that you can use `$GREET` env var syntax even on117Windows which would usually require it to be `%GREET%`.118 119If you precede a dollar sign with an odd number of backslashes the expression120statement will not be replaced. Note that this means backslashes after the JSON121string escaping took place. `"FOO=\\$BAR"` will not be replaced.122`"FOO=\\\\$BAR"` will be replaced though.123 124Lastly, if you want to pass a JSON string (e.g., when using [ts-loader]), you125can do as follows:126 127```json128{129 "scripts": {130 "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} node some_file.test.ts"131 }132}133```134 135Pay special attention to the **triple backslash** `(\\\)` **before** the136**double quotes** `(")` and the **absence** of **single quotes** `(')`. Both of137these conditions have to be met in order to work both on Windows and UNIX.138 139## `cross-env` vs `cross-env-shell`140 141The `cross-env` module exposes two bins: `cross-env` and `cross-env-shell`. The142first one executes commands using [`cross-spawn`][cross-spawn], while the second143one uses the `shell` option from Node's `spawn`.144 145The main use case for `cross-env-shell` is when you need an environment variable146to be set across an entire inline shell script, rather than just one command.147 148For example, if you want to have the environment variable apply to several149commands in series then you will need to wrap those in quotes and use150`cross-env-shell` instead of `cross-env`.151 152```json153{154 "scripts": {155 "greet": "cross-env-shell GREETING=Hi NAME=Joe \"echo $GREETING && echo $NAME\""156 }157}158```159 160The rule of thumb is: if you want to pass to `cross-env` a command that contains161special shell characters _that you want interpreted_, then use162`cross-env-shell`. Otherwise stick to `cross-env`.163 164On Windows you need to use `cross-env-shell`, if you want to handle165[signal events](https://nodejs.org/api/process.html#process_signal_events)166inside of your program. A common case for that is when you want to capture a167`SIGINT` event invoked by pressing `Ctrl + C` on the command-line interface.168 169## Windows Issues170 171Please note that `npm` uses `cmd` by default and that doesn't support command172substitution, so if you want to leverage that, then you need to update your173`.npmrc` to set the `script-shell` to powershell.174[Learn more here](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729).175 176## Inspiration177 178I originally created this to solve a problem I was having with my npm scripts in179[angular-formly][angular-formly]. This made contributing to the project much180easier for Windows users.181 182## Other Solutions183 184- [`env-cmd`](https://github.com/toddbluhm/env-cmd) - Reads environment185 variables from a file instead186- [`@naholyr/cross-env`](https://www.npmjs.com/package/@naholyr/cross-env) -187 `cross-env` with support for setting default values188 189## Issues190 191_Looking to contribute? Look for the [Good First Issue][good-first-issue]192label._193 194### 🐛 Bugs195 196Please file an issue for bugs, missing documentation, or unexpected behavior.197 198[**See Bugs**][bugs]199 200### 💡 Feature Requests201 202This project is in maintenance mode and no new feature requests will be considered.203 204[**Learn more**](https://github.com/kentcdodds/cross-env/issues/257)205 206## Contributors ✨207 208Thanks goes to these people ([emoji key][emojis]):209 210<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->211<!-- prettier-ignore-start -->212<!-- markdownlint-disable -->213<table>214 <tr>215 <td align="center"><a href="https://kentcdodds.com"><img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;" alt=""/><br /><sub><b>Kent C. Dodds</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=kentcdodds" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=kentcdodds" title="Documentation">📖</a> <a href="#infra-kentcdodds" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=kentcdodds" title="Tests">⚠️</a></td>216 <td align="center"><a href="https://zhuangya.me"><img src="https://avatars1.githubusercontent.com/u/499038?v=3" width="100px;" alt=""/><br /><sub><b>Ya Zhuang </b></sub></a><br /><a href="#plugin-zhuangya" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=zhuangya" title="Documentation">📖</a></td>217 <td align="center"><a href="https://wopian.me"><img src="https://avatars3.githubusercontent.com/u/3440094?v=3" width="100px;" alt=""/><br /><sub><b>James Harris</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=wopian" title="Documentation">📖</a></td>218 <td align="center"><a href="https://github.com/compumike08"><img src="https://avatars1.githubusercontent.com/u/8941730?v=3" width="100px;" alt=""/><br /><sub><b>compumike08</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Acompumike08" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=compumike08" title="Documentation">📖</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=compumike08" title="Tests">⚠️</a></td>219 <td align="center"><a href="https://github.com/danielo515"><img src="https://avatars1.githubusercontent.com/u/2270425?v=3" width="100px;" alt=""/><br /><sub><b>Daniel Rodríguez Rivero</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Adanielo515" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=danielo515" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=danielo515" title="Documentation">📖</a></td>220 <td align="center"><a href="https://github.com/inyono"><img src="https://avatars2.githubusercontent.com/u/1508477?v=3" width="100px;" alt=""/><br /><sub><b>Jonas Keinholz</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Ainyono" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=inyono" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=inyono" title="Tests">⚠️</a></td>221 <td align="center"><a href="https://github.com/hgwood"><img src="https://avatars3.githubusercontent.com/u/1656170?v=3" width="100px;" alt=""/><br /><sub><b>Hugo Wood</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Ahgwood" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=hgwood" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=hgwood" title="Tests">⚠️</a></td>222 </tr>223 <tr>224 <td align="center"><a href="https://github.com/thomasthiebaud"><img src="https://avatars0.githubusercontent.com/u/3715715?v=3" width="100px;" alt=""/><br /><sub><b>Thiebaud Thomas</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Athomasthiebaud" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=thomasthiebaud" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=thomasthiebaud" title="Tests">⚠️</a></td>225 <td align="center"><a href="https://daniel.blog"><img src="https://avatars1.githubusercontent.com/u/1715800?v=3" width="100px;" alt=""/><br /><sub><b>Daniel Rey López</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=DanReyLop" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=DanReyLop" title="Tests">⚠️</a></td>226 <td align="center"><a href="http://amilajack.com"><img src="https://avatars2.githubusercontent.com/u/6374832?v=3" width="100px;" alt=""/><br /><sub><b>Amila Welihinda</b></sub></a><br /><a href="#infra-amilajack" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>227 <td align="center"><a href="https://twitter.com/paulcbetts"><img src="https://avatars1.githubusercontent.com/u/1396?v=3" width="100px;" alt=""/><br /><sub><b>Paul Betts</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Apaulcbetts" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=paulcbetts" title="Code">💻</a></td>228 <td align="center"><a href="https://github.com/turnerhayes"><img src="https://avatars1.githubusercontent.com/u/6371670?v=3" width="100px;" alt=""/><br /><sub><b>Turner Hayes</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Aturnerhayes" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=turnerhayes" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=turnerhayes" title="Tests">⚠️</a></td>229 <td align="center"><a href="https://github.com/sudo-suhas"><img src="https://avatars2.githubusercontent.com/u/22251956?v=4" width="100px;" alt=""/><br /><sub><b>Suhas Karanth</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=sudo-suhas" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=sudo-suhas" title="Tests">⚠️</a></td>230 <td align="center"><a href="https://github.com/sventschui"><img src="https://avatars3.githubusercontent.com/u/512692?v=4" width="100px;" alt=""/><br /><sub><b>Sven</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=sventschui" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=sventschui" title="Documentation">📖</a> <a href="#example-sventschui" title="Examples">💡</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=sventschui" title="Tests">⚠️</a></td>231 </tr>232 <tr>233 <td align="center"><a href="https://github.com/NicoZelaya"><img src="https://avatars0.githubusercontent.com/u/5522668?v=4" width="100px;" alt=""/><br /><sub><b>D. Nicolás Lopez Zelaya</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=NicoZelaya" title="Code">💻</a></td>234 <td align="center"><a href="http://bithavoc.io"><img src="https://avatars3.githubusercontent.com/u/219289?v=4" width="100px;" alt=""/><br /><sub><b>Johan Hernandez</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=bithavoc" title="Code">💻</a></td>235 <td align="center"><a href="https://github.com/jnielson94"><img src="https://avatars3.githubusercontent.com/u/13559161?v=4" width="100px;" alt=""/><br /><sub><b>Jordan Nielson</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/issues?q=author%3Ajnielson94" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=jnielson94" title="Code">💻</a> <a href="https://github.com/kentcdodds/cross-env/commits?author=jnielson94" title="Tests">⚠️</a></td>236 <td align="center"><a href="https://nz.linkedin.com/in/jsonc11"><img src="https://avatars0.githubusercontent.com/u/5185660?v=4" width="100px;" alt=""/><br /><sub><b>Jason Cooke</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=Jason-Cooke" title="Documentation">📖</a></td>237 <td align="center"><a href="https://github.com/bibo5088"><img src="https://avatars0.githubusercontent.com/u/17709887?v=4" width="100px;" alt=""/><br /><sub><b>bibo5088</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=bibo5088" title="Code">💻</a></td>238 <td align="center"><a href="https://codefund.io"><img src="https://avatars2.githubusercontent.com/u/12481?v=4" width="100px;" alt=""/><br /><sub><b>Eric Berry</b></sub></a><br /><a href="#fundingFinding-coderberry" title="Funding Finding">🔍</a></td>239 <td align="center"><a href="https://michaeldeboey.be"><img src="https://avatars3.githubusercontent.com/u/6643991?v=4" width="100px;" alt=""/><br /><sub><b>Michaël De Boey</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=MichaelDeBoey" title="Code">💻</a></td>240 </tr>241 <tr>242 <td align="center"><a href="https://github.com/lauriii"><img src="https://avatars0.githubusercontent.com/u/1845495?v=4" width="100px;" alt=""/><br /><sub><b>Lauri Eskola</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=lauriii" title="Documentation">📖</a></td>243 <td align="center"><a href="https://github.com/devuxer"><img src="https://avatars0.githubusercontent.com/u/1298521?v=4" width="100px;" alt=""/><br /><sub><b>devuxer</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=devuxer" title="Documentation">📖</a></td>244 <td align="center"><a href="https://github.com/dsbert"><img src="https://avatars2.githubusercontent.com/u/1320090?v=4" width="100px;" alt=""/><br /><sub><b>Daniel</b></sub></a><br /><a href="https://github.com/kentcdodds/cross-env/commits?author=dsbert" title="Documentation">📖</a></td>245 </tr>246</table>247 248<!-- markdownlint-enable -->249<!-- prettier-ignore-end -->250<!-- ALL-CONTRIBUTORS-LIST:END -->251 252This project follows the [all-contributors][all-contributors] specification.253Contributions of any kind welcome!254 255> Note: this was added late into the project. If you've contributed to this256> project in any way, please make a pull request to add yourself to the list by257> following the instructions in the `CONTRIBUTING.md`258 259## LICENSE260 261MIT262 263<!-- prettier-ignore-start -->264[npm]: https://npmjs.com265[node]: https://nodejs.org266[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/cross-env/validate?logo=github&style=flat-square267[build]: https://github.com/kentcdodds/cross-env/actions?query=workflow%3Avalidate268[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/cross-env.svg?style=flat-square269[coverage]: https://codecov.io/github/kentcdodds/cross-env270[version-badge]: https://img.shields.io/npm/v/gatsby-remark-embedder.svg?style=flat-square271[package]: https://www.npmjs.com/package/gatsby-remark-embedder272[downloads-badge]: https://img.shields.io/npm/dm/gatsby-remark-embedder.svg?style=flat-square273[npmtrends]: http://www.npmtrends.com/gatsby-remark-embedder274[license-badge]: https://img.shields.io/npm/l/gatsby-remark-embedder.svg?style=flat-square275[license]: https://github.com/kentcdodds/cross-env/blob/master/LICENSE276[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square277[prs]: http://makeapullrequest.com278[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square279[coc]: https://github.com/kentcdodds/cross-env/blob/master/other/CODE_OF_CONDUCT.md280[emojis]: https://allcontributors.org/docs/en/emoji-key281[all-contributors]: https://github.com/all-contributors/all-contributors282[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/cross-env?color=orange&style=flat-square283[bugs]: https://github.com/kentcdodds/cross-env/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+Bug%22+sort%3Acreated-desc284[good-first-issue]: https://github.com/kentcdodds/cross-env/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22good+first+issue%22285 286[angular-formly]: https://github.com/formly-js/angular-formly287[cross-spawn]: https://www.npmjs.com/package/cross-spawn288[malware]: http://blog.npmjs.org/post/163723642530/crossenv-malware-on-the-npm-registry289[ts-loader]: https://www.npmjs.com/package/ts-loader290[win-bash]: https://msdn.microsoft.com/en-us/commandline/wsl/about291<!-- prettier-ignore-end -->292