@mintlab/ui - npm Package Compare versions

Comparing version 0.13.0 to 0.14.0

package.json

 {
   "name": "@mintlab/ui",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "license": "EUPL-1.1",
@@ -10,3 +10,3 @@ "description": "Mintlab Preact UI components used in Zaaksysteem.",
   ],
-  "repository": "gitlab:grimpeur/zaaksysteem-ui",
+  "repository": "gitlab:zaaksysteem/npm-mintlab-ui.git",
   "main": "./distribution/ui.js",
@@ -45,7 +45,7 @@ "scripts": {
     "@mintlab/eslint-config-preact": "^0.1.0",
-    "@storybook/addon-actions": "^3.2.15",
-    "@storybook/addon-info": "^3.2.15",
-    "@storybook/addon-knobs": "^3.2.15",
-    "@storybook/addon-options": "^3.2.15",
-    "@storybook/react": "^3.2.15",
+    "@storybook/addon-actions": "^3.3.9",
+    "@storybook/addon-info": "^3.3.9",
+    "@storybook/addon-knobs": "^3.3.9",
+    "@storybook/addon-options": "^3.3.9",
+    "@storybook/react": "^3.3.9",
     "babel-loader": "^7.1.2",
@@ -56,2 +56,3 @@ "babel-plugin-transform-react-jsx": "^6.24.1",
     "base64-font-loader": "^0.0.4",
+    "chalk": "^2.3.0",
     "classnames": "^2.2.5",
@@ -63,3 +64,3 @@ "css-loader": "^0.28.7",
     "esdoc-standard-plugin": "^1.0.0",
-    "eslint": "^4.11.0",
+    "eslint": "~4.13",
     "eslint-loader": "^1.9.0",
@@ -71,3 +72,4 @@ "eslint-plugin-react": "^7.4.0",
     "jest": "^21.2.1",
-    "lodash.capitalize": "^4.2.1",
+    "lodash.camelcase": "^4.3.0",
+    "lodash.upperfirst": "^4.3.1",
     "material-components-web": "^0.25.0",
@@ -89,3 +91,3 @@ "node-sass": "^4.6.1",
     "storybook-addon-props": "^3.0.3",
-    "storybook-readme": "^3.1.1",
+    "storybook-readme": "^3.2.0",
     "style-loader": "^0.19.0",
@@ -92,0 +94,0 @@ "uglifyjs-webpack-plugin": "^1.0.0-rc.0",

README.md

@@ -5,2 +5,16 @@ # @mintlab/ui  [![npm version][npm-image]][npm-url]
 
+## Installation
+
+    yarn add @mintlab/ui
+
+## Usage
+
+    import {
+      Button,
+      Dialog,
+      // ...
+    } from '@mintlab/ui';
+
+## Contributing
+
 This repository has two different user roles:
@@ -13,3 +27,3 @@ 1. Developer
 
-## Starting the application
+### Starting the application
 
@@ -32,3 +46,3 @@ Run
 
-to install dependenecies and then
+to install dependencies and then
 
@@ -39,3 +53,3 @@ $ yarn start
 
-## Configuration and infrastructure documentation
+### Configuration and infrastructure documentation
 
@@ -48,3 +62,3 @@ - [Storybook](https://storybook.js.org/basics/introduction/)
 
-### Experimental: Documentation
+#### Experimental: Documentation
 
@@ -74,26 +88,21 @@ - [ESDoc](https://esdoc.org/)
 
-This should be discussed with the whole team.
+This needs discussion.
 
-## Publishing to the npm registry
+### Publishing to the npm registry
 
-- You need to be a member of the 
-  [@mintlbab](https://www.npmjs.com/org/mintlab)
-  organization with write privileges for the package.
-- Run `npm version (patch|minor|major)` to bump the version; never update the version field manually.
-    - This also creates a `git` tag. 
-- If you want to see what's beeing published, run `npm-pack` and inspect the tar ball.
-- Q: What *should* actually be published? 
-    - A: With the excpetions of the `README`, `LICENSE` and `package.json` files,
-      nothing that's under version control (cf. `.gitignore` and `.npmignore`):
-        - `distribution/ui.js` (`main` in `package.json`)
-        - `distribution/ui.css`  
-- Only publish with the `npm` CLI.
-- The build is a `prepublish` task so just run `npm publish --access public`.
+You need to be a member of the 
+[@mintlab](https://www.npmjs.com/org/mintlab)
+organization with write privileges for the package.
 
-##
+1. On the guest:
+    1. run `yarn build`
+2. On the host (**only publish with the `npm` CLI**):
+    1. run `npm version (patch|minor|major)` to bump the version (never update the version field manually)
+        - This also creates a `git` tag. 
+    2. (optional) run `npm pack` and inspect the tar ball if you want to see what's beeing published
+    3. run `npm publish --access public`
+    4. push the changes to the `git` remote
 
-- [Official Node.js Docker repository](https://hub.docker.com/_/node/)
+### FAQ
 
-## FAQ
-
 **Q: Why do I see so many peer dependency warnings about React when I install modules?**
@@ -108,8 +117,10 @@
 
-**Q: Why do I see both `yarn` and `npm` used in package.json scripts?**
+**Q: What *should* actually be published?**
 
-A: *Yarn* is used for managing dependencies in development, *npm* is only used for either
-- publishing to the registry
-- GitLab pipeline jobs (TODO: look into base images with yarn)
+A: With the excpetions of the `README`, `LICENSE` and `package.json` files,
+nothing that's under version control (cf. `.gitignore` and `.npmignore`):
 
+    - `distribution/ui.js` (`main` in `package.json`)
+    - `distribution/ui.css`  
+
 ## License
@@ -116,0 +127,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

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

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

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

Improved metrics

Number of lines in readme file

133

increased by9.02%

Worsened metrics

Total package byte prevSize

361375

decreased by-0.02%

Dev dependency count

51

increased by4.08%

No dependency changes