@prairielearn/eslint-plugin 2.1.6 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @prairielearn/eslint-plugin
 
+## 2.2.0
+
+### Minor Changes
+
+- edcd248: Introduce `no-unused-sql-blocks` lint rule
+
+## 2.1.7
+
+### Patch Changes
+
+- 678b48a: Upgrade all JavaScript dependencies
+
 ## 2.1.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export declare const rules: {
     'aws-client-mandatory-config': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingConfig", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     'aws-client-shared-config': import("@typescript-eslint/utils/ts-eslint").RuleModule<"improperConfig" | "unknownConfig", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     'jsx-no-dollar-interpolation': import("@typescript-eslint/utils/ts-eslint").RuleModule<"dollarInterpolationNotAllowed", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    'no-unused-sql-blocks': import("@typescript-eslint/utils/ts-eslint").RuleModule<"unusedSqlBlock", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 };

package/dist/index.js

@@ -4,9 +4,11 @@ exports.rules = void 0;
 const aws_client_mandatory_config_js_1 = require("./rules/aws-client-mandatory-config.js");
 const aws_client_shared_config_js_1 = require("./rules/aws-client-shared-config.js");
 const jsx_no_dollar_interpolation_js_1 = require("./rules/jsx-no-dollar-interpolation.js");
+const no_unused_sql_blocks_js_1 = require("./rules/no-unused-sql-blocks.js");
 exports.rules = {
     'aws-client-mandatory-config': aws_client_mandatory_config_js_1.default,
     'aws-client-shared-config': aws_client_shared_config_js_1.default,
     'jsx-no-dollar-interpolation': jsx_no_dollar_interpolation_js_1.default,
+    'no-unused-sql-blocks': no_unused_sql_blocks_js_1.default,
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2FAA8E;AAC9E,qFAAwE;AACxE,2FAA8E;AAEjE,QAAA,KAAK,GAAG;IACnB,6BAA6B,EAAE,wCAAwB;IACvD,0BAA0B,EAAE,qCAAqB;IACjD,6BAA6B,EAAE,wCAAwB;CACxD,CAAC","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\n\nexport const rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2FAA8E;AAC9E,qFAAwE;AACxE,2FAA8E;AAC9E,6EAAgE;AAEnD,QAAA,KAAK,GAAG;IACnB,6BAA6B,EAAE,wCAAwB;IACvD,0BAA0B,EAAE,qCAAqB;IACjD,6BAA6B,EAAE,wCAAwB;IACvD,sBAAsB,EAAE,iCAAiB;CAC1C,CAAC","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\nimport noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';\n\nexport const rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n  'no-unused-sql-blocks': noUnusedSqlBlocks,\n};\n"]}

package/dist/rules/no-unused-sql-blocks.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+declare const _default: ESLintUtils.RuleModule<"unusedSqlBlock", [], unknown, ESLintUtils.RuleListener>;
+export default _default;

package/dist/rules/no-unused-sql-blocks.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const utils_1 = require("@typescript-eslint/utils");
+function extractSqlBlockDefinitions(sqlContent) {
+    const regex = / *-- *BLOCK +([^ \n]+) */g;
+    const defs = new Set();
+    let match;
+    while ((match = regex.exec(sqlContent)) !== null) {
+        defs.add(match[1]);
+    }
+    return defs;
+}
+function extractSqlBlockReferences(tsContent) {
+    const regex = /sql\.([a-zA-Z0-9_]+)/g;
+    const refs = new Set();
+    let match;
+    while ((match = regex.exec(tsContent)) !== null) {
+        refs.add(match[1]);
+    }
+    return refs;
+}
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    meta: {
+        type: 'problem',
+        messages: {
+            unusedSqlBlock: 'SQL block "{{block}}" in "{{sqlFile}}" is not used in this file and should be deleted.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        const components = path.parse(context.filename);
+        components.ext = '.sql';
+        const sqlFile = path.join(components.dir, components.name) + components.ext;
+        if (!fs.existsSync(sqlFile))
+            return {};
+        const tsContent = fs.readFileSync(context.filename, 'utf8');
+        const sqlContent = fs.readFileSync(sqlFile, 'utf8');
+        const usedBlocks = extractSqlBlockReferences(tsContent);
+        const definedBlocks = extractSqlBlockDefinitions(sqlContent);
+        const unusedBlocks = [...definedBlocks].filter((block) => !usedBlocks.has(block));
+        return {
+            Program(node) {
+                for (const block of unusedBlocks) {
+                    context.report({
+                        node,
+                        loc: {
+                            start: { line: 1, column: 1 },
+                            end: { line: 2, column: 0 },
+                        },
+                        messageId: 'unusedSqlBlock',
+                        data: { block, sqlFile: path.basename(sqlFile) },
+                    });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=no-unused-sql-blocks.js.map

package/dist/rules/no-unused-sql-blocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-unused-sql-blocks.js","sourceRoot":"","sources":["../../src/rules/no-unused-sql-blocks.ts"],"names":[],"mappings":";;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,oDAAuD;AAEvD,SAAS,0BAA0B,CAAC,UAAkB;IACpD,MAAM,KAAK,GAAG,2BAA2B,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,KAAK,CAAC;IACV,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,yBAAyB,CAAC,SAAiB;IAClD,MAAM,KAAK,GAAG,uBAAuB,CAAC;IACtC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,KAAK,CAAC;IACV,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,kBAAe,mBAAW,CAAC,WAAW,CAAC,WAAW,CAAC;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE;YACR,cAAc,EACZ,wFAAwF;SAC3F;QACD,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,UAAU,CAAC,GAAG,GAAG,MAAM,CAAC;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;QAC5E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YAAE,OAAO,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;QAE7D,MAAM,YAAY,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAElF,OAAO;YACL,OAAO,CAAC,IAAI;gBACV,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;oBACjC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,GAAG,EAAE;4BACH,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;4BAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;yBAC5B;wBACD,SAAS,EAAE,gBAAgB;wBAC3B,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;qBACjD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\n\nimport { ESLintUtils } from '@typescript-eslint/utils';\n\nfunction extractSqlBlockDefinitions(sqlContent: string): Set<string> {\n  const regex = / *-- *BLOCK +([^ \\n]+) */g;\n  const defs = new Set<string>();\n  let match;\n  while ((match = regex.exec(sqlContent)) !== null) {\n    defs.add(match[1]);\n  }\n  return defs;\n}\n\nfunction extractSqlBlockReferences(tsContent: string): Set<string> {\n  const regex = /sql\\.([a-zA-Z0-9_]+)/g;\n  const refs = new Set<string>();\n  let match;\n  while ((match = regex.exec(tsContent)) !== null) {\n    refs.add(match[1]);\n  }\n  return refs;\n}\n\nexport default ESLintUtils.RuleCreator.withoutDocs({\n  meta: {\n    type: 'problem',\n    messages: {\n      unusedSqlBlock:\n        'SQL block \"{{block}}\" in \"{{sqlFile}}\" is not used in this file and should be deleted.',\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n  create(context) {\n    const components = path.parse(context.filename);\n    components.ext = '.sql';\n    const sqlFile = path.join(components.dir, components.name) + components.ext;\n    if (!fs.existsSync(sqlFile)) return {};\n    const tsContent = fs.readFileSync(context.filename, 'utf8');\n    const sqlContent = fs.readFileSync(sqlFile, 'utf8');\n\n    const usedBlocks = extractSqlBlockReferences(tsContent);\n    const definedBlocks = extractSqlBlockDefinitions(sqlContent);\n\n    const unusedBlocks = [...definedBlocks].filter((block) => !usedBlocks.has(block));\n\n    return {\n      Program(node) {\n        for (const block of unusedBlocks) {\n          context.report({\n            node,\n            loc: {\n              start: { line: 1, column: 1 },\n              end: { line: 2, column: 0 },\n            },\n            messageId: 'unusedSqlBlock',\n            data: { block, sqlFile: path.basename(sqlFile) },\n          });\n        }\n      },\n    };\n  },\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/eslint-plugin",
-  "version": "2.1.6",
+  "version": "2.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/PrairieLearn/PrairieLearn.git",
@@ -13,15 +13,15 @@
     "test": "vitest run --coverage"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^8.33.1"
+    "@typescript-eslint/utils": "^8.35.1"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
-    "@types/node": "^20.17.57",
-    "@typescript-eslint/rule-tester": "^8.33.1",
-    "@vitest/coverage-v8": "^3.2.1",
-    "tsx": "^4.19.4",
+    "@types/node": "^22.15.34",
+    "@typescript-eslint/rule-tester": "^8.35.1",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsx": "^4.20.3",
     "typescript": "^5.8.3",
-    "vitest": "^3.2.1"
+    "vitest": "^3.2.4"
   }
 }

package/src/index.ts

@@ -1,9 +1,11 @@
 import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';
 import awsClientSharedConfig from './rules/aws-client-shared-config.js';
 import jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';
+import noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';
 
 export const rules = {
   'aws-client-mandatory-config': awsClientMandatoryConfig,
   'aws-client-shared-config': awsClientSharedConfig,
   'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,
+  'no-unused-sql-blocks': noUnusedSqlBlocks,
 };

package/src/rules/no-unused-sql-blocks.ts

@@ -0,0 +1,65 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+function extractSqlBlockDefinitions(sqlContent: string): Set<string> {
+  const regex = / *-- *BLOCK +([^ \n]+) */g;
+  const defs = new Set<string>();
+  let match;
+  while ((match = regex.exec(sqlContent)) !== null) {
+    defs.add(match[1]);
+  }
+  return defs;
+}
+
+function extractSqlBlockReferences(tsContent: string): Set<string> {
+  const regex = /sql\.([a-zA-Z0-9_]+)/g;
+  const refs = new Set<string>();
+  let match;
+  while ((match = regex.exec(tsContent)) !== null) {
+    refs.add(match[1]);
+  }
+  return refs;
+}
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  meta: {
+    type: 'problem',
+    messages: {
+      unusedSqlBlock:
+        'SQL block "{{block}}" in "{{sqlFile}}" is not used in this file and should be deleted.',
+    },
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const components = path.parse(context.filename);
+    components.ext = '.sql';
+    const sqlFile = path.join(components.dir, components.name) + components.ext;
+    if (!fs.existsSync(sqlFile)) return {};
+    const tsContent = fs.readFileSync(context.filename, 'utf8');
+    const sqlContent = fs.readFileSync(sqlFile, 'utf8');
+
+    const usedBlocks = extractSqlBlockReferences(tsContent);
+    const definedBlocks = extractSqlBlockDefinitions(sqlContent);
+
+    const unusedBlocks = [...definedBlocks].filter((block) => !usedBlocks.has(block));
+
+    return {
+      Program(node) {
+        for (const block of unusedBlocks) {
+          context.report({
+            node,
+            loc: {
+              start: { line: 1, column: 1 },
+              end: { line: 2, column: 0 },
+            },
+            messageId: 'unusedSqlBlock',
+            data: { block, sqlFile: path.basename(sqlFile) },
+          });
+        }
+      },
+    };
+  },
+});

package/.mocharc.cjs

@@ -1,3 +0,0 @@
-module.exports = {
-  require: ['tsx'],
-};