Npm starter

yangshun · yangshun · commit dea6d5931835 · 2016-10-21T12:51:11.000+08:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,10 @@
+{
+  "presets": ["es2015"],
+  "env": {
+    "commonjs": {
+      "plugins": [
+        ["transform-es2015-modules-commonjs", { "loose": true }]
+      ]
+    }
+  }
+}
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,38 @@
+module.exports = {
+  parser: 'babel-eslint',
+  root: true,
+  extends: [
+    'airbnb-base',
+    'plugin:flowtype/recommended',
+  ],
+  env: {
+    browser: true,
+    node: true,
+  },
+  globals: {
+    expect: true,
+    it: true,
+  },
+  plugins: [
+    'flowtype',
+    'import',
+  ],
+  settings: {
+    'import/resolver': {
+      webpack: {
+        config: 'webpack.config.js',
+      },
+    },
+  },
+  rules: {
+    'arrow-body-style': 'off',
+    'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
+    'max-len': ['error', 120],
+    'import/extensions': ['error', 'always',
+      {
+        js: 'never',
+      }
+    ],
+    'linebreak-style': 'off',
+  },
+};
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,8 @@ node_modules
 
 # Users Environment Variables
 .lock-wscript
+
+# Build
+es
+dist
+lib
diff --git a/.jestconfig b/.jestconfig
@@ -0,0 +1,15 @@
+{
+  "coverageDirectory": "coverage",
+  "moduleDirectories": ["node_modules"],
+  "moduleNameMapper": {
+     "^.+\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|bmp|ico|yml)$": "<rootDir>/__mocks__/fileMock.js",
+    "^.+\\.(css|scss)$": "<rootDir>/__mocks__/styleMock.js"
+  },
+  "modulePaths": [
+    "src"
+  ],
+  "collectCoverageFrom": [
+    "src/**/*.js"
+  ],
+  "testRegex": "(/__tests__/.*\\.test.js)$"
+}
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+6.6.0
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '6'
diff --git a/README.md b/README.md
@@ -1 +1,3 @@
-# nus-academic-calendar
+# NPM Starter
+
+Starter package for NPM modules in ES6.
diff --git a/__mocks__/fileMock.js b/__mocks__/fileMock.js
@@ -0,0 +1 @@
+module.exports = "test-file-stub";
diff --git a/__mocks__/styleMock.js b/__mocks__/styleMock.js
@@ -0,0 +1 @@
+module.exports = {};
diff --git a/__tests__/.eslintrc.js b/__tests__/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  env: {
+    jest: true,
+  }
+};
diff --git a/__tests__/add.test.js b/__tests__/add.test.js
@@ -0,0 +1,11 @@
+import add from '../src/add';
+
+describe('add', () => {
+  it('adds positive numbers correctly', () => {
+    expect(add(1, 2)).toBe(3);
+  });
+
+  it('adds negative numbers correctly', () => {
+    expect(add(-1, -2)).toBe(-3);
+  });
+});
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,13 @@
+'use strict';
+
+exports.__esModule = true;
+
+var _add = require('./add');
+
+var _add2 = _interopRequireDefault(_add);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+exports.default = {
+  add: _add2.default
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,62 @@
+{
+  "name": "npm-starter",
+  "version": "0.0.1",
+  "description": "Starter kit for npm modules in es6",
+  "main": "lib/index.js",
+  "module": "es/index.js",
+  "jsnext:main": "es/index.js",
+  "files": [
+    "dist",
+    "lib",
+    "es",
+    "src"
+  ],
+  "scripts": {
+    "clean": "rimraf lib dist es coverage",
+    "check": "npm run lint && npm run test",
+    "lint": "eslint src __tests__",
+    "build:commonjs": "cross-env BABEL_ENV=commonjs babel src --out-dir lib",
+    "build:es": "cross-env BABEL_ENV=es babel src --out-dir es",
+    "build:umd": "cross-env BABEL_ENV=commonjs NODE_ENV=development webpack src/index.js dist/npm-starter.js",
+    "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack src/index.js dist/npm-starter.min.js",
+    "build": "npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:umd:min",
+    "test": "cross-env BABEL_ENV=commonjs jest --config .jestconfig",
+    "test:cov": "npm test -- --coverage",
+    "test:watch": "npm test -- --watch",
+    "prepublish": "npm run clean && npm run check && npm run build --kill --print"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nusmodifications/npm-starter.git"
+  },
+  "keywords": [
+    "npm",
+    "starter",
+    "es6",
+    "commonjs",
+    "umd"
+  ],
+  "author": "NUSModifications",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nusmodifications/npm-starter/issues"
+  },
+  "homepage": "https://github.com/nusmodifications/npm-starter",
+  "npmName": "npm-starter",
+  "devDependencies": {
+    "babel-cli": "^6.16.0",
+    "babel-eslint": "^7.0.0",
+    "babel-jest": "^16.0.0",
+    "babel-loader": "^6.2.5",
+    "babel-plugin-transform-es2015-modules-commonjs": "^6.16.0",
+    "babel-preset-es2015": "^6.16.0",
+    "cross-env": "^3.1.3",
+    "eslint": "^3.8.0",
+    "eslint-config-airbnb-base": "^8.0.0",
+    "eslint-plugin-flowtype": "^2.20.0",
+    "eslint-plugin-import": "^2.0.1",
+    "jest": "^16.0.1",
+    "rimraf": "^2.5.4",
+    "webpack": "^1.13.2"
+  }
+}
diff --git a/src/add.js b/src/add.js
@@ -0,0 +1,5 @@
+function add(a, b) {
+  return a + b;
+}
+
+export default add;
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,5 @@
+import add from './add';
+
+export default {
+  add,
+};
diff --git a/webpack.config.js b/webpack.config.js
@@ -0,0 +1,52 @@
+'use strict';
+
+const webpack = require('webpack');
+
+const env = process.env.NODE_ENV;
+const config = {
+  resolve: {
+    root: ['lib'],
+    extensions: ['', '.js'],
+    moduleDirectories: ['node_modules'],
+  },
+  output: {
+    library: 'npm-starter',
+    libraryTarget: 'umd',
+  },
+  module: {
+    loaders: [
+      {
+        test: /\.js$/,
+        exclude: /node_modules/,
+        loader: 'babel',
+        query: {
+          cacheDirectory: true
+        },
+      },
+    ]
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      'process.env.NODE_ENV': JSON.stringify(env),
+    }),
+  ],
+};
+
+if (env === 'production') {
+  config.plugins.push(
+    new webpack.optimize.UglifyJsPlugin({
+      beautify: false,
+      comments: false,
+      compress: {
+        warnings: false,
+        drop_console: true,
+      },
+      mangle: {
+        screw_ie8 : true,
+        keep_fnames: true,
+      },
+    })
+  );
+}
+
+module.exports = config;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+language: node_js`
	`2`	`+node_js:`
	`3`	`+ - '6'`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +module.exports = {
 +  env: {
 +    jest: true,
 +  }
 +};