https://github.com/ksxnodeapps/package-alt-yaml
Use package.yaml instead of package.json
https://github.com/ksxnodeapps/package-alt-yaml
Last synced: over 1 year ago
JSON representation
Use package.yaml instead of package.json
- Host: GitHub
- URL: https://github.com/ksxnodeapps/package-alt-yaml
- Owner: ksxnodeapps
- License: mit
- Created: 2017-04-13T05:41:57.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-05T12:43:33.000Z (about 8 years ago)
- Last Synced: 2025-02-06T16:11:55.573Z (over 1 year ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# package-alt-yaml
Use `package.yaml` instead of `package.json`
## Requirements
* Node.js ≥ 6.0.0 and npm
## Installation
```bash
npm install --global package-alt-yaml
```
## Command-line usage
Replace `npm` with the following commands
### `npm-yaml`, `ynpm`, `npm-yaml-update`, `ynpm-update`
Invoke npm command and update `package.yaml` if necessary
```bash
ynpm [argv]
```
**Example**
```bash
ynpm install --save [package] # Would update package.yaml
ynpm install [package] # Won't update package.yaml
```
### `npm-yaml-preserve`, `ynpm-preserve`
Invoke npm command but preserve `package.yaml`
```bash
ynpm-preserve [argv]
```
**Example**
```bash
ynpm-preserve install [package] # Won't update package.yaml
ynpm-preserve install --save [package] # Won't update package.yaml
```
### Notes
#### `ynpm init`
This program doesn't read data from stdin therefore `ynpm init` won't work.
In order to init a "ynpm package", do the following instead:
```bash
npm i -g js-yaml # CLI to convert json to yaml
npm init # Now you have a package.json
js-yaml package.json > package.yaml # Now you have a package.yaml
```
#### `package.yml`
This program works only with package.yaml,
not package.yml.
## Development
### Requirements
* Node.js ≥ 6.0.0 and npm
* package-alt-yaml
### Preparation
```bash
npm install --global package-alt-yaml
```
### Test
```bash
ynpm test
```
## License
[MIT License](https://github.com/ksxnodeapps/package-alt-yaml/blob/master/LICENSE.md)