eslint-plugin-graphile-export 0.0.2-0.0

package/dist/common.d.ts

@@ -0,0 +1,28 @@
+import type { Expression, Node } from "@babel/types";
+import type { Rule } from "eslint";
+import type { Expression as ESTreeExpression } from "estree";
+declare module "eslint" {
+    namespace Rule {
+        interface RuleMetaData {
+            hasSuggestions: boolean;
+        }
+        interface RuleContext {
+            getSource(node: Expression | ESTreeExpression): string;
+        }
+    }
+}
+export declare function reportProblem(context: Rule.RuleContext, options: {
+    disableAutofix: boolean;
+}, problem: Rule.ReportDescriptor): void;
+/**
+ * ESLint won't assign node.parent to references from context.getScope()
+ *
+ * So instead we search for the node from an ancestor assigning node.parent
+ * as we go. This mutates the AST.
+ *
+ * This traversal is:
+ * - optimized by only searching nodes with a range surrounding our target node
+ * - agnostic to AST node types, it looks for `{ type: string, ... }`
+ */
+export declare function fastFindReferenceWithParent(start: Node & Rule.NodeParentExtension, target: Node): (Node & Rule.NodeParentExtension) | null;
+//# sourceMappingURL=common.d.ts.map

package/dist/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,IAAI,CAAC;QACb,UAAU,YAAY;YACpB,cAAc,EAAE,OAAO,CAAC;SACzB;QACD,UAAU,WAAW;YACnB,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,gBAAgB,GAAG,MAAM,CAAC;SACxD;KACF;CACF;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,IAAI,CAAC,WAAW,EACzB,OAAO,EAAE;IAAE,cAAc,EAAE,OAAO,CAAA;CAAE,EACpC,OAAO,EAAE,IAAI,CAAC,gBAAgB,QAU/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,IAAI,GAAG,IAAI,CAAC,mBAAmB,EACtC,MAAM,EAAE,IAAI,4CAwCb"}

package/dist/common.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fastFindReferenceWithParent = exports.reportProblem = void 0;
+function reportProblem(context, options, problem) {
+    if (options.disableAutofix !== true) {
+        // Used to enable legacy behavior. Dangerous.
+        // Keep this as an option until major IDEs upgrade (including VSCode FB ESLint extension).
+        if (Array.isArray(problem.suggest) && problem.suggest.length > 0) {
+            problem.fix = problem.suggest[0].fix;
+        }
+    }
+    context.report(problem);
+}
+exports.reportProblem = reportProblem;
+/**
+ * ESLint won't assign node.parent to references from context.getScope()
+ *
+ * So instead we search for the node from an ancestor assigning node.parent
+ * as we go. This mutates the AST.
+ *
+ * This traversal is:
+ * - optimized by only searching nodes with a range surrounding our target node
+ * - agnostic to AST node types, it looks for `{ type: string, ... }`
+ */
+function fastFindReferenceWithParent(start, target) {
+    const queue = [start];
+    let item = null;
+    while (queue.length) {
+        item = queue.shift();
+        const definitelyItem = item;
+        if (isSameIdentifier(definitelyItem, target)) {
+            return definitelyItem;
+        }
+        if (!isAncestorNodeOf(definitelyItem, target)) {
+            continue;
+        }
+        for (const [key, value] of Object.entries(definitelyItem)) {
+            if (key === "parent") {
+                continue;
+            }
+            if (isNodeLike(value)) {
+                const valueWithParent = Object.assign(value, {
+                    parent: definitelyItem,
+                });
+                queue.push(valueWithParent);
+            }
+            else if (Array.isArray(value)) {
+                value.forEach((val) => {
+                    if (isNodeLike(val)) {
+                        const valWithParent = Object.assign(val, {
+                            parent: definitelyItem,
+                        });
+                        queue.push(valWithParent);
+                    }
+                });
+            }
+        }
+    }
+    return null;
+}
+exports.fastFindReferenceWithParent = fastFindReferenceWithParent;
+function isSameIdentifier(a, b) {
+    return ((a.type === "Identifier" || a.type === "JSXIdentifier") &&
+        a.type === b.type &&
+        a.name === b.name &&
+        a.range[0] === b.range[0] &&
+        a.range[1] === b.range[1]);
+}
+function isNodeLike(val) {
+    return (typeof val === "object" &&
+        val !== null &&
+        !Array.isArray(val) &&
+        typeof val.type === "string");
+}
+function isAncestorNodeOf(a, b) {
+    return a.range[0] <= b.range[0] && a.range[1] >= b.range[1];
+}
+//# sourceMappingURL=common.js.map

package/dist/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":";;;AAeA,SAAgB,aAAa,CAC3B,OAAyB,EACzB,OAAoC,EACpC,OAA8B;IAE9B,IAAI,OAAO,CAAC,cAAc,KAAK,IAAI,EAAE;QACnC,6CAA6C;QAC7C,0FAA0F;QAC1F,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAChE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;SACtC;KACF;IACD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAbD,sCAaC;AAED;;;;;;;;;GASG;AACH,SAAgB,2BAA2B,CACzC,KAAsC,EACtC,MAAY;IAEZ,MAAM,KAAK,GAA2C,CAAC,KAAK,CAAC,CAAC;IAC9D,IAAI,IAAI,GAA6C,IAAI,CAAC;IAE1D,OAAO,KAAK,CAAC,MAAM,EAAE;QACnB,IAAI,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QACtB,MAAM,cAAc,GAAG,IAAI,CAAC;QAE5B,IAAI,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE;YAC5C,OAAO,cAAc,CAAC;SACvB;QAED,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE;YAC7C,SAAS;SACV;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YACzD,IAAI,GAAG,KAAK,QAAQ,EAAE;gBACpB,SAAS;aACV;YACD,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE;gBACrB,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;oBAC3C,MAAM,EAAE,cAAc;iBACvB,CAAC,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aAC7B;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBACpB,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE;wBACnB,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;4BACvC,MAAM,EAAE,cAAc;yBACvB,CAAC,CAAC;wBACH,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;qBAC3B;gBACH,CAAC,CAAC,CAAC;aACJ;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AA1CD,kEA0CC;AAED,SAAS,gBAAgB,CAAC,CAAM,EAAE,CAAM;IACtC,OAAO,CACL,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC;QACvD,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;QACjB,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;QACjB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,GAAY;IAC9B,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACnB,OAAQ,GAAW,CAAC,IAAI,KAAK,QAAQ,CACtC,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAkC,EAAE,CAAO;IACnE,OAAO,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+export declare const configs: {
+    recommended: {
+        plugins: string[];
+        rules: {
+            "graphile-export/exhaustive-deps": (string | {
+                disableAutofix: boolean;
+                sortExports: boolean;
+            })[];
+            "graphile-export/export-methods": (string | {
+                disableAutofix: boolean;
+                methods: string[];
+            })[];
+            "graphile-export/export-instances": (string | {
+                disableAutofix: boolean;
+            })[];
+            "graphile-export/export-subclasses": (string | {
+                disableAutofix: boolean;
+            })[];
+            "graphile-export/no-nested": (string | {
+                disableAutofix: boolean;
+            })[];
+        };
+    };
+};
+export declare const rules: {
+    "exhaustive-deps": import("eslint").Rule.RuleModule;
+    "export-methods": import("eslint").Rule.RuleModule;
+    "export-instances": import("eslint").Rule.RuleModule;
+    "export-subclasses": import("eslint").Rule.RuleModule;
+    "no-nested": import("eslint").Rule.RuleModule;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;CAgDnB,CAAC;AAEF,eAAO,MAAM,KAAK;;;;;;CAMjB,CAAC"}

package/dist/index.js

@@ -0,0 +1,66 @@
+"use strict";
+// Inspired by babel-plugin-react-hooks
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = 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 ExportSubclasses_js_1 = require("./ExportSubclasses.js");
+const NoNested_js_1 = require("./NoNested.js");
+exports.configs = {
+    recommended: {
+        plugins: ["graphile-export"],
+        rules: {
+            "graphile-export/exhaustive-deps": [
+                "error",
+                {
+                    disableAutofix: false,
+                    sortExports: true,
+                },
+            ],
+            "graphile-export/export-methods": [
+                "error",
+                {
+                    disableAutofix: false,
+                    methods: [
+                        "resolve",
+                        "subscribe",
+                        "plan",
+                        "subscribePlan",
+                        "isTypeOf",
+                        "resolveType",
+                        "serialize",
+                        "parseValue",
+                        "parseLiteral",
+                    ],
+                },
+            ],
+            "graphile-export/export-instances": [
+                "error",
+                {
+                    disableAutofix: false,
+                },
+            ],
+            "graphile-export/export-subclasses": [
+                "error",
+                {
+                    disableAutofix: false,
+                },
+            ],
+            "graphile-export/no-nested": [
+                "error",
+                {
+                    disableAutofix: false,
+                },
+            ],
+        },
+    },
+};
+exports.rules = {
+    "exhaustive-deps": ExhaustiveDeps_js_1.ExhaustiveDeps,
+    "export-methods": ExportMethods_js_1.ExportMethods,
+    "export-instances": ExportInstances_js_1.ExportInstances,
+    "export-subclasses": ExportSubclasses_js_1.ExportSubclasses,
+    "no-nested": NoNested_js_1.NoNested,
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,2DAAqD;AACrD,6DAAuD;AACvD,yDAAmD;AACnD,+DAAyD;AACzD,+CAAyC;AAE5B,QAAA,OAAO,GAAG;IACrB,WAAW,EAAE;QACX,OAAO,EAAE,CAAC,iBAAiB,CAAC;QAC5B,KAAK,EAAE;YACL,iCAAiC,EAAE;gBACjC,OAAO;gBACP;oBACE,cAAc,EAAE,KAAK;oBACrB,WAAW,EAAE,IAAI;iBAClB;aACF;YACD,gCAAgC,EAAE;gBAChC,OAAO;gBACP;oBACE,cAAc,EAAE,KAAK;oBACrB,OAAO,EAAE;wBACP,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,eAAe;wBACf,UAAU;wBACV,aAAa;wBACb,WAAW;wBACX,YAAY;wBACZ,cAAc;qBACf;iBACF;aACF;YACD,kCAAkC,EAAE;gBAClC,OAAO;gBACP;oBACE,cAAc,EAAE,KAAK;iBACtB;aACF;YACD,mCAAmC,EAAE;gBACnC,OAAO;gBACP;oBACE,cAAc,EAAE,KAAK;iBACtB;aACF;YACD,2BAA2B,EAAE;gBAC3B,OAAO;gBACP;oBACE,cAAc,EAAE,KAAK;iBACtB;aACF;SACF;KACF;CACF,CAAC;AAEW,QAAA,KAAK,GAAG;IACnB,iBAAiB,EAAE,kCAAc;IACjC,gBAAgB,EAAE,gCAAa;IAC/B,kBAAkB,EAAE,oCAAe;IACnC,mBAAmB,EAAE,sCAAgB;IACrC,WAAW,EAAE,sBAAQ;CACtB,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "eslint-plugin-graphile-export",
+  "version": "0.0.2-0.0",
+  "description": "ESLint plugin to help ensure your schema is exportable by graphile-export",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prepack": "tsc -b"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphile/heart.git"
+  },
+  "keywords": [
+    "eslint-plugin",
+    "graphile",
+    "exporter",
+    "schema",
+    "graphite"
+  ],
+  "author": "Benjie Gillam <code@benjiegillam.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/graphile/heart/issues"
+  },
+  "homepage": "https://graphile.org/",
+  "dependencies": {
+    "tslib": "^2.4.0"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "peerDependencies": {
+    "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@babel/types": "^7.16.0",
+    "@types/eslint": "^7.29.0",
+    "@types/estree": "^0.0.50",
+    "@types/jest": "^27.5.1",
+    "jest": "^28.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.1-rc"
+  }
+}