Merge pull request #47 from FormidableLabs/add-contribution-guide-scripts

Add contribution guide scripts

Author: stefvhuynh

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+
+node_js:
+  - "4"
+  - "6"
+  - "8"
+
+branches:
+  only:
+    - master
+
+script:
+  - npm run lint
+  - npm run build
+  - npm run umd

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+Thanks for contributing!
+
+## Development
+
+### Installing dependencies
+
+```bash
+npm install
+```
+
+### Demo
+
+You can run the demo locally by simply doing `npm start`; this will start the demo at `http://localhost:3000`.
+
+### Linting
+
+Before commiting any changes, be sure to do `npm run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make. You can also run `npm run lint-fix` to fix most common lint errors automatically.
+
+## Releasing a new version to NPM (only for project administrators):
+
+1. Run `npm version patch` (or `minor`, `major` as appropriate) to lint and build the `lib` and `umd` directories.
+2. Run `npm publish` and publish to NPM if all is well.
+3. Run `git push && git push --tags`

package.json

@@ -12,12 +12,16 @@
     "start": "webpack-dev-server --hot --inline --port 3000 --config webpack.config.dev.js --content-base demo/",
     "build": "babel src -d lib --copy-files",
     "clean": "rimraf dist",
+    "clean-build": "rimraf lib",
     "clean-umd": "rimraf umd",
     "copy-assets": "cp -a demo/assets/. dist/assets",
     "copy-html-css": "cp -a demo/index.html dist/index.html && cp -a demo/index.css dist/index.css",
     "dist": "npm run clean && webpack && npm run copy-assets && npm run copy-html-css",
-    "lint": "eslint src demo --fix",
-    "umd": "npm run clean-umd && webpack --config webpack.config.umd.js"
+    "lint": "eslint src demo",
+    "lint-fix": "eslint src demo --fix",
+    "umd": "npm run clean-umd && webpack --config webpack.config.umd.js",
+    "preversion": "npm run lint",
+    "version": "npm run clean-build && npm run build && npm run umd"
   },
   "author": "Ken Wheeler",
   "license": "MIT",
@@ -48,9 +52,10 @@
     "postcss-loader": "^2.0.6",
     "prop-types": "^15.5.10",
     "raw-loader": "^0.5.1",
-    "react": "^16.0.0",
-    "react-dom": "^16.0.0",
+    "react": "16.0.0",
+    "react-dom": "16.0.0",
     "react-hot-loader": "^3.0.0-beta.2",
+    "react-native": "0.50.4",
     "rimraf": "^2.5.4",
     "style-loader": "^0.19.0",
     "webpack": "^3.6.0",

src/components/body.js

@@ -79,14 +79,14 @@ export default class Body extends Component {
   constructor(props, context) {
     super(props);
 
-    const { args, children, shape, ...options } = props;
+    const { args, children, shape, ...options } = props; // eslint-disable-line no-unused-vars
 
     this.body = Bodies[shape](...args, options);
     World.addBody(context.engine.world, this.body);
   }
 
   componentWillReceiveProps(nextProps) {
-    const { args, children, shape, ...options } = nextProps;
+    const { args, children, shape, ...options } = nextProps; // eslint-disable-line no-unused-vars
 
     Object.keys(options).forEach((option) => {
       if (option in this.body && this.props[option] !== nextProps[option]) {

src/native/components/body.js

@@ -79,14 +79,14 @@ export default class Body extends Component {
   constructor(props, context) {
     super(props);
 
-    const { args, children, shape, ...options } = props;
+    const { args, children, shape, ...options } = props; // eslint-disable-line no-unused-vars
 
     this.body = Bodies[shape](...args, options);
     World.addBody(context.engine.world, this.body);
   }
 
   componentWillReceiveProps(nextProps) {
-    const { args, children, shape, ...options } = nextProps;
+    const { args, children, shape, ...options } = nextProps; // eslint-disable-line no-unused-vars
 
     Object.keys(options).forEach((option) => {
       if (option in this.body && this.props[option] !== nextProps[option]) {

src/native/components/loop.js

@@ -40,7 +40,7 @@ export default class Loop extends Component {
 
   render() {
     const defaultStyles = {
-      flex: 1
+      flex: 1,
     };
     const styles = { ...defaultStyles, ...this.props.style };
     return (

src/native/components/sprite.js

@@ -111,8 +111,8 @@ export default class Sprite extends Component {
       position: 'absolute',
       transform: [
         { translateX: left * -1 },
-        { translateY: top * -1 }
-      ]
+        { translateY: top * -1 },
+      ],
     };
   }
 
@@ -123,7 +123,7 @@ export default class Sprite extends Component {
       width: this.props.tileWidth,
       overflow: 'hidden',
       position: 'relative',
-      transform: [{scale: scale}]
+      transform: [{ scale }],
     };
   }
 

src/native/components/stage.js

@@ -70,7 +70,7 @@ export default class Stage extends Component {
 
   getWrapperStyles() {
     return {
-      flex: 1
+      flex: 1,
     };
   }
 

src/native/components/tile-map.js

@@ -8,10 +8,10 @@ export default class TileMap extends Component {
   static propTypes = {
     columns: PropTypes.number,
     layers: PropTypes.array,
-    sourceWidth: PropTypes.number.isRequired,
     renderTile: PropTypes.func,
     rows: PropTypes.number,
     scale: PropTypes.number,
+    sourceWidth: PropTypes.number.isRequired,
     src: PropTypes.number,
     style: PropTypes.object,
     tileSize: PropTypes.number,
@@ -117,7 +117,7 @@ export default class TileMap extends Component {
       overflow: 'hidden',
       position: 'absolute',
       top,
-      left: left,
+      left,
     };
   }
 

src/native/components/world.js

@@ -1,9 +1,9 @@
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 
-import {View} from 'react-native';
+import { View } from 'react-native';
 
-import Matter, {Engine, Events} from 'matter-js';
+import Matter, { Engine, Events } from 'matter-js';
 
 export default class World extends Component {
   static propTypes = {
@@ -54,15 +54,15 @@ export default class World extends Component {
     this.loopID = null;
     this.lastTime = null;
 
-    const world = Matter.World.create({gravity: props.gravity});
+    const world = Matter.World.create({ gravity: props.gravity });
 
     this.engine = Engine.create({
       world,
     });
   }
 
   componentWillReceiveProps(nextProps) {
-    const {gravity} = nextProps;
+    const { gravity } = nextProps;
 
     if (gravity !== this.props.gravity) {
       this.engine.world.gravity = gravity;