Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scaffoldly/ngx-scripts
:wrench: Support scripts for ngX-Rocket projects
https://github.com/scaffoldly/ngx-scripts
Last synced: about 1 month ago
JSON representation
:wrench: Support scripts for ngX-Rocket projects
- Host: GitHub
- URL: https://github.com/scaffoldly/ngx-scripts
- Owner: scaffoldly
- License: mit
- Fork: true (ngx-rocket/scripts)
- Created: 2021-02-11T16:45:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-11T13:48:20.000Z (over 2 years ago)
- Last Synced: 2024-03-23T16:02:36.290Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 908 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# :rocket: ngx-rocket/scripts
[](https://www.npmjs.com/package/@ngx-rocket/scripts)
[](https://github.com/ngx-rocket/scripts/actions)
[](https://github.com/sindresorhus/xo)
[](LICENSE)
> Support scripts for ngX-Rocket projects.
In order to simplify the workflow of applications generated with
[ngX-Rocket generator](https://github.com/ngx-rocket/generator-ngx-rocket), we made this repo to gather all additional
scripts and build tools.
Since this module is an independant package, you can even use for projects not built from ngX-Rocket if you find it
useful.
## Installation
```bash
npm install --save @ngx-rocket/scripts
```
## Usage
This modules provides CLI commands to be used in [NPM scripts](https://docs.npmjs.com/misc/scripts), along with some
[Cordova hooks](https://cordova.apache.org/docs/en/latest/guide/appdev/hooks/) (see `hooks` folder).
### Export environment variables to a JSON or JavaScript file
`ngx-scripts env [ ...] [--out ] [--format json|js] [--parseJson]`
Default output file is `src/environments/.env.ts` with JavaScript format.
### Execute Cordova commands
`ngx-scripts cordova [options] [-- ]`
Unless the `--fast` option is provided, the Angular app is rebuilt before executing the command, using `npm run build`.
Any accepted Cordova option can be passed through after `--`.
#### Options
- `--app`: The name of the Angular app to build. Only useful if you have a workspace with multiples apps.
- `--fast`: Skip Angular app rebuild
- `--base-href `: Change application base URL (default is `./`)
- `--copy `: Copy built apps to the specified path (only works with `cordova build`)
- `--dev`: Build Angular app in `dev` mode (default is `prod`)
- `-c, --configuration `: Target Angular CLI configuration for `npm run build`
- `--device`: Deploy Cordova build to a device
- `--emulate`: Deploy Cordova build to an emulator
- `--debug`: Create a Cordova debug build
- `--release`: Create a Cordova release build
- `--verbose`: Show Cordova debug output
- `--yarn`: Use [Yarn](https://yarnpkg.com) instead of NPM to run the `build` script
- `--parseJson`: During `env`, if an environment variable's value is parsable JSON, it will be a proper object in `.env.ts`
> Note: Yarn is automatically used instead of NPM is the environment variable `NGX_PACKAGE_MANAGER` is set to `yarn` or
> if the current project was generated with ngX-Rocket using Yarn option (option is saved in `.yo-rc.json`).
#### Examples
```bash
ngx-scripts cordova prepare
ngx-scripts cordova run ios --dev --debug --emulate
ngx-scripts cordova build ios --configuration production --device --release -- --developmentTeam="ABCD" --provisioningProfile="UUID"
````
### Clean Cordova (`platforms`, `plugins`) and dist folders
`clean [--cordova] [--dist] [--path ]`
#### Options
- `--cordova`: Remove only Cordova folders
- `--dist`: Remove only dist folder
- `--path `: Remove only specified path
# License
[MIT](LICENSE)