ESLint: sync 'eslint-internal-rules' with 'graphql-js'

Author: IvanGoncharov

.eslintrc.yml

@@ -6,12 +6,20 @@ env:
   node: true
 reportUnusedDisableDirectives: true
 plugins:
+  - internal-rules
   - flowtype
   - node
   - istanbul
   - import
 
 rules:
+  ##############################################################################
+  # Internal rules located in 'resources/eslint-internal-rules'.
+  # See './resources/eslint-internal-rules/README.md'
+  ##############################################################################
+
+  internal-rules/no-dir-import: error
+
   ##############################################################################
   # `eslint-plugin-flowtype` rule list based on `v5.1.x`
   # https://github.com/gajus/eslint-plugin-flowtype#eslint-plugin-flowtype

package.json

@@ -63,6 +63,7 @@
     "dtslint": "3.6.10",
     "eslint": "7.1.0",
     "eslint-plugin-flowtype": "5.1.3",
+    "eslint-plugin-internal-rules": "file:./resources/eslint-internal-rules",
     "eslint-plugin-import": "2.20.2",
     "eslint-plugin-istanbul": "0.1.1",
     "eslint-plugin-node": "11.1.0",

resources/eslint-internal-rules/README.md

@@ -0,0 +1,6 @@
+# Custom ESLint Rules
+
+This is a dummy npm package that allows us to treat it as an `eslint-plugin-graphql-internal`.
+It's not actually published, nor are the rules here useful for users of graphql.
+
+**If you modify this rule, you must re-run `npm install` for it to take effect.**

resources/eslint-internal-rules/index.js

@@ -0,0 +1,9 @@
+// @noflow
+
+'use strict';
+
+module.exports = {
+  rules: {
+    'no-dir-import': require('./no-dir-import'),
+  },
+};

resources/eslint-internal-rules/no-dir-import.js

@@ -0,0 +1,38 @@
+// @noflow
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function (context) {
+  return {
+    ImportDeclaration: checkImportPath,
+    ExportNamedDeclaration: checkImportPath,
+  };
+
+  function checkImportPath(node) {
+    const { source } = node;
+
+    // bail if the declaration doesn't have a source, e.g. "export { foo };"
+    if (!source) {
+      return;
+    }
+
+    const importPath = source.value;
+    if (importPath.startsWith('./') || importPath.startsWith('../')) {
+      const baseDir = path.dirname(context.getFilename());
+      const resolvedPath = path.resolve(baseDir, importPath);
+
+      if (
+        fs.existsSync(resolvedPath) &&
+        fs.statSync(resolvedPath).isDirectory()
+      ) {
+        context.report({
+          node: source,
+          message: 'It is not allowed to import from directory',
+        });
+      }
+    }
+  }
+};

resources/eslint-internal-rules/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "eslint-plugin-graphql-internal",
+  "version": "0.0.0"
+}

yarn.lock

@@ -1983,6 +1983,9 @@ [email protected]:
     read-pkg-up "^2.0.0"
     resolve "^1.12.0"
 
+"eslint-plugin-internal-rules@file:./resources/eslint-internal-rules":
+  version "0.0.0"
+
 [email protected]:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/eslint-plugin-istanbul/-/eslint-plugin-istanbul-0.1.1.tgz#6289daca3844f6ae1fc23a29093d8554fc7dc352"