[eslint-config-sanity] Import eslint config package (#625)

Author: bjoerge

.eslintrc

@@ -5,9 +5,9 @@
   },
   "parser": "babel-eslint",
   "extends": [
-    "sanity",
-    "sanity/react",
-    "sanity/import",
+    "./packages/eslint-config-sanity/index.js",
+    "./packages/eslint-config-sanity/react.js",
+    "./packages/eslint-config-sanity/import.js",
     "prettier",
     "prettier/react",
     "prettier/flowtype"

lerna.json

@@ -7,6 +7,7 @@
   "packages": [
     "packages/@sanity/*",
     "packages/example-studio",
+    "packages/eslint-config-sanity",
     "packages/test-studio",
     "packages/movies-studio",
     "packages/blog-studio",

package.json

@@ -58,7 +58,6 @@
     "chalk": "^2.3.0",
     "eslint": "^4.16.0",
     "eslint-config-prettier": "^2.9.0",
-    "eslint-config-sanity": "^4.0.2",
     "eslint-import-resolver-webpack": "^0.8.4",
     "eslint-plugin-flowtype": "^2.42.0",
     "eslint-plugin-flowtype-errors": "^3.3.7",

packages/@sanity/import/package.json

@@ -12,7 +12,15 @@
     "clean": "rimraf lib",
     "test": "jest"
   },
-  "keywords": ["sanity", "cms", "headless", "realtime", "content", "import", "ndjson"],
+  "keywords": [
+    "sanity",
+    "cms",
+    "headless",
+    "realtime",
+    "content",
+    "import",
+    "ndjson"
+  ],
   "dependencies": {
     "@rexxars/get-uri": "^2.0.2",
     "@sanity/mutator": "^0.125.8",

packages/eslint-config-sanity/.eslintrc

@@ -0,0 +1,8 @@
+{
+  "env": {
+    "node": true
+  },
+  "rules": {
+    "import/no-commonjs": "off"
+  }
+}

packages/eslint-config-sanity/README.md

@@ -0,0 +1,7 @@
+# eslint-config-sanity
+
+Shared eslint rules for Sanity
+
+# Usage
+
+`npm i -D eslint-config-sanity`

packages/eslint-config-sanity/bin/diff.js

@@ -0,0 +1,49 @@
+/* eslint-disable no-console */
+const difference = require('lodash.difference')
+const latest = Object.keys(require('eslint/conf/eslint-all').rules)
+const base = Object.keys(require('..').rules)
+const latestReactRules = Object.keys(require('eslint-plugin-react').rules).map(ruleName => {
+  return `react/${ruleName}`
+})
+const existingReactRules = Object.keys(require('../react').rules)
+
+const replacements = require('eslint/conf/replacements.json').rules
+
+const addedRules = difference(latest, base)
+let removedRules = difference(base, latest)
+
+const replacedRules = removedRules.filter(removed => {
+  return removed in replacements
+})
+
+removedRules = difference(removedRules, replacedRules)
+
+const replacedRuleMapping = replacedRules.map(removed => {
+  return {from: removed, to: replacements[removed]}
+})
+
+function printRules(rules) {
+  if (!rules.length) {
+    return '  None'
+  }
+  return `  ${rules.join('\n  ')}`
+}
+
+console.log('New rules: \n%s', printRules(addedRules))
+console.log('Removed rules: \n%s', printRules(removedRules))
+console.log(
+  'Replaced rules: \n%s',
+  printRules(
+    replacedRuleMapping.map(repl => {
+      return `${repl.from} => ${repl.to}`
+    })
+  )
+)
+
+console.log()
+
+const addedReactRules = difference(latestReactRules, existingReactRules)
+const removeReactRules = difference(existingReactRules, latestReactRules)
+console.log('--- eslint-plugin-react ---')
+console.log('New rules: \n%s', printRules(addedReactRules))
+console.log('Removed rules: \n%s', printRules(removeReactRules))

packages/eslint-config-sanity/import.js

@@ -0,0 +1,41 @@
+module.exports = {
+  plugins: ['import'],
+  rules: {
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/extensions': ['error', {js: 'never', json: 'always'}],
+    'import/exports-last': 'off',
+    'import/first': 'error',
+    'import/no-anonymous-default-export': 'off',
+    'import/max-dependencies': 'off',
+    'import/namespace': 'error',
+    'import/named': 'error',
+    'import/newline-after-import': 'warn',
+    'import/no-absolute-path': 'error',
+    'import/no-amd': 'error',
+    'import/no-commonjs': 'error',
+    'import/no-deprecated': 'off',
+    'import/no-duplicates': 'error',
+    'import/no-dynamic-require': 'error',
+    'import/no-extraneous-dependencies': 'error',
+    'import/no-internal-modules': 'off',
+    'import/no-mutable-exports': 'error',
+    'import/no-named-as-default': 'error',
+    'import/no-named-as-default-member': 'error',
+    'import/no-named-default': 'warn',
+    'import/no-namespace': 'off',
+    'import/no-nodejs-modules': 'off',
+    'import/no-restricted-paths': 'off',
+    'import/no-unassigned-import': 'error',
+    'import/no-unresolved': 'error',
+    'import/no-webpack-loader-syntax': 'error',
+    'import/order': 'warn',
+    'import/prefer-default-export': 'warn',
+    'import/unambiguous': 'error'
+  },
+  settings: {
+    'import/resolve': {
+      extensions: ['.js', '.jsx', '.json']
+    }
+  }
+}