chore: ESLint/Prettier/Husky/lint-staged integration

Author: julien-f

.babelrc.js

@@ -1,47 +1,62 @@
-'use strict'
+"use strict";
 
-const NODE_ENV = process.env.NODE_ENV || 'development'
-const __PROD__ = NODE_ENV === 'production'
-const __TEST__ = NODE_ENV === 'test'
+const PLUGINS_RE = /^(?:@babel\/|babel-)plugin-.+$/;
+const PRESETS_RE = /^@babel\/preset-.+$/;
 
-const pkg = require('./package')
+const NODE_ENV = process.env.NODE_ENV || "development";
+const __PROD__ = NODE_ENV === "production";
+const __TEST__ = NODE_ENV === "test";
 
-const plugins = {
-  lodash: {},
-}
-
-const presets = {
-  '@babel/preset-env': {
-    debug: !__TEST__,
-    loose: true,
-    shippedProposals: true,
-    targets: __PROD__
-      ? (() => {
-        let node = (pkg.engines || {}).node
-        if (node !== undefined) {
-          const trimChars = '^=>~'
-          while (trimChars.includes(node[0])) {
-            node = node.slice(1)
-          }
-          return { node: node }
-        }
-      })()
-      : { browsers: '', node: 'current' },
-    useBuiltIns: '@babel/polyfill' in (pkg.dependencies || {}) && 'usage',
+const configs = {
+  "@babel/plugin-proposal-decorators": {
+    legacy: true,
+  },
+  "@babel/preset-env"(pkg) {
+    return {
+      debug: !__TEST__,
+      loose: true,
+      shippedProposals: true,
+      targets: __PROD__
+        ? (() => {
+            let node = (pkg.engines || {}).node;
+            if (node !== undefined) {
+              const trimChars = "^=>~";
+              while (trimChars.includes(node[0])) {
+                node = node.slice(1);
+              }
+              return { node: node };
+            }
+          })()
+        : { browsers: "", node: "current" },
+      useBuiltIns: "@babel/polyfill" in (pkg.dependencies || {}) && "usage",
+    };
   },
-}
+};
+
+const getConfig = (key, ...args) => {
+  const config = configs[key];
+  return config === undefined
+    ? {}
+    : typeof config === "function"
+    ? config(...args)
+    : config;
+};
+
+const plugins = {};
+const presets = {};
+const pkg = require("./package.json");
 
 Object.keys(pkg.devDependencies || {}).forEach(name => {
-  if (!(name in presets) && /@babel\/plugin-.+/.test(name)) {
-    plugins[name] = {}
-  } else if (!(name in presets) && /@babel\/preset-.+/.test(name)) {
-    presets[name] = {}
+  if (!(name in presets) && PLUGINS_RE.test(name)) {
+    plugins[name] = getConfig(name, pkg);
+  } else if (!(name in presets) && PRESETS_RE.test(name)) {
+    presets[name] = getConfig(name, pkg);
   }
-})
+});
 
 module.exports = {
   comments: !__PROD__,
   ignore: __TEST__ ? undefined : [/\.spec\.js$/],
   plugins: Object.keys(plugins).map(plugin => [plugin, plugins[plugin]]),
   presets: Object.keys(presets).map(preset => [preset, presets[preset]]),
-}
+};

.editorconfig

@@ -3,64 +3,12 @@
 # Julien Fontanet's configuration
 # https://gist.github.com/julien-f/8096213
 
-# Top-most EditorConfig file.
 root = true
 
-# Common config.
 [*]
 charset = utf-8
 end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-# CoffeeScript
-#
-# https://github.com/polarmobile/coffeescript-style-guide/blob/master/README.md
-[*.{,lit}coffee]
-indent_size = 2
-indent_style = space
-
-# Markdown
-[*.{md,mdwn,mdown,markdown}]
-indent_size = 4
-indent_style = space
-trim_trailing_whitespace = false
-
-# Package.json
-#
-# This indentation style is the one used by npm.
-[package.json]
-indent_size = 2
-indent_style = space
-
-# Pug (Jade)
-[*.{jade,pug}]
-indent_size = 2
-indent_style = space
-
-# JavaScript
-#
-# Two spaces seems to be the standard most common style, at least in
-# Node.js (http://nodeguide.com/style.html#tabs-vs-spaces).
-[*.{js,jsx,ts,tsx}]
-indent_size = 2
-indent_style = space
-
-# Less
-[*.less]
-indent_size = 2
-indent_style = space
-
-# Sass
-#
-# Style used for http://libsass.com
-[*.s[ac]ss]
-indent_size = 2
-indent_style = space
-
-# YAML
-#
-# Only spaces are allowed.
-[*.yaml]
 indent_size = 2
 indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc.js

@@ -1,13 +1,32 @@
 module.exports = {
-  extends: ['standard'],
-  parser: 'babel-eslint',
+  extends: [
+    // standard configuration
+    "standard",
+
+    // https://github.com/mysticatea/eslint-plugin-node#-rules
+    "plugin:node/recommended",
+
+    // disable rules handled by prettier
+    "prettier",
+    "prettier/standard",
+  ],
+
+  parser: "babel-eslint",
+
   rules: {
-    'comma-dangle': ['error', 'always-multiline'],
-    'no-var': 'error',
-    'node/no-extraneous-import': 'error',
-    'node/no-extraneous-require': 'error',
-    'node/no-missing-require': 'error',
-    'node/no-missing-import': 'error',
-    'prefer-const': 'error',
+    // prefer let/const over var
+    "no-var": "error",
+
+    // prefer const over let when possible
+    //
+    // should be included in standard: https://github.com/standard/eslint-config-standard/pull/133/
+    "prefer-const": "error",
+
+    // detect incorrect import
+    "node/no-extraneous-import": "error",
+    "node/no-missing-import": "error",
+
+    // uncomment if you are using a builder like Babel
+    "node/no-unsupported-features/es-syntax": "off",
   },
-}
+};

.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  // this really improves diffs
+  trailingComma: "es5",
+};

.travis.yml

@@ -3,7 +3,6 @@ node_js:
   - stable
   - 8
   - 6
-  - 4
 
 # Use containers.
 # http://docs.travis-ci.com/user/workers/container-based-infrastructure/

README.md

@@ -24,53 +24,53 @@ Installation of the [npm package](https://npmjs.org/package/limit-concurrency-de
 Simply apply the decorator to a method:
 
 ```js
-import limit from 'limit-concurrency-decorator'
+import limit from "limit-concurrency-decorator";
 
 class HttpClient {
   @limit(2)
-  get () {
+  get() {
     // ...
   }
 }
 
-const client = new HttpClient()
+const client = new HttpClient();
 
 // these calls will run in parallel
-client.get('http://example.net/')
-client.get('http://example2.net/')
+client.get("http://example.net/");
+client.get("http://example2.net/");
 
 // this call will wait for the 2 previous to finish
-client.get('http://example3.net/')
+client.get("http://example3.net/");
 ```
 
 Or a simple function as a wrapper:
 
 ```js
-import httpRequest from 'http-request-plus'
+import httpRequest from "http-request-plus";
 
-const httpRequestLimited = limit(2)(httpRequest)
+const httpRequestLimited = limit(2)(httpRequest);
 
 // these calls will run in parallel
-httpRequestLimited('http://example.net/')
-httpRequestLimited('http://example2.net/')
+httpRequestLimited("http://example.net/");
+httpRequestLimited("http://example2.net/");
 
 // this call will wait for the 2 previous to finish
-httpRequestLimited('http://example3.net/')
+httpRequestLimited("http://example3.net/");
 ```
 
 The limit can be shared:
 
 ```js
-const myLimit = limit(2)
+const myLimit = limit(2);
 
 class HttpClient {
   @myLimit
-  post () {
+  post() {
     // ...
   }
 
   @myLimit
-  put () {
+  put() {
     // ...
   }
 }
@@ -79,32 +79,32 @@ class HttpClient {
 With `FAIL_ON_QUEUE` you can fail early instead of waiting:
 
 ```js
-import { FAIL_ON_QUEUE } from 'limit-concurrency-decorator'
+import { FAIL_ON_QUEUE } from "limit-concurrency-decorator";
 
 try {
-  await httpRequestLimited(FAIL_ON_QUEUE, 'http://example2.net')
+  await httpRequestLimited(FAIL_ON_QUEUE, "http://example2.net");
 } catch (error) {
-  error.message // 'no available place in queue'
+  error.message; // 'no available place in queue'
 }
 ```
 
 Custom termination:
 
 ```js
 const httpRequestLimited = limit(2, async promise => {
-  const stream = await promise
+  const stream = await promise;
   await new Promise(resolve => {
-    stream.on('end', resolve)
-    stream.on('error', reject)
-  })
-})(httpRequest)
+    stream.on("end", resolve);
+    stream.on("error", reject);
+  });
+})(httpRequest);
 
 // these calls will run in parallel
-httpRequestLimited('http://example.net/')
-httpRequestLimited('http://example2.net/')
+httpRequestLimited("http://example.net/");
+httpRequestLimited("http://example2.net/");
 
 // this call will wait for the 2 previous responses to have been read entirely
-httpRequestLimited('http://example3.net/')
+httpRequestLimited("http://example3.net/");
 ```
 
 ## Development
@@ -128,7 +128,7 @@ httpRequestLimited('http://example3.net/')
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may: