https://github.com/abranhe/init-pkg-json-cli
CLI generator of .editorconfig 🐭
https://github.com/abranhe/init-pkg-json-cli
cli init init-pkg-json initers packge-json pkg-json
Last synced: about 1 month ago
JSON representation
CLI generator of .editorconfig 🐭
- Host: GitHub
- URL: https://github.com/abranhe/init-pkg-json-cli
- Owner: abranhe
- License: mit
- Created: 2018-08-18T04:28:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-18T04:29:20.000Z (almost 8 years ago)
- Last Synced: 2025-08-09T08:40:49.954Z (10 months ago)
- Topics: cli, init, init-pkg-json, initers, packge-json, pkg-json
- Language: JavaScript
- Homepage: https://npm.im/init-pkg-json-cli
- Size: 3.91 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
init-editorconfig-cli
: Cli generator of .editorconfig 🐭
# Install
```
npm install init-gitignore-cli
```
# Cli
```console
Usage
$ init-pkg-json
Options
--docs Read online documentation
-h, --help Show this help message and close
-v, --version Show packge version
-f, --feedback Send a feedback
--indentation Set package.json indentaion
-n, --name Add name to packge.json: required *
--pkg-version Add version to packge.json: required *
-d, --description Add description to packge.json
-k, --keywords Add keywords to packge.json
-l, --license Add license to packge.json
-r, --repository Add repository url link to the packge.json
-h, --home Add homepage link to packge.json
-b, --bugs Add bugs link to packge.json
-a, --author Add author to packge.json
--files Add files to packge.json
-m, --main Add primary entry point file
--bin Executable files included with your project that will be installed
-s, --scripts For now, pass an object as script (pass an object)
--dependencies Add dependencies (pass an object)
--dev-dep Add dev dependencies (pass an object)
-e, --engines The engines specify versions of clients that must be used with your package
Example
$ init-pkg-json -n "pkg-name" --pkg-version "1.0.0" -d "My amazing pkg"
```
# Example
> This is a big example 😅 : I'll be creating an interactive CLI for this module soon!
```
$ init-pkg-json -n "pkg-n" --pkg-version 1.0.3 -d "great-pkg" -k "pkg amazing" -l "MIT" -b https://github.com/u/r/issues -h https://yourpkg.org -r "https://gitub.com/u/p.git git" -a "Name email@d.com https://y.com" --files "filename.js dir/ glob/*.{js,json} test.js" --bin "command: bin/f.js, command1: index.js" -s "build-project: node build-project.js, test: test.js" --dependencies "pkg1: ^3.1.4" -e "node: >=4.4.7, yarn: ^0.14.0"
```
## Result in `package.json`
```json
{
"name": "pkg-n",
"version": "1.0.3",
"description": "great-pkg",
"keywords": [
"pkg",
"amazing"
],
"license": "MIT",
"homepage": "https://yourpkg.org",
"bugs": "https://github.com/u/r/issues",
"repository": {
"type": "git",
"url": "https://gitub.com/u/p.git"
},
"author": {
"name": "name",
"email": "email@d.com",
"url": "https://y.com"
},
"files": [
"filename.js",
"dir/",
"glob/*.{js,json}",
"test.js"
],
"bin": {
"command": "bin/f.js",
"command1": "index.js"
},
"scripts": {
"build-project": "nodebuild-project.js",
"test": "test.js"
},
"dependencies": {
"pkg1": "^3.1.4"
},
"engines": {
"node": ">=4.4.7",
"yarn": "^0.14.0"
}
}
```
# Related
- [init-editorconfig](https://github.com/abranhe/init-editorconfig): API for this module 🐭
- [init-gitignore](https://github.com/abranhe/init-gitignore): Because making git ignore files should be easier.
- [init-pkg-json](https://github.com/abranhe/init-pkg-json): 📦 Complex generator of Package.json.
# Team
|[](https://19cah.com)|
| :-: |
| [Carlos Abraham](https://github.com/abranhe) |
# License
[MIT](https://github.com/abranhe/init-editorconfig-cli/blob/master/LICENSE) License © [Carlos Abraham](https://github.com/abranhe/)