kuali-ui - npm Package Compare versions

Comparing version 2.0.6 to 2.0.8

package.json

 {
   "name": "kuali-ui",
-  "version": "2.0.6",
-  "license": "MIT",
-  "private": false,
+  "version": "2.0.8",
+  "description": "Boilerplate for creating React Npm packages with ES2015",
   "repository": {
     "type": "git",
     "url": "https://github.com/KualiCo/kuali-ui.git"
+  },
+  "author": "Matt Newman",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/KualiCo/kuali-ui/issues"
+  },
+  "homepage": "https://github.com/KualiCo/kuali-ui",
+  "keywords": [
+    "react-component",
+    "react"
+  ],
+  "options": {
+    "mocha": "--require scripts/mocha_runner src/**/__tests__/**/*.js"
+  },
+  "scripts": {
+    "prepublish": "babel --plugins 'transform-es2015-modules-umd' src --ignore __tests__ --out-dir ./dist",
+    "lint": "eslint ./src",
+    "lintfix": "eslint ./src --fix",
+    "testonly": "mocha $npm_package_options_mocha",
+    "test": "npm run lint && npm run testonly",
+    "test-watch": "npm run testonly -- --watch --watch-extensions js"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.6.4",
+    "babel-core": "^6.7.4",
+    "babel-eslint": "^6.0.2",
+    "babel-plugin-transform-es2015-modules-umd": "^6.6.5",
+    "babel-polyfill": "^6.7.4",
+    "babel-preset-es2015": "^6.6.0",
+    "babel-preset-react": "^6.5.0",
+    "babel-preset-stage-2": "^6.5.0",
+    "chai": "^3.5.0",
+    "enzyme": "^2.2.0",
+    "eslint": "^2.7.0",
+    "eslint-plugin-babel": "^3.1.0",
+    "eslint-plugin-react": "^4.2.3",
+    "jsdom": "^8.1.0",
+    "mocha": "^2.4.5",
+    "nodemon": "^1.9.1",
+    "react-addons-test-utils": "^15.0.0",
+    "react": "^15.0.0",
+    "react-dom": "^15.0.0",
+    "sinon": "^1.17.3"
+  },
+  "peerDependencies": {
+    "react": "~0.14.8 || ^15.0.0",
+    "react-dom": "~0.14.8 || ^15.0.0"
+  },
+  "dependencies": {
+    "babel-runtime": "^6.6.1"
   }
 }

README.md

@@ -1,34 +0,28 @@
-## Kuali UI
+# Boilerplate for creating React Npm packages with ES2015
 
-This is kuali-ui, which is shared components used in Kuali projects.  It is based on material-ui, but with added styling, grid components, etc. for Kuali's uses.
+The package is based on [npm-base](https://github.com/kadirahq/npm-base) package by [Kadira](https://github.com/kadirahq) which is really great when you want to prepare Npm package. This one is prepared to be used as a starter point for React components which needs to be published on Npm.
 
-To use in your project do:
-```
-npm install kuali-ui --save
-```
+It includes linting with [ESLint](http://eslint.org/) and testing with [Mocha](https://mochajs.org/), [Enzyme](http://airbnb.io/enzyme/) and [JSDOM](https://github.com/tmpvar/jsdom).
 
-Then
-```
-import {KualiTextField} from 'kuali-ui'
+Also there is of course ES6 transpilation.
 
-export default class App extends Component {
+## Usage
 
-  constructor(props) {
-    super(props)
-    this.state = {
-      value: 3,
-      open: false
-    }
-  }
+1. Clone this repo
+2. Inside cloned repo run `npm install`
+3. If you want to run tests: `npm test` or `npm run testonly` or `npm run test-watch`. You need to write tests in `__tests__` folder. You need at least Node 4 on your machine to run tests.
+4. If you want to run linting: `npm test` or `npm run lint`. Fix bugs: `npm run lint-fix`. You can adjust your `.eslintrc` config file.
+5. If you want to run transpilation to ES5 in `dist` folder: `npm run prepublish` (standard npm hook).
 
-  render() {
-    return (
-      <MuiThemeProvider>
-        <KualiTextField
-          floatingLabelText="Value"
-          floatingLabelFixed={false} />
-      </MuiThemeProvider>
-    )
-  }
-}
-```
+## Blog post about it:
+
+- [Creating React NPM packages with ES2015](http://julian.io/creating-react-npm-packages-with-es2015/)
+
+## Also check out
+
+- [React Alert UI component](https://github.com/juliancwirko/react-s-alert)
+- [React project boilerplate with Webpack, HMR, React Router](https://github.com/juliancwirko/react-boilerplate)
+
+## License
+
+MIT

New alerts

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

Fixed alerts

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

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 website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11116

increased by31.15%

Number of low maintenance alerts

2

decreased by-33.33%

Worsened metrics

Dependency count

3

increased byInfinity%

Dev dependency count

20

increased byInfinity%

Number of package files

9

decreased by-25%

Lines of code

171

decreased by-32.94%

Number of lines in readme file

29

decreased by-17.14%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbabel-runtime@^6.6.1

• + Addedasap@2.0.6(transitive)

• + Addedbabel-runtime@6.26.0(transitive)

• + Addedcore-js@1.2.72.6.12(transitive)

• + Addedcreate-react-class@15.7.0(transitive)

• + Addedencoding@0.1.13(transitive)

• + Addedfbjs@0.8.18(transitive)

• + Addediconv-lite@0.6.3(transitive)

• + Addedis-stream@1.1.0(transitive)

• + Addedisomorphic-fetch@2.2.1(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addednode-fetch@1.7.3(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedpromise@7.3.1(transitive)

• + Addedprop-types@15.8.1(transitive)

• + Addedreact@15.7.0(transitive)

• + Addedreact-dom@15.7.0(transitive)

• + Addedreact-is@16.13.1(transitive)

• + Addedregenerator-runtime@0.11.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsetimmediate@1.0.5(transitive)

• + Addedua-parser-js@0.7.40(transitive)

• + Addedwhatwg-fetch@3.6.20(transitive)