gridicons - npm Package Compare versions

Comparing version 2.1.3 to 2.2.0-alpha.1

CHANGELOG.md

 _The versioning refers to the React component build._
 
+#### v2.2.0 (2018-03-07)
+* Include untranspiled files in npm.
+
 #### v2.1.3 (2018-02-22)
@@ -4,0 +7,0 @@ * Icon added: "Shutter"

package.json

 {
   "name": "gridicons",
-  "version": "2.1.3",
-  "main": "build/index.js",
+  "version": "2.2.0-alpha.1",
+  "main": "cjs/index.js",
+  "esnext": "esm/index.js",
   "scripts": {
@@ -18,4 +19,4 @@ "build": "grunt --verbose",
   "files": [
-    "build/index.js",
-    "build/example.js"
+    "cjs/",
+    "esm/"
   ],
@@ -22,0 +23,0 @@ "dependencies": {

README.md

@@ -75,3 +75,3 @@ # Gridicons
 3. Check pixel sharpness: open in Illustrator (with "Pixel Preview") or Sketch (with "Show Pixels"), adjust if needed.
-4. Run `grunt` command from terminal. It will generate `svg-min`, React (`build`), `svg-sprite`, `pdf`, `php`, and `docs`.
+4. Run `grunt` command from terminal. It will generate `svg-min`, React (`esm` and `cjs`), `svg-sprite`, `pdf`, `php`, and `docs`.
 5. Commit
@@ -85,4 +85,4 @@ 6. Merge & delete branch
 
-Once you checkout the repo run `npm install` in the `gridicons` folder. 
-To generate all the fonts, svgs and so on you run `npm run build` 
+Once you checkout the repo run `npm install` in the `gridicons` folder.
+To generate all the fonts, svgs and so on you run `npm run build`
 
@@ -93,8 +93,8 @@ ## Publishing to npm
 
-1. Create a new PR with updated `CHANGELOG.md` and updated version in `package.json` (i.e. `1.2.3-alpha.1`), see an example [here](https://github.com/Automattic/gridicons/pull/275). 
-2. In the "CHANGELOG.md" make sure to check all the previous commits since the previous versioned release. 
+1. Create a new PR with updated `CHANGELOG.md` and updated version in `package.json` (i.e. `1.2.3-alpha.1`), see an example [here](https://github.com/Automattic/gridicons/pull/275).
+2. In the "CHANGELOG.md" make sure to check all the previous commits since the previous versioned release.
 3. Pre-publish that PR branch on npm with `npm publish --tag next` ([more info](https://docs.npmjs.com/cli/dist-tag)). Running the `npm publish --tag next` command will send the data that you have localy to npm. Having the alpha version in the `package.json` file will create a newly tagged version npm package. Use `npm view gridicons` to look at the list of current tags. You do not need to commit changes to github in order to publish to npm, but it is recommended so folks testing know what's available.
-4. Create a new update PR in a repository that makes use of Gridicons and run `npm install gridicons@next --save` (which will update `packages.json`). If you're creating the PR in [Calypso](https://github.com/Automattic/wp-calypso) and you get warnings, it might need to regenerate the shrinkwrap, in which case run `npm run update-deps`. See an example [here](https://github.com/Automattic/wp-calypso/pull/17601). 
+4. Create a new update PR in a repository that makes use of Gridicons and run `npm install gridicons@next --save` (which will update `packages.json`). If you're creating the PR in [Calypso](https://github.com/Automattic/wp-calypso) and you get warnings, it might need to regenerate the shrinkwrap, in which case run `npm run update-deps`. See an example [here](https://github.com/Automattic/wp-calypso/pull/17601).
 5. Test if the new icons show up, and there are no regressions in the previous icons. Take a look at the `http://calypso.localhost:3000/devdocs/design/gridicons` for example.
-6. If changes look good, remove the alpha postfix in the version (i.e. `1.2.3-alpha.1` to `1.2.3`) on both repositories PRs. 
+6. If changes look good, remove the alpha postfix in the version (i.e. `1.2.3-alpha.1` to `1.2.3`) on both repositories PRs.
 7. Merge the Gridicons PR.
@@ -112,9 +112,9 @@ 8. Tag the release on GitHub: `git tag -a v1.2.3 -m "Release v1.2.3"` (and push `git push origin v1.2.3`).
 You need to have a npm user account. [Create one here](https://www.npmjs.com/signup).
-Once you have created it, set up the account on you machine via 
+Once you have created it, set up the account on you machine via
 $ `npm adduser`
 
-Setup the 2fa with npm 
-$ `npm profile enable-2fa` 
+Setup the 2fa with npm
+$ `npm profile enable-2fa`
 
-Now everytime before you can publish 
+Now everytime before you can publish
 You will be asked for a your [2FA code (OPT)](https://en.wikipedia.org/wiki/One-time_password)

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

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

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

252150

increased by73.5%

Number of package files

8

increased by33.33%

Lines of code

1537

increased by237.8%

Worsened metrics

Number of low quality alerts

4

increased by33.33%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes