generator-badge - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
-    "name": "generator-badge",
-    "version": "0.0.0",
-    "description": "Generate badges for your readme",
-    "main": "index.js",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "generate",
-        "badge",
-        "badges",
-        "readme",
-        "markdown",
-        "node",
-        "npm"
-    ],
-    "author": "Tan Li Hau <[e-mail]>",
-    "license": "MIT"
-}
+  "name": "generator-badge",
+  "version": "1.0.0",
+  "description": "Generate badges for your readme",
+  "main": "index.js",
+  "bin": {
+    "badge": "./lib/cli.js"
+  },
+  "preferGlobal": true,
+  "scripts": {
+    "test": "jasmine-node spec/"
+  },
+  "keywords": [
+    "generate",
+    "badge",
+    "badges",
+    "readme",
+    "markdown",
+    "node",
+    "npm"
+  ],
+  "author": "Tan Li Hau <[e-mail]>",
+  "license": "MIT",
+  "dependencies": {
+    "arrify": "^1.0.1",
+    "bluebird": "^3.3.5",
+    "chalk": "^1.1.3",
+    "configstore": "^2.0.0",
+    "find-up": "^1.1.2",
+    "git-branch": "^0.3.0",
+    "git-repo-name": "^0.5.1",
+    "git-username": "^0.4.0",
+    "github-repo-url": "^0.2.1",
+    "inquirer": "^1.0.2",
+    "lodash": "^4.11.1",
+    "meow": "^3.7.0",
+    "read-pkg-up": "^1.0.1",
+    "repeating": "^2.0.1",
+    "through2": "^2.0.1",
+    "trim-newlines": "^1.0.0"
+  },
+  "devDependencies": {
+    "jasmine-node": "^1.14.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tanhauhau/generator-badge.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tanhauhau/generator-badge/issues"
+  },
+  "homepage": "https://github.com/tanhauhau/generator-badge#readme"
+}

README.md

 # generator-badge
 
-[![npm version](https://badge.fury.io/js/generator-badge.svg)](https://badge.fury.io/js/generator-badge)
+<!-- badge -->
+[![travis status](https://img.shields.io/travis/tanhauhau/generator-badge.svg)](https://travis-ci.org/tanhauhau/generator-badge)
+[![npm version](https://img.shields.io/npm/v/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)
+[![npm license](https://img.shields.io/npm/l/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)
+[![npm download](https://img.shields.io/npm/dm/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)
+[![npm download](https://img.shields.io/npm/dt/generator-badge.svg)](https://www.npmjs.com/package/generator-badge)
+[![david dependency](https://img.shields.io/david/tanhauhau/generator-badge.svg)]()
+[![david dev-dependency](https://img.shields.io/david/dev/tanhauhau/generator-badge.svg)]()
 
+<!-- endbadge -->
+
 > Generate badges for your readme
@@ -10,9 +19,95 @@
 ```bash
-$ npm install --save generator-badge
+$ npm install --save --global generator-badge
 ```
 
+## Example
+
+**BEFORE**
+
+README.md:
+
+```markdown
+# MY-AWESOME-PROJECT
+<!-- badge -->
+<!-- endbadge -->
+```
+
+**THEN YOU DO**
+
+Terminal:
+
+```bash
+awesome-project$ badge install travis npm-version
+```
+
+**WHAT YOU GET**
+
+README.md:
+
+```markdown
+# MY-AWESOME-PROJECT
+<!-- badge -->
+[![travis](https://img.shields.io/travis/tanhauhau/awesome-project.svg)](https://travis-ci.org/tanhauhau/awesome-project)
+[![npm-version](https://img.shields.io/npm/v/awesome-project.svg)](https://www.npmjs.com/package/awesome-project)
+<!-- endbadge -->
+```
+
 ## Usage
 
+**Install badges**
 
+```bash
+$ badge install <badges> [<args>]
+```
 
+You can specify required field values into arguments:
+
+```bash
+$ badge install travis --repo-username=tanhauhau --repo-name=awesome-project
+```
+
+For field values that is missing, `badge` will prompt you to enter.
+
+```bash
+$ badge install travis
+  Inferring information needed...
+  ? repo-username: tanhauhau
+  ? repo-name: awesome-project
+  Preparing the badges...
+  Looking for README...
+  Injecting badges into README...
+  Done :)
+```
+
+**List of all badges available**
+
+```bash
+$ badge list
+```
+
+**Help**
+
+```bash
+$ badge help <badge>
+$ badge help travis
+ travis-default
+ Build apps with confidence.
+ Description : Travis build status of master branch
+ Fields      : repo-username, repo-name
+```
+
+## Todo List
+
+- [ ] Find README of various format: markdown, textile, rdoc, rst, pod, html
+- [ ] Inferring git, svn repo information
+- [ ] Storing global preferences, eg: able to remember author name in global
+- [ ] Storing local preferences, eg: able to remember repo info in local package
+- [ ] Filename as argument
+- [ ] [More badges available](https://github.com/tanhauhau/generator-badge/blob/master/doc/list.md)
+
+## Badge credits to
+
+[![shields.io](http://shields.io/logo.svg)](http://shields.io)
+
+
 ## Contributing
@@ -19,0 +114,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39577

increased by1782.83%

Number of package files

24

increased by300%

Lines of code

804

increased byInfinity%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

122

increased by351.85%

Worsened metrics

Dependency count

16

increased byInfinity%

Dev dependency count

1

increased byInfinity%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Addedarrify@^1.0.1

• + Addedbluebird@^3.3.5

• + Addedchalk@^1.1.3

• + Addedconfigstore@^2.0.0

• + Addedfind-up@^1.1.2

• + Addedgit-branch@^0.3.0

• + Addedgit-repo-name@^0.5.1

• + Addedgit-username@^0.4.0

• + Addedgithub-repo-url@^0.2.1

• + Addedinquirer@^1.0.2

• + Addedlodash@^4.11.1

• + Addedmeow@^3.7.0

• + Addedread-pkg-up@^1.0.1

• + Addedrepeating@^2.0.1

• + Addedthrough2@^2.0.1

• + Addedtrim-newlines@^1.0.0

• + Addedansi-escapes@1.4.0(transitive)

• + Addedansi-regex@2.1.1(transitive)

• + Addedansi-styles@1.0.02.2.1(transitive)

• + Addedarray-find-index@1.0.2(transitive)

• + Addedarrify@1.0.1(transitive)

• + Addedbluebird@3.7.2(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedcamelcase@2.1.1(transitive)

• + Addedcamelcase-keys@2.1.0(transitive)

• + Addedchalk@0.4.01.1.3(transitive)

• + Addedcli-cursor@1.0.2(transitive)

• + Addedcli-width@2.2.1(transitive)

• + Addedcode-point-at@1.1.0(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedconfigstore@2.1.0(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addedcurrently-unhandled@0.4.1(transitive)

• + Addedcwd@0.9.1(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addeddot-prop@3.0.0(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedexit-hook@1.1.1(transitive)

• + Addedexpand-tilde@1.2.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedexternal-editor@1.1.1(transitive)

• + Addedfigures@1.7.0(transitive)

• + Addedfile-name@0.1.0(transitive)

• + Addedfind-file-up@0.1.3(transitive)

• + Addedfind-pkg@0.1.2(transitive)

• + Addedfind-up@1.1.2(transitive)

• + Addedfindup-sync@0.1.3(transitive)

• + Addedfs-exists-sync@0.1.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-stdin@4.0.1(transitive)

• + Addedgit-branch@0.3.0(transitive)

• + Addedgit-repo-name@0.5.1(transitive)

• + Addedgit-username@0.4.0(transitive)

• + Addedgithub-repo-url@0.2.1(transitive)

• + Addedgithub-url-from-git@1.1.1(transitive)

• + Addedglob@3.2.11(transitive)

• + Addedglobal-modules@0.2.3(transitive)

• + Addedglobal-prefix@0.1.5(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedhas-color@0.1.7(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhomedir-polyfill@1.0.3(transitive)

• + Addedhosted-git-info@2.8.9(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedindent-string@2.1.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedini@1.1.01.3.8(transitive)

• + Addedinquirer@1.2.3(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-core-module@2.15.1(transitive)

• + Addedis-finite@1.1.0(transitive)

• + Addedis-fullwidth-code-point@1.0.0(transitive)

• + Addedis-obj@1.0.1(transitive)

• + Addedis-utf8@0.2.1(transitive)

• + Addedis-windows@0.2.0(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedlazy-cache@0.2.7(transitive)

• + Addedload-json-file@1.1.0(transitive)

• + Addedlodash@2.4.24.17.21(transitive)

• + Addedloud-rejection@1.6.0(transitive)

• + Addedlru-cache@2.7.3(transitive)

• + Addedmap-obj@1.0.1(transitive)

• + Addedmeow@3.7.0(transitive)

• + Addedminimatch@0.3.0(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedmute-stream@0.0.6(transitive)

• + Addednormalize-package-data@2.5.0(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedonetime@1.1.0(transitive)

• + Addedos-homedir@1.0.2(transitive)

• + Addedos-shim@0.1.3(transitive)

• + Addedos-tmpdir@1.0.2(transitive)

• + Addedosenv@0.1.5(transitive)

• + Addedparse-git-config@0.2.0(transitive)

• + Addedparse-json@2.2.0(transitive)

• + Addedparse-passwd@1.0.0(transitive)

• + Addedpath-exists@2.1.0(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-type@1.1.0(transitive)

• + Addedpify@2.3.0(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedread-pkg@1.1.0(transitive)

• + Addedread-pkg-up@1.0.1(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedredent@1.0.0(transitive)

• + Addedremote-origin-url@0.2.10.4.0(transitive)

• + Addedrepeating@2.0.1(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedresolve-dir@0.1.1(transitive)

• + Addedrestore-cursor@1.0.1(transitive)

• + Addedrun-async@2.4.1(transitive)

• + Addedrx@4.1.0(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsemver@5.7.2(transitive)

• + Addedsigmund@1.0.1(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedslide@1.1.6(transitive)

• + Addedspawn-sync@1.0.15(transitive)

• + Addedspdx-correct@3.2.0(transitive)

• + Addedspdx-exceptions@2.5.0(transitive)

• + Addedspdx-expression-parse@3.0.1(transitive)

• + Addedspdx-license-ids@3.0.20(transitive)

• + Addedstring-width@1.0.2(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedstrip-ansi@0.1.13.0.1(transitive)

• + Addedstrip-bom@2.0.0(transitive)

• + Addedstrip-indent@1.0.1(transitive)

• + Addedsupports-color@2.0.0(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedthrough2@2.0.5(transitive)

• + Addedtmp@0.0.29(transitive)

• + Addedtrim-newlines@1.0.0(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addeduuid@2.0.3(transitive)

• + Addedvalidate-npm-package-license@3.0.4(transitive)

• + Addedverbalize@0.1.2(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwrite-file-atomic@1.3.4(transitive)

• + Addedxdg-basedir@2.0.0(transitive)

• + Addedxtend@4.0.2(transitive)