eslint-plugin-graphile-export 1.0.0-rc.2 → 1.0.0-rc.4

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # eslint-plugin-graphile-export
 
+## 1.0.0-rc.4
+
+### Patch Changes
+
+- [`a3722d6`](https://github.com/graphile/crystal/commit/a3722d613bc6fb9e32f167aae9a31eaa422ceef1)
+  Thanks [@benjie](https://github.com/benjie)! - Refactor to enable TypeScript
+  options rewriteRelativeImportExtensions and erasableSyntaxOnly (including
+  using .ts extensions in source code)
+
+## 1.0.0-rc.3
+
+### Patch Changes
+
+- [#2873](https://github.com/graphile/crystal/pull/2873)
+  [`0772086`](https://github.com/graphile/crystal/commit/0772086411a55d56b4e345cff1eef133eee31b36)
+  Thanks [@benjie](https://github.com/benjie)! - Update TypeScript configuration
+  to support Node 22 minimum
+
+- [#2888](https://github.com/graphile/crystal/pull/2888)
+  [`1a56db2`](https://github.com/graphile/crystal/commit/1a56db2f53bc455a3d3ba6555a2cd777b27b271c)
+  Thanks [@benjaie](https://github.com/benjaie)! - Node v22+ is required for
+  this module.
+
 ## 1.0.0-rc.2
 
 ### Patch Changes

package/dist/ExhaustiveDeps.js

@@ -5,8 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExhaustiveDeps = void 0;
-const common_js_1 = require("./common.js");
-const utils_js_1 = require("./utils.js");
+const common_ts_1 = require("./common.js");
+const utils_ts_1 = require("./utils.js");
 function gatherDependenciesRecursively(dependencies, node, currentScope, monitoredScopes, rootNode) {
     for (const reference of currentScope.references) {
         // If this reference is not resolved or it is not declared in a pure
@@ -21,7 +21,7 @@ function gatherDependenciesRecursively(dependencies, node, currentScope, monitor
         }
         // Narrow the scope of a dependency if it is, say, a member expression.
         // Then normalize the narrowed dependency.
-        const referenceNode = (0, common_js_1.fastFindReferenceWithParent)(node, reference.identifier);
+        const referenceNode = (0, common_ts_1.fastFindReferenceWithParent)(node, reference.identifier);
         if (!referenceNode) {
             console.warn("Could not find referenceNode");
             continue;
@@ -136,7 +136,7 @@ exports.ExhaustiveDeps = {
                     return;
                 }
                 externalAssigns.add(key);
-                (0, common_js_1.reportProblem)(context, options, {
+                (0, common_ts_1.reportProblem)(context, options, {
                     node: writeExpr,
                     message: `Assignments to the '${key}' variable from inside ` +
                         `${context.sourceCode.getText(fnCall)} cannot be safely exported.`,
@@ -153,7 +153,7 @@ exports.ExhaustiveDeps = {
             const argNames = [];
             const invalid = node.params.some((arg) => {
                 if (arg.type !== "Identifier") {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: arg,
                         message: `${context.sourceCode.getText(fnCall)} has an argument which isn't a plain identifier, we don't support this currently.`,
                     });
@@ -171,7 +171,7 @@ exports.ExhaustiveDeps = {
                 // If the declared dependencies is not an object expression then we
                 // can't verify that the user provided the correct dependencies. Tell
                 // the user this in an error.
-                (0, common_js_1.reportProblem)(context, options, {
+                (0, common_ts_1.reportProblem)(context, options, {
                     node: declaredDependenciesNode,
                     message: `${context.sourceCode.getText(fnCall)} was passed a ` +
                         "dependency map that is not an array. This means we " +
@@ -187,7 +187,7 @@ exports.ExhaustiveDeps = {
                     }
                     // If we see a spread element then add a special warning.
                     if (declaredDependencyNode.type === "SpreadElement") {
-                        (0, common_js_1.reportProblem)(context, options, {
+                        (0, common_ts_1.reportProblem)(context, options, {
                             node: declaredDependencyNode,
                             message: `${context.sourceCode.getText(fnCall)} has a spread element ` +
                                 "in its dependency map. This means we can't " +
@@ -204,7 +204,7 @@ exports.ExhaustiveDeps = {
                     });
                 });
                 if (node.params.length !== declaredDependenciesNode.elements.length) {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: declaredDependenciesNode,
                         message: `${context.sourceCode.getText(fnCall)} has different arguments count (${node.params.length}) versus dependencies count (${declaredDependenciesNode.elements.length}); this is invalid.`,
                     });
@@ -229,7 +229,7 @@ exports.ExhaustiveDeps = {
                 (isSorted || !options.sortExports)) {
                 return;
             }
-            (0, common_js_1.reportProblem)(context, options, {
+            (0, common_ts_1.reportProblem)(context, options, {
                 node: declaredDependenciesNode,
                 message: `${context.sourceCode.getText(fnCall)} has ` +
                     // To avoid a long message, show the next actionable item.
@@ -300,14 +300,14 @@ exports.ExhaustiveDeps = {
                 const declaredDependenciesNode = node.arguments[callbackIndex + 1];
                 // Check whether a callback is supplied.
                 if (!callback) {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: fnCall,
                         message: `EXPORTABLE must wrap a function.`,
                     });
                     return;
                 }
                 if (!declaredDependenciesNode) {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: fnCall,
                         message: `EXPORTABLE does nothing when called with ` +
                             `only one argument. Did you forget to pass an array of ` +
@@ -335,7 +335,7 @@ exports.ExhaustiveDeps = {
                         return; // Handled
                     case "Identifier":
                     default:
-                        (0, common_js_1.reportProblem)(context, options, {
+                        (0, common_ts_1.reportProblem)(context, options, {
                             node: fnCall,
                             message: `EXPORTABLE received a function whose dependencies ` +
                                 `are unknown. Pass an inline function instead.`,
@@ -533,7 +533,7 @@ function analyzePropertyChain(node) {
  * Returns 0 if this is a EXPORTABLE call, -1 otherwise.
  */
 function getScopesCallbackIndex(node) {
-    if ((0, utils_js_1.isExportableCall)(node)) {
+    if ((0, utils_ts_1.isExportableCall)(node)) {
         return 0;
     }
     else {

package/dist/ExportInstances.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportInstances = void 0;
-const common_js_1 = require("./common.js");
-const NoNested_js_1 = require("./NoNested.js");
+const common_ts_1 = require("./common.js");
+const NoNested_ts_1 = require("./NoNested.js");
 const KNOWN_IMPORTS = [
     ["@dataplan/pg", "PgResource"],
     ["@dataplan/pg", "PgExecutor"],
@@ -53,9 +53,9 @@ exports.ExportInstances = {
                 }
                 // TODO: determine if the definition for this `callee` identifier is an import from any of these `possibles` (and if not, `return;`).
                 //const scope = scopeManager.acquire(node);
-                if ((0, NoNested_js_1.hasExportableParent)(node))
+                if ((0, NoNested_ts_1.hasExportableParent)(node))
                     return;
-                (0, common_js_1.reportProblem)(context, options, {
+                (0, common_ts_1.reportProblem)(context, options, {
                     node: node,
                     message: `${node.type === "NewExpression" ? "Construction" : "Call"} of '${constructorName}' without EXPORTABLE.`,
                     suggest: [

package/dist/ExportMethods.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportMethods = void 0;
-const common_js_1 = require("./common.js");
-const NoNested_js_1 = require("./NoNested.js");
+const common_ts_1 = require("./common.js");
+const NoNested_ts_1 = require("./NoNested.js");
 const dev = process.env.GRAPHILE_ENV === "development";
 /**
  * So we don't reach too wide we only want to match objects that look like
@@ -117,12 +117,12 @@ function processNode(context, options, node, match) {
         const disallowedSiblingKeys = parentObjectKeys.filter((key) => key == null ||
             (!ALLOWED_SIBLING_KEYS.includes(key) && !options.methods.includes(key)));
         if (disallowedSiblingKeys.length === 0) {
-            if ((0, NoNested_js_1.hasExportableParent)(node))
+            if ((0, NoNested_ts_1.hasExportableParent)(node))
                 return;
             // Match
             if (node.type === "ObjectMethod") {
                 // replace with property -> EXPORTABLE
-                (0, common_js_1.reportProblem)(context, options, {
+                (0, common_ts_1.reportProblem)(context, options, {
                     node: node,
                     message: "is not exportable.",
                     // TODO: implement the suggestion
@@ -144,7 +144,7 @@ function processNode(context, options, node, match) {
                     (value.type === "FunctionExpression" ||
                         value.type === "ArrowFunctionExpression")) {
                     // Wrap with EXPORTABLE
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: node,
                         message: "Step value is not exportable.",
                         suggest: [

package/dist/ExportPlans.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportPlans = void 0;
-const common_js_1 = require("./common.js");
-const NoNested_js_1 = require("./NoNested.js");
+const common_ts_1 = require("./common.js");
+const NoNested_ts_1 = require("./NoNested.js");
 /**
  * So we don't reach too wide we only want to match objects that look like
  * they're probably plan configurations. For now this is the GraphQLFieldConfig
@@ -58,12 +58,12 @@ exports.ExportPlans = {
     },
 };
 function processNode(context, options, node) {
-    if ((0, NoNested_js_1.hasExportableParent)(node))
+    if ((0, NoNested_ts_1.hasExportableParent)(node))
         return;
     // Match
     if (node.type === "ObjectMethod") {
         // replace with property -> EXPORTABLE
-        (0, common_js_1.reportProblem)(context, options, {
+        (0, common_ts_1.reportProblem)(context, options, {
             node: node,
             message: "is not exportable.",
             // TODO: implement the suggestion
@@ -85,7 +85,7 @@ function processNode(context, options, node) {
             (value.type === "FunctionExpression" ||
                 value.type === "ArrowFunctionExpression")) {
             // Wrap with EXPORTABLE
-            (0, common_js_1.reportProblem)(context, options, {
+            (0, common_ts_1.reportProblem)(context, options, {
                 node: node,
                 message: "Step value is not exportable.",
                 suggest: [

package/dist/ExportSubclasses.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportSubclasses = void 0;
 const path_1 = require("path");
-const common_js_1 = require("./common.js");
-const NoNested_js_1 = require("./NoNested.js");
+const common_ts_1 = require("./common.js");
+const NoNested_ts_1 = require("./NoNested.js");
 const KNOWN_IMPORTS = [
     ["grafast", "Step"],
     ["grafast", "Modifier"],
@@ -55,7 +55,7 @@ exports.ExportSubclasses = {
                 if (!className) {
                     return;
                 }
-                if ((0, NoNested_js_1.hasExportableParent)(node))
+                if ((0, NoNested_ts_1.hasExportableParent)(node))
                     return;
                 // ENHANCE: if the definition for the `superClass` identifier is not actually an import from any of these `possibles` then we should `return;`. It just happens to share the same name?
                 //const scope = scopeManager.acquire(node);
@@ -67,7 +67,7 @@ exports.ExportSubclasses = {
                     def.key.name === "$$export");
                 if ($$export) {
                     if (!$$export.static) {
-                        (0, common_js_1.reportProblem)(context, options, {
+                        (0, common_ts_1.reportProblem)(context, options, {
                             node: $$export,
                             message: `$$export should be a static property; this is probably a mistake?`,
                             suggest: [
@@ -94,13 +94,13 @@ exports.ExportSubclasses = {
                         const safe = !$$export.value.properties.some((prop) => prop.type === "SpreadElement") &&
                             !$$export.value.properties.some((prop) => prop.type === "Property" && prop.key.type !== "Identifier");
                         if (safe && !moduleName) {
-                            (0, common_js_1.reportProblem)(context, options, {
+                            (0, common_ts_1.reportProblem)(context, options, {
                                 node: $$export,
                                 message: `$$export specifier doesn't explicitly specify 'moduleName'`,
                             });
                         }
                         if (safe && !exportName) {
-                            (0, common_js_1.reportProblem)(context, options, {
+                            (0, common_ts_1.reportProblem)(context, options, {
                                 node: $$export,
                                 message: `$$export specifier doesn't explicitly specify 'exportName'`,
                             });
@@ -109,14 +109,14 @@ exports.ExportSubclasses = {
                             if (!moduleName.value ||
                                 !["StringLiteral", "Literal"].includes(moduleName.value.type)) {
                                 console.dir(moduleName.value);
-                                (0, common_js_1.reportProblem)(context, options, {
+                                (0, common_ts_1.reportProblem)(context, options, {
                                     node: $$export,
                                     message: `$$export has invalid value for 'moduleName' - expected a string literal.`,
                                 });
                             }
                             if (!exportName.value ||
                                 !["StringLiteral", "Literal"].includes(exportName.value.type)) {
-                                (0, common_js_1.reportProblem)(context, options, {
+                                (0, common_ts_1.reportProblem)(context, options, {
                                     node: $$export,
                                     message: `$$export has invalid value for 'exportName' - expected a string literal.`,
                                 });
@@ -150,14 +150,14 @@ exports.ExportSubclasses = {
                 };
                 const exportExample = `static $$export = { moduleName: /* TODO */ ".../path/to/module.js", exportName: "${className}" }`;
                 if (isGeneric) {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: node,
                         message: `Generic class '${className}' extending '${superClassIdentifier}' cannot be safely exported. Because it's generic we cannot make it EXPORTABLE, instead make it importable by putting it in its own module and declaring a '${exportExample}' property.`,
                         suggest: [convertToImportable],
                     });
                 }
                 else {
-                    (0, common_js_1.reportProblem)(context, options, {
+                    (0, common_ts_1.reportProblem)(context, options, {
                         node: node,
                         message: `Class '${className}' extends '${superClassIdentifier}' but cannot be safely exported. Either make it EXPORTABLE or make it importable and add a '${exportExample}' property to indicate this.`,
                         suggest: [convertToExportable, convertToImportable],

package/dist/NoNested.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoNested = void 0;
 exports.hasExportableParent = hasExportableParent;
-const common_js_1 = require("./common.js");
-const utils_js_1 = require("./utils.js");
+const common_ts_1 = require("./common.js");
+const utils_ts_1 = require("./utils.js");
 exports.NoNested = {
     meta: {
         type: "suggestion",
@@ -40,12 +40,12 @@ exports.NoNested = {
         };
         return {
             CallExpression(node) {
-                if ((0, utils_js_1.isExportableCall)(node)) {
+                if ((0, utils_ts_1.isExportableCall)(node)) {
                     if (hasExportableParent(node)) {
                         const callback = node.arguments[0];
                         if (callback.type === "ArrowFunctionExpression") {
                             const body = callback.body;
-                            (0, common_js_1.reportProblem)(context, options, {
+                            (0, common_ts_1.reportProblem)(context, options, {
                                 node: node,
                                 message: "Nested EXPORTABLE found",
                                 suggest: [
@@ -70,7 +70,7 @@ exports.NoNested = {
 function hasExportableParent(node) {
     let parent = node;
     while ((parent = parent.parent)) {
-        if ((0, utils_js_1.isExportableCall)(parent)) {
+        if ((0, utils_ts_1.isExportableCall)(parent)) {
             return true;
         }
     }

package/dist/index.js

@@ -2,12 +2,12 @@
 // Inspired by eslint-plugin-react-hooks
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rules = exports.meta = exports.configs = void 0;
-const ExhaustiveDeps_js_1 = require("./ExhaustiveDeps.js");
-const ExportInstances_js_1 = require("./ExportInstances.js");
-const ExportMethods_js_1 = require("./ExportMethods.js");
-const ExportPlans_js_1 = require("./ExportPlans.js");
-const ExportSubclasses_js_1 = require("./ExportSubclasses.js");
-const NoNested_js_1 = require("./NoNested.js");
+const ExhaustiveDeps_ts_1 = require("./ExhaustiveDeps.js");
+const ExportInstances_ts_1 = require("./ExportInstances.js");
+const ExportMethods_ts_1 = require("./ExportMethods.js");
+const ExportPlans_ts_1 = require("./ExportPlans.js");
+const ExportSubclasses_ts_1 = require("./ExportSubclasses.js");
+const NoNested_ts_1 = require("./NoNested.js");
 exports.configs = {
     recommended: {
         name: "graphile-export/recommended",
@@ -79,12 +79,12 @@ exports.meta = {
     name: "eslint-plugin-graphile-export",
 };
 exports.rules = {
-    "exhaustive-deps": ExhaustiveDeps_js_1.ExhaustiveDeps,
-    "export-methods": ExportMethods_js_1.ExportMethods,
-    "export-instances": ExportInstances_js_1.ExportInstances,
-    "export-plans": ExportPlans_js_1.ExportPlans,
-    "export-subclasses": ExportSubclasses_js_1.ExportSubclasses,
-    "no-nested": NoNested_js_1.NoNested,
+    "exhaustive-deps": ExhaustiveDeps_ts_1.ExhaustiveDeps,
+    "export-methods": ExportMethods_ts_1.ExportMethods,
+    "export-instances": ExportInstances_ts_1.ExportInstances,
+    "export-plans": ExportPlans_ts_1.ExportPlans,
+    "export-subclasses": ExportSubclasses_ts_1.ExportSubclasses,
+    "no-nested": NoNested_ts_1.NoNested,
 };
 const plugin = {
     configs: exports.configs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-graphile-export",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.4",
   "description": "ESLint plugin to help ensure your schema is exportable by graphile-export",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,7 +28,7 @@
     "tslib": "^2.8.1"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=22"
   },
   "peerDependencies": {
     "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0 || ^9.26.0"