ESLint, rollup powered build, Travis CI

- building cjs, esm and umd-min flavours - removing `dist` from git repo - updating example - fine tuning `.npmignore` to reduce tarball size
yankouskia · Jun 30, 2019 · 08b557d · 08b557d
1 parent 06530b3
commit 08b557d
Show file tree

Hide file tree

Showing 16 changed files with 1,933 additions and 190 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+dist
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,16 @@
+/** @type {import('eslint').Linter.Config} */
+const config = {
+  extends: 'semistandard',
+  rules: {
+    'prefer-const': 'error',
+    'space-before-function-paren': ['error', {
+      anonymous: 'always',
+      named: 'never'
+    }]
+  },
+  env: {
+    browser: true
+  }
+};
+
+module.exports = config;
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,6 @@ yarn-debug.log*
 yarn-error.log*
 node_modules/
 .npm
+
+# Build artifacts
+dist/
diff --git a/.npmignore b/.npmignore
@@ -1,4 +1,8 @@
 .editorconfig
+.travis.yml
+.eslint*
+*.config.js
+index.test-d.ts
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+  - '8'
+  - '10'
+  - lts/*
+  - node
+
+script:
+  - yarn run lint
+  - yarn test
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ npm install is-incognito-mode --save
 import isIncognito from 'is-incognito-mode';
 
 // CommonJS modules
-const isIncognito = require('is-incognito-mode').default;
+const isIncognito = require('is-incognito-mode');
 
 /*
   Function returns Promise, which could be:

diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ['@babel/preset-env']
+};
diff --git a/dist/isIncognito.js b/dist/isIncognito.js
diff --git a/example/index.html b/example/index.html
@@ -6,13 +6,13 @@
   <meta http-equiv="X-UA-Compatible" content="ie=edge">
   <title>Is incognito</title>
 </head>
-<script src="../dist/isIncognito.js"></script>
+<script src="../dist/isIncognito.umd.min.js"></script>
 <body style="height: 100%; display: flex; align-items: center; justify-content: center;">
   <div id="text" style="font-size: 40px; font-weight: 600; text-align: center;"></div>
 </body>
 <script>
   const element = document.querySelector('#text');
-  window.isIncognito.default()
+  window.isIncognito()
     .then(isPrivate => {
       if (isPrivate) {
         element.innerHTML = 'There is no porn!<br /><br /><br />Why are you using Incognito mode?';

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,2 @@
+declare function isIncognito(): Promise<boolean>;
+export = isIncognito;
diff --git a/index.js b/index.js
@@ -1,4 +1,5 @@
-import { browsers, detect } from 'get-browser';
+import getBrowser from 'get-browser';
+const { browsers, detect } = getBrowser;
 
 const UNUSUAL_KEY = 'cd1394e6-3fd1-4a2d-ae60-c9ae01f7ee89';
 const CANNOT_IDENTIFY_ERROR = new Error('Cannot identify whether incognito mode is active');
@@ -45,11 +46,11 @@ export default function isIncognito() {
         window.openDatabase(null, null, null, null);
       } catch (e) {
         return yes();
-      };
+      }
 
       return no();
     }
 
     return unknown();
   });
-};
+}
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -0,0 +1,4 @@
+import { expectType } from 'tsd';
+import isIncognito from '.';
+
+expectType<boolean>(await isIncognito());
diff --git a/package.json b/package.json
@@ -3,20 +3,46 @@
   "version": "1.1.0",
   "description": "Function to identify whether user is in incognito mode",
   "main": "./dist/isIncognito.js",
+  "module": "./dist/isIncognito.esm.js",
   "repository": "git@github.com:yankouskia/is-incognito-mode.git",
+  "types": "index.d.ts",
   "author": "yankouskia <aleksandr.yankovskiy@gmail.com>",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "^7.4.4",
-    "@babel/preset-env": "^7.4.4",
+    "@babel/core": "^7.4.5",
+    "@babel/preset-env": "^7.4.5",
+    "@types/eslint": "^4.16.6",
     "babel-loader": "^8.0.6",
-    "webpack": "^4.32.0",
-    "webpack-cli": "^3.3.2"
+    "del-cli": "^2.0.0",
+    "eslint": "^6.0.0",
+    "eslint-config-semistandard": "^13.0.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-node": "^9.1.0",
+    "eslint-plugin-promise": "^4.1.1",
+    "eslint-plugin-standard": "^4.0.0",
+    "rollup": "^1.16.3",
+    "rollup-plugin-babel": "^4.3.3",
+    "rollup-plugin-commonjs": "^10.0.1",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-terser": "^5.0.0",
+    "tsd": "^0.7.3",
+    "webpack": "^4.35.0",
+    "webpack-cli": "^3.3.5"
   },
   "dependencies": {
     "get-browser": "^1.0.2"
   },
   "scripts": {
-    "build": "NODE_ENV=production webpack -p"
+    "lint": "eslint .",
+    "prebuild": "del-cli dist",
+    "build": "rollup -c rollup.config.js",
+    "test": "tsd",
+    "prepublishOnly": "yarn run build"
+  },
+  "tsd": {
+    "compilerOptions": {
+      "esModuleInterop": true
+    }
   }
 }
diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,48 @@
+'use strict';
+
+const babel = require('rollup-plugin-babel');
+const { builtinModules } = require('module');
+const commonjs = require('rollup-plugin-commonjs');
+const path = require('path');
+const pkg = require('./package.json');
+const resolve = require('rollup-plugin-node-resolve');
+const { terser } = require('rollup-plugin-terser');
+
+/** @type {import('rollup').RollupOptions} */
+const baseConfig = {
+  input: './index.js',
+  external: Object.keys(pkg.dependencies).concat(builtinModules),
+  plugins: [
+    resolve(),
+    commonjs(),
+    babel({
+      exclude: ['node_modules/**']
+    })
+  ]
+};
+
+/** @type {Array<import('rollup').RollupOptions>} */
+const config = [{
+  ...baseConfig,
+  output: {
+    format: 'esm',
+    file: path.join(__dirname, './dist/isIncognito.esm.js')
+  }
+}, {
+  ...baseConfig,
+  output: {
+    format: 'cjs',
+    file: path.join(__dirname, './dist/isIncognito.js')
+  }
+}, {
+  ...baseConfig,
+  output: {
+    format: 'umd',
+    name: 'isIncognito',
+    file: path.join(__dirname, './dist/isIncognito.umd.min.js')
+  },
+  external: [],
+  plugins: baseConfig.plugins.concat(terser())
+}];
+
+module.exports = config;
diff --git a/webpack.config.js b/webpack.config.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		declare function isIncognito(): Promise<boolean>;
		export = isIncognito;