feat(init): updated using generator-node-mdl v4.1.0 🔥

config/webpack.config.js

@@ -1,15 +1,13 @@
 const path = require('path');
 
 const config = {
-  mode: 'production',
-  target: 'node',
-
   entry: path.resolve(__dirname, '../src/index.js'),
 
   output: {
     path: path.resolve(__dirname, '../dist'),
     filename: 'index.js',
     library: 'node-mdl-starter',
+    globalObject: 'this',
     libraryTarget: 'umd',
   },
 

contributing.md

@@ -37,11 +37,13 @@ Build the project:
 ```sh
 yarn build
 # only build the dist folder from source
-yarn build:babel
+yarn webpack:build
+# build webpack with a development mode and watch files
+yarn webpack:develop
 # only build the docs using esdocs
-yarn build:docs
+yarn docs:build
 # build docs in watch mode
-yarn develop:docs
+yarn docs:develop
 ```
 
 Run linter to validate the project code:

package.json

@@ -14,10 +14,11 @@
   },
   "scripts": {
     "prebuild": "rimraf dist",
-    "build": "yarn build:webpack && yarn build:docs",
-    "build:webpack": "webpack --config ./config/webpack.config.js",
-    "build:docs": "esdoc -c ./config/esdoc.config.js",
-    "develop:docs": "watch \"yarn build:docs\" . --ignoreDirectoryPattern='/node_modules|docs|dist|coverage|.git|.nyc*./'",
+    "build": "yarn webpack:build && yarn docs:build",
+    "webpack:build": "webpack --mode production --config ./config/webpack.config.js",
+    "webpack:develop": "webpack --mode development --watch --watch-poll --config ./config/webpack.config.js",
+    "docs:build": "esdoc -c ./config/esdoc.config.js",
+    "docs:develop": "watch \"yarn docs:build\" . --ignoreDirectoryPattern='/node_modules|docs|dist|coverage|.git|.nyc*./'",
     "test:watch": "jest --config ./config/jest.config.js --watch",
     "test": "jest --config ./config/jest.config.js --coverage",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",

readme.md

@@ -32,6 +32,37 @@ nodeMdlStarter('some text');
 //=> some text
 ```
 
+## Usage
+
+```js
+import nodeMdlStarter, { isEven, isOdd } from 'node-mdl-starter';
+
+nodeMdlStarter('some text');
+//=> some text
+
+isEven(8);
+//=> true
+isEven(9);
+//=> false
+isOdd(8);
+//=> false
+isOdd(9);
+//=> true
+```
+
+If you are not able to use `es-modules`, you can use `require` instead of `import`
+```js
+const { default: nodeMdlStarter, isEven, isOdd } = require('node-mdl-starter');
+```
+
+To use it directly inside a browser, load it via a script `tag`:
+```html
+<script type="text/javascript" src="./node_modules/node-mdl-starter/dist/index.js"></script>
+<script type="text/javascript">
+  const { default: nodeMdlStarter, isEven, isOdd } = window['node-mdl-starter'];
+</script>
+```
+
 ## Related
 
 // TODO

src/index.js

@@ -6,8 +6,22 @@
 export default (input = 'No args passed!') => input;
 
 /**
- * Return the passed argument as is.
- * @param  {String} [input='No args passed!'] input argument to return.
- * @return {String} return the recived import.
+ * Check if a numeric value is an even number.
+ * @param  {Number}  number a number to check.
+ * @return {Boolean}        boolean indication whether the given number is even.
+ * @throws {TypeError}      throw error when the argument is not a number.
+ */
+export const isEven = number => {
+  if (isNaN(number)) {
+    throw new TypeError('The first argument must be a number');
+  }
+  return number % 2 === 0;
+};
+
+/**
+ * Check if a numeric value is an odd number.
+ * @param  {Number}  number a number to check.
+ * @return {Boolean}        boolean indication whether the given number is odd.
+ * @throws {TypeError}      throw error when the argument is not a number.
  */
-export const namedExport = (input = 'No args passed!') => input;
+export const isOdd = number => !isEven(number);

src/index.test.js

@@ -1,9 +1,32 @@
-import nodeMdlStarter, { namedExport } from './index';
+import nodeMdlStarter, { isEven, isOdd } from './index';
 
-test('output', () => {
-  expect(nodeMdlStarter('🐰')).toBe('🐰');
-  expect(nodeMdlStarter()).toBe('No args passed!');
+describe('node-mdl-starter', () => {
+  test('default', () => {
+    expect(nodeMdlStarter('🐰')).toBe('🐰');
+    expect(nodeMdlStarter()).toBe('No args passed!');
+  });
 
-  expect(namedExport('🐰')).toBe('🐰');
-  expect(namedExport()).toBe('No args passed!');
+  test('isEven', () => {
+    for (let i = 0; i < 20; i += 2) {
+      expect(isEven(i)).toBe(true);
+    }
+
+    for (let i = 1; i < 20; i += 2) {
+      expect(isEven(i)).toBe(false);
+    }
+
+    expect(() => isEven('not-a-number')).toThrow(TypeError);
+  });
+
+  test('isOdd', () => {
+    for (let i = 0; i < 20; i += 2) {
+      expect(isOdd(i)).toBe(false);
+    }
+
+    for (let i = 1; i < 20; i += 2) {
+      expect(isOdd(i)).toBe(true);
+    }
+
+    expect(() => isOdd('not-a-number')).toThrow(TypeError);
+  });
 });