@prairielearn/eslint-plugin 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.d.ts +14 -10
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +18 -21
  5. package/dist/index.js.map +1 -1
  6. package/dist/rules/aws-client-mandatory-config.d.ts.map +1 -1
  7. package/dist/rules/aws-client-mandatory-config.js +4 -6
  8. package/dist/rules/aws-client-mandatory-config.js.map +1 -1
  9. package/dist/rules/aws-client-shared-config.d.ts.map +1 -1
  10. package/dist/rules/aws-client-shared-config.js +4 -6
  11. package/dist/rules/aws-client-shared-config.js.map +1 -1
  12. package/dist/rules/jsx-no-dollar-interpolation.d.ts.map +1 -1
  13. package/dist/rules/jsx-no-dollar-interpolation.js +2 -4
  14. package/dist/rules/jsx-no-dollar-interpolation.js.map +1 -1
  15. package/dist/rules/no-current-target-in-callback.d.ts.map +1 -1
  16. package/dist/rules/no-current-target-in-callback.js +2 -4
  17. package/dist/rules/no-current-target-in-callback.js.map +1 -1
  18. package/dist/rules/no-hydrate-reslocals.d.ts.map +1 -1
  19. package/dist/rules/no-hydrate-reslocals.js +2 -4
  20. package/dist/rules/no-hydrate-reslocals.js.map +1 -1
  21. package/dist/rules/no-unused-sql-blocks.d.ts.map +1 -1
  22. package/dist/rules/no-unused-sql-blocks.js +4 -39
  23. package/dist/rules/no-unused-sql-blocks.js.map +1 -1
  24. package/dist/rules/require-trpc-permission-middleware.d.ts +4 -0
  25. package/dist/rules/require-trpc-permission-middleware.d.ts.map +1 -0
  26. package/dist/rules/require-trpc-permission-middleware.js +133 -0
  27. package/dist/rules/require-trpc-permission-middleware.js.map +1 -0
  28. package/dist/rules/safe-db-types.d.ts +1 -1
  29. package/dist/rules/safe-db-types.d.ts.map +1 -1
  30. package/dist/rules/safe-db-types.js +6 -40
  31. package/dist/rules/safe-db-types.js.map +1 -1
  32. package/dist/tests/aws-client-mandatory-config.test.d.ts.map +1 -1
  33. package/dist/tests/aws-client-mandatory-config.test.js +8 -13
  34. package/dist/tests/aws-client-mandatory-config.test.js.map +1 -1
  35. package/dist/tests/aws-client-shared-config.test.d.ts.map +1 -1
  36. package/dist/tests/aws-client-shared-config.test.js +8 -13
  37. package/dist/tests/aws-client-shared-config.test.js.map +1 -1
  38. package/dist/tests/jsx-no-dollar-interpolation.test.d.ts.map +1 -1
  39. package/dist/tests/jsx-no-dollar-interpolation.test.js +8 -13
  40. package/dist/tests/jsx-no-dollar-interpolation.test.js.map +1 -1
  41. package/dist/tests/no-current-target-in-callback.test.js +8 -13
  42. package/dist/tests/no-current-target-in-callback.test.js.map +1 -1
  43. package/dist/tests/no-hydrate-reslocals.test.d.ts.map +1 -1
  44. package/dist/tests/no-hydrate-reslocals.test.js +8 -13
  45. package/dist/tests/no-hydrate-reslocals.test.js.map +1 -1
  46. package/dist/tests/require-trpc-permission-middleware.test.d.ts +2 -0
  47. package/dist/tests/require-trpc-permission-middleware.test.d.ts.map +1 -0
  48. package/dist/tests/require-trpc-permission-middleware.test.js +106 -0
  49. package/dist/tests/require-trpc-permission-middleware.test.js.map +1 -0
  50. package/dist/utils.js +1 -4
  51. package/dist/utils.js.map +1 -1
  52. package/package.json +10 -9
  53. package/src/index.ts +5 -1
  54. package/src/rules/require-trpc-permission-middleware.ts +168 -0
  55. package/src/tests/aws-client-mandatory-config.test.ts +1 -1
  56. package/src/tests/aws-client-shared-config.test.ts +1 -1
  57. package/src/tests/jsx-no-dollar-interpolation.test.ts +1 -1
  58. package/src/tests/no-hydrate-reslocals.test.ts +1 -1
  59. package/src/tests/require-trpc-permission-middleware.test.ts +109 -0
  60. package/tsconfig.json +1 -7
@@ -0,0 +1,106 @@
1
+ import { RuleTester } from '@typescript-eslint/rule-tester';
2
+ import { afterAll, describe, it } from 'vitest';
3
+ import rule from '../rules/require-trpc-permission-middleware.js';
4
+ RuleTester.afterAll = afterAll;
5
+ RuleTester.describe = describe;
6
+ RuleTester.it = it;
7
+ const ruleTester = new RuleTester();
8
+ ruleTester.run('require-trpc-permission-middleware', rule, {
9
+ valid: [
10
+ {
11
+ code: 'const list = t.procedure.use(requireCoursePermissionEdit).query(async () => {});',
12
+ },
13
+ {
14
+ code: 'const m = t.procedure.use(requireCoursePermissionPreview).mutation(async () => {});',
15
+ },
16
+ {
17
+ code: `const m = t.procedure
18
+ .use(requireEnhancedAccessControl)
19
+ .use(requireCourseInstancePermissionView)
20
+ .query(async () => {});`,
21
+ },
22
+ {
23
+ code: 'const m = t.procedure.use(requireAdministrator).mutation(async () => {});',
24
+ },
25
+ {
26
+ code: `const m = t.procedure
27
+ .use(requireCourseInstancePermissionEdit)
28
+ .input(z.object({}))
29
+ .mutation(async () => {});`,
30
+ },
31
+ {
32
+ code: 'const list = t.procedure.use(requireCoursePermissionOwn).query(async () => {});',
33
+ },
34
+ // Not a t.procedure chain — should be ignored
35
+ {
36
+ code: 'const fn = somethingElse.query(async () => {});',
37
+ },
38
+ {
39
+ code: 'const fn = otherRouter.procedure.query(async () => {});',
40
+ },
41
+ // Intermediate procedure-base variable: permission middleware on the base
42
+ {
43
+ code: `
44
+ const protectedProcedure = t.procedure.use(requireCoursePermissionOwn);
45
+ const m = protectedProcedure.query(async () => {});
46
+ `,
47
+ },
48
+ // Intermediate procedure-base variable: permission added downstream
49
+ {
50
+ code: `
51
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
52
+ const m = featureProcedure.use(requireAdministrator).mutation(async () => {});
53
+ `,
54
+ },
55
+ // Imported procedure base — we can't follow across files, so don't fire
56
+ {
57
+ code: `
58
+ import { protectedProcedure } from './foo.js';
59
+ const m = protectedProcedure.query(async () => {});
60
+ `,
61
+ languageOptions: { parserOptions: { sourceType: 'module' } },
62
+ },
63
+ ],
64
+ invalid: [
65
+ {
66
+ code: 'const list = t.procedure.query(async () => {});',
67
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
68
+ },
69
+ {
70
+ code: 'const m = t.procedure.input(z.object({})).mutation(async () => {});',
71
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
72
+ },
73
+ // Feature gate alone is not a permission gate
74
+ {
75
+ code: 'const m = t.procedure.use(requireEnhancedAccessControl).mutation(async () => {});',
76
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
77
+ },
78
+ {
79
+ code: 'const m = t.procedure.use(requireAiGradingFeature).mutation(async () => {});',
80
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
81
+ },
82
+ {
83
+ code: `const m = t.procedure
84
+ .input(z.object({}))
85
+ .output(z.object({}))
86
+ .subscription(async () => {});`,
87
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
88
+ },
89
+ // Intermediate procedure-base variable with only a feature gate is still a miss
90
+ {
91
+ code: `
92
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
93
+ const m = featureProcedure.query(async () => {});
94
+ `,
95
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
96
+ },
97
+ {
98
+ code: `
99
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
100
+ const m = featureProcedure.input(z.object({})).mutation(async () => {});
101
+ `,
102
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
103
+ },
104
+ ],
105
+ });
106
+ //# sourceMappingURL=require-trpc-permission-middleware.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-trpc-permission-middleware.test.js","sourceRoot":"","sources":["../../src/tests/require-trpc-permission-middleware.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEhD,OAAO,IAAI,MAAM,gDAAgD,CAAC;AAElE,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;AAEnB,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;AAEpC,UAAU,CAAC,GAAG,CAAC,oCAAoC,EAAE,IAAI,EAAE;IACzD,KAAK,EAAE;QACL;YACE,IAAI,EAAE,kFAAkF;SACzF;QACD;YACE,IAAI,EAAE,qFAAqF;SAC5F;QACD;YACE,IAAI,EAAE;;;gCAGoB;SAC3B;QACD;YACE,IAAI,EAAE,2EAA2E;SAClF;QACD;YACE,IAAI,EAAE;;;mCAGuB;SAC9B;QACD;YACE,IAAI,EAAE,iFAAiF;SACxF;QACD,8CAA8C;QAC9C;YACE,IAAI,EAAE,iDAAiD;SACxD;QACD;YACE,IAAI,EAAE,yDAAyD;SAChE;QACD,0EAA0E;QAC1E;YACE,IAAI,EAAE;;;OAGL;SACF;QACD,oEAAoE;QACpE;YACE,IAAI,EAAE;;;OAGL;SACF;QACD,wEAAwE;QACxE;YACE,IAAI,EAAE;;;OAGL;YACD,eAAe,EAAE,EAAE,aAAa,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;SAC7D;KACF;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD;YACE,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD,8CAA8C;QAC9C;YACE,IAAI,EAAE,mFAAmF;YACzF,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD;YACE,IAAI,EAAE,8EAA8E;YACpF,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD;YACE,IAAI,EAAE;;;uCAG2B;YACjC,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD,gFAAgF;QAChF;YACE,IAAI,EAAE;;;OAGL;YACD,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;QACD;YACE,IAAI,EAAE;;;OAGL;YACD,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,6BAA6B,EAAE,CAAC;SACvD;KACF;CACF,CAAC,CAAC","sourcesContent":["import { RuleTester } from '@typescript-eslint/rule-tester';\nimport { afterAll, describe, it } from 'vitest';\n\nimport rule from '../rules/require-trpc-permission-middleware.js';\n\nRuleTester.afterAll = afterAll;\nRuleTester.describe = describe;\nRuleTester.it = it;\n\nconst ruleTester = new RuleTester();\n\nruleTester.run('require-trpc-permission-middleware', rule, {\n valid: [\n {\n code: 'const list = t.procedure.use(requireCoursePermissionEdit).query(async () => {});',\n },\n {\n code: 'const m = t.procedure.use(requireCoursePermissionPreview).mutation(async () => {});',\n },\n {\n code: `const m = t.procedure\n .use(requireEnhancedAccessControl)\n .use(requireCourseInstancePermissionView)\n .query(async () => {});`,\n },\n {\n code: 'const m = t.procedure.use(requireAdministrator).mutation(async () => {});',\n },\n {\n code: `const m = t.procedure\n .use(requireCourseInstancePermissionEdit)\n .input(z.object({}))\n .mutation(async () => {});`,\n },\n {\n code: 'const list = t.procedure.use(requireCoursePermissionOwn).query(async () => {});',\n },\n // Not a t.procedure chain — should be ignored\n {\n code: 'const fn = somethingElse.query(async () => {});',\n },\n {\n code: 'const fn = otherRouter.procedure.query(async () => {});',\n },\n // Intermediate procedure-base variable: permission middleware on the base\n {\n code: `\n const protectedProcedure = t.procedure.use(requireCoursePermissionOwn);\n const m = protectedProcedure.query(async () => {});\n `,\n },\n // Intermediate procedure-base variable: permission added downstream\n {\n code: `\n const featureProcedure = t.procedure.use(requireAiGradingFeature);\n const m = featureProcedure.use(requireAdministrator).mutation(async () => {});\n `,\n },\n // Imported procedure base — we can't follow across files, so don't fire\n {\n code: `\n import { protectedProcedure } from './foo.js';\n const m = protectedProcedure.query(async () => {});\n `,\n languageOptions: { parserOptions: { sourceType: 'module' } },\n },\n ],\n invalid: [\n {\n code: 'const list = t.procedure.query(async () => {});',\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n {\n code: 'const m = t.procedure.input(z.object({})).mutation(async () => {});',\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n // Feature gate alone is not a permission gate\n {\n code: 'const m = t.procedure.use(requireEnhancedAccessControl).mutation(async () => {});',\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n {\n code: 'const m = t.procedure.use(requireAiGradingFeature).mutation(async () => {});',\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n {\n code: `const m = t.procedure\n .input(z.object({}))\n .output(z.object({}))\n .subscription(async () => {});`,\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n // Intermediate procedure-base variable with only a feature gate is still a miss\n {\n code: `\n const featureProcedure = t.procedure.use(requireAiGradingFeature);\n const m = featureProcedure.query(async () => {});\n `,\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n {\n code: `\n const featureProcedure = t.procedure.use(requireAiGradingFeature);\n const m = featureProcedure.input(z.object({})).mutation(async () => {});\n `,\n errors: [{ messageId: 'missingPermissionMiddleware' }],\n },\n ],\n});\n"]}
package/dist/utils.js CHANGED
@@ -1,6 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getAwsClientNamesFromImportDeclaration = getAwsClientNamesFromImportDeclaration;
4
1
  /**
5
2
  * Determines if the given identifier name corresponds to a client from the
6
3
  * given package.
@@ -29,7 +26,7 @@ function isIdentifierClient(identifierName, packageName) {
29
26
  *
30
27
  * then this function will return a set containing the strings "S3" and "S3Client".
31
28
  */
32
- function getAwsClientNamesFromImportDeclaration(node) {
29
+ export function getAwsClientNamesFromImportDeclaration(node) {
33
30
  const clientNames = new Set();
34
31
  const importSource = node.source.value;
35
32
  if (importSource.startsWith('@aws-sdk/client-')) {
package/dist/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAS,kBAAkB,CAAC,cAAsB,EAAE,WAAmB;IACrE,+DAA+D;IAC/D,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8EAA8E;IAC9E,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACvE,IAAI,cAAc,CAAC,WAAW,EAAE,KAAK,iBAAiB,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,gDAAuD,IAAS;IAC9D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvC,IAAI,YAAY,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAc,EAAE,EAAE;YACzC,IAAI,SAAS,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACzC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC9C,IAAI,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC;oBACpD,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["/**\n * Determines if the given identifier name corresponds to a client from the\n * given package.\n */\nfunction isIdentifierClient(identifierName: string, packageName: string): boolean {\n // If the identifier ends with \"Client\", include it in the set.\n if (identifierName.endsWith('Client')) {\n return true;\n }\n\n // If the identifier matches the package name directly, include it in the set.\n const clientName = packageName.replace('@aws-sdk/client-', '');\n const packageIdentifier = clientName.replaceAll('-', '').toLowerCase();\n if (identifierName.toLowerCase() === packageIdentifier) {\n return true;\n }\n\n return false;\n}\n\n/**\n * Retrieves the names of AWS clients specified by the given import declaration.\n *\n * For instance, if the import declaration is:\n *\n * ```ts\n * import { S3, S3Client } from '@aws-sdk/client-s3';\n * ```\n *\n * then this function will return a set containing the strings \"S3\" and \"S3Client\".\n */\nexport function getAwsClientNamesFromImportDeclaration(node: any) {\n const clientNames = new Set<string>();\n\n const importSource = node.source.value;\n if (importSource.startsWith('@aws-sdk/client-')) {\n node.specifiers.forEach((specifier: any) => {\n if (specifier.type === 'ImportSpecifier') {\n const specifierName = specifier.imported.name;\n if (isIdentifierClient(specifierName, importSource)) {\n clientNames.add(specifierName);\n }\n }\n });\n }\n\n return clientNames;\n}\n"]}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,SAAS,kBAAkB,CAAC,cAAsB,EAAE,WAAmB;IACrE,+DAA+D;IAC/D,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8EAA8E;IAC9E,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACvE,IAAI,cAAc,CAAC,WAAW,EAAE,KAAK,iBAAiB,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,sCAAsC,CAAC,IAAS;IAC9D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvC,IAAI,YAAY,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAc,EAAE,EAAE;YACzC,IAAI,SAAS,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACzC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC9C,IAAI,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC;oBACpD,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["/**\n * Determines if the given identifier name corresponds to a client from the\n * given package.\n */\nfunction isIdentifierClient(identifierName: string, packageName: string): boolean {\n // If the identifier ends with \"Client\", include it in the set.\n if (identifierName.endsWith('Client')) {\n return true;\n }\n\n // If the identifier matches the package name directly, include it in the set.\n const clientName = packageName.replace('@aws-sdk/client-', '');\n const packageIdentifier = clientName.replaceAll('-', '').toLowerCase();\n if (identifierName.toLowerCase() === packageIdentifier) {\n return true;\n }\n\n return false;\n}\n\n/**\n * Retrieves the names of AWS clients specified by the given import declaration.\n *\n * For instance, if the import declaration is:\n *\n * ```ts\n * import { S3, S3Client } from '@aws-sdk/client-s3';\n * ```\n *\n * then this function will return a set containing the strings \"S3\" and \"S3Client\".\n */\nexport function getAwsClientNamesFromImportDeclaration(node: any) {\n const clientNames = new Set<string>();\n\n const importSource = node.source.value;\n if (importSource.startsWith('@aws-sdk/client-')) {\n node.specifiers.forEach((specifier: any) => {\n if (specifier.type === 'ImportSpecifier') {\n const specifierName = specifier.imported.name;\n if (isIdentifierClient(specifierName, importSource)) {\n clientNames.add(specifierName);\n }\n }\n });\n }\n\n return clientNames;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@prairielearn/eslint-plugin",
3
- "version": "4.1.0",
3
+ "version": "4.2.0",
4
+ "type": "module",
4
5
  "repository": {
5
6
  "type": "git",
6
7
  "url": "https://github.com/PrairieLearn/PrairieLearn.git",
@@ -19,17 +20,17 @@
19
20
  "eslint": "^10.0.0"
20
21
  },
21
22
  "dependencies": {
22
- "@typescript-eslint/utils": "^8.58.0",
23
- "typescript": "^5.9.3"
23
+ "@typescript-eslint/utils": "^8.59.2",
24
+ "typescript": "^6.0.3"
24
25
  },
25
26
  "devDependencies": {
26
- "@prairielearn/tsconfig": "^2.0.0",
27
+ "@prairielearn/tsconfig": "^2.1.0",
27
28
  "@types/node": "^24.12.2",
28
- "@typescript-eslint/rule-tester": "^8.58.0",
29
- "@typescript-eslint/types": "^8.58.0",
30
- "@typescript/native-preview": "^7.0.0-dev.20260305.1",
31
- "@vitest/coverage-v8": "^4.1.2",
29
+ "@typescript-eslint/rule-tester": "^8.59.2",
30
+ "@typescript-eslint/types": "^8.59.2",
31
+ "@typescript/native-preview": "beta",
32
+ "@vitest/coverage-v8": "^4.1.5",
32
33
  "tsx": "^4.21.0",
33
- "vitest": "^4.1.2"
34
+ "vitest": "^4.1.5"
34
35
  }
35
36
  }
package/src/index.ts CHANGED
@@ -4,14 +4,18 @@ import jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';
4
4
  import noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';
5
5
  import noHydrateResLocals from './rules/no-hydrate-reslocals.js';
6
6
  import noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';
7
+ import requireTrpcPermissionMiddleware from './rules/require-trpc-permission-middleware.js';
7
8
  import safeDbTypes from './rules/safe-db-types.js';
8
9
 
9
- export const rules = {
10
+ const rules = {
10
11
  'aws-client-mandatory-config': awsClientMandatoryConfig,
11
12
  'aws-client-shared-config': awsClientSharedConfig,
12
13
  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,
13
14
  'no-current-target-in-callback': noCurrentTargetInCallback,
14
15
  'no-hydrate-reslocals': noHydrateResLocals,
15
16
  'no-unused-sql-blocks': noUnusedSqlBlocks,
17
+ 'require-trpc-permission-middleware': requireTrpcPermissionMiddleware,
16
18
  'safe-db-types': safeDbTypes,
17
19
  };
20
+
21
+ export default { rules };
@@ -0,0 +1,168 @@
1
+ import { ASTUtils, ESLintUtils, type TSESLint, type TSESTree } from '@typescript-eslint/utils';
2
+
3
+ const { findVariable } = ASTUtils;
4
+
5
+ /**
6
+ * tRPC procedures must enforce their own authorization via a `require*`
7
+ * permission middleware in the chain.
8
+ * Individual procedures often need stricter permissions than the page they're
9
+ * mounted under (e.g. an Edit-only mutation under a route that allows View).
10
+ * Requiring an explicit permission middleware per procedure makes the
11
+ * authz gate visible at the call site and helps prevent missing permission checks.
12
+ *
13
+ * Bad:
14
+ * ```ts
15
+ * const list = t.procedure.query(async ({ ctx }) => { ... });
16
+ * ```
17
+ *
18
+ * Good:
19
+ * ```ts
20
+ * const list = t.procedure.use(requireCoursePermissionEdit).query(...);
21
+ * ```
22
+ *
23
+ * Recognized permission middlewares:
24
+ * - requireCoursePermissionPreview / View / Edit / Own
25
+ * - requireCourseInstancePermissionPreview / View / Edit / Own
26
+ * - requireAdministrator
27
+ *
28
+ * Feature gates like `requireEnhancedAccessControl` and `requireAiGradingFeature`
29
+ * don't count — they must be paired with a permission middleware.
30
+ *
31
+ * The rule follows intermediate procedure-base variables so patterns like
32
+ * `const protected = t.procedure.use(...); ...; protected.query(...)` are
33
+ * checked end-to-end.
34
+ */
35
+
36
+ // TODO: This list requires manual maintenance. We should consider making feature gates
37
+ // not use the `require` prefix, and then we can use a more generic pattern here.
38
+ const PERMISSION_MIDDLEWARE_PATTERN =
39
+ /^require(Course|CourseInstance)Permission(Preview|View|Edit|Own)$|^requireAdministrator$/;
40
+ const TERMINAL_METHODS = new Set(['query', 'mutation', 'subscription']);
41
+
42
+ function unwrapMemberObject(expr: TSESTree.Expression): TSESTree.Expression {
43
+ return expr.type === 'TSNonNullExpression' || expr.type === 'TSAsExpression'
44
+ ? unwrapMemberObject(expr.expression)
45
+ : expr;
46
+ }
47
+
48
+ function isTProcedure(expr: TSESTree.Expression): boolean {
49
+ return (
50
+ expr.type === 'MemberExpression' &&
51
+ !expr.computed &&
52
+ expr.property.type === 'Identifier' &&
53
+ expr.property.name === 'procedure' &&
54
+ expr.object.type === 'Identifier' &&
55
+ expr.object.name === 't'
56
+ );
57
+ }
58
+
59
+ interface ChainInfo {
60
+ matchesTProcedure: boolean;
61
+ middlewares: string[];
62
+ }
63
+
64
+ /**
65
+ * Walks back through a chain like `expr.use(A).input(B).use(C)` collecting
66
+ * `.use(...)` argument identifiers. If the base of the chain is `t.procedure`,
67
+ * returns the collected middlewares. If the base is a variable, follows the
68
+ * variable's initializer (e.g. `const protected = t.procedure.use(X)`).
69
+ */
70
+ function getProcedureChainInfo(
71
+ expr: TSESTree.Expression,
72
+ scope: TSESLint.Scope.Scope,
73
+ visited: Set<TSESTree.Node>,
74
+ ): ChainInfo {
75
+ if (visited.has(expr)) return { matchesTProcedure: false, middlewares: [] };
76
+ visited.add(expr);
77
+
78
+ const middlewares: string[] = [];
79
+ let cursor: TSESTree.Expression = expr;
80
+
81
+ while (cursor.type === 'CallExpression') {
82
+ const callee = cursor.callee;
83
+ if (
84
+ callee.type !== 'MemberExpression' ||
85
+ callee.computed ||
86
+ callee.property.type !== 'Identifier'
87
+ ) {
88
+ return { matchesTProcedure: false, middlewares: [] };
89
+ }
90
+ if (callee.property.name === 'use' && cursor.arguments[0]?.type === 'Identifier') {
91
+ middlewares.push(cursor.arguments[0].name);
92
+ }
93
+ cursor = callee.object;
94
+ }
95
+
96
+ cursor = unwrapMemberObject(cursor);
97
+
98
+ if (isTProcedure(cursor)) {
99
+ return { matchesTProcedure: true, middlewares };
100
+ }
101
+
102
+ // Follow an intermediate procedure-base variable defined in the same module:
103
+ // const protectedProcedure = t.procedure.use(...);
104
+ // protectedProcedure.query(...);
105
+ if (cursor.type === 'Identifier') {
106
+ const variable = findVariable(scope, cursor);
107
+ if (variable && variable.defs.length === 1) {
108
+ const def = variable.defs[0];
109
+ if (
110
+ def.node.type === 'VariableDeclarator' &&
111
+ def.node.init &&
112
+ // Conservative: only follow `const` bindings to avoid stale data
113
+ // from let/var rebinding.
114
+ def.parent?.type === 'VariableDeclaration' &&
115
+ def.parent.kind === 'const'
116
+ ) {
117
+ const upstream = getProcedureChainInfo(def.node.init, scope, visited);
118
+ if (upstream.matchesTProcedure) {
119
+ return {
120
+ matchesTProcedure: true,
121
+ middlewares: [...middlewares, ...upstream.middlewares],
122
+ };
123
+ }
124
+ }
125
+ }
126
+ }
127
+
128
+ return { matchesTProcedure: false, middlewares: [] };
129
+ }
130
+
131
+ export default ESLintUtils.RuleCreator.withoutDocs({
132
+ meta: {
133
+ type: 'problem',
134
+ messages: {
135
+ missingPermissionMiddleware:
136
+ 'tRPC procedure must call .use() with a permission middleware (e.g. requireCoursePermissionEdit)',
137
+ },
138
+ schema: [],
139
+ },
140
+ defaultOptions: [],
141
+
142
+ create(context) {
143
+ return {
144
+ CallExpression(node) {
145
+ if (
146
+ node.callee.type !== 'MemberExpression' ||
147
+ node.callee.computed ||
148
+ node.callee.property.type !== 'Identifier' ||
149
+ !TERMINAL_METHODS.has(node.callee.property.name)
150
+ ) {
151
+ return;
152
+ }
153
+
154
+ const scope = context.sourceCode.getScope(node);
155
+ const info = getProcedureChainInfo(node.callee.object, scope, new Set());
156
+
157
+ if (!info.matchesTProcedure) return;
158
+
159
+ const hasPermissionGate = info.middlewares.some((name) =>
160
+ PERMISSION_MIDDLEWARE_PATTERN.test(name),
161
+ );
162
+ if (!hasPermissionGate) {
163
+ context.report({ node, messageId: 'missingPermissionMiddleware' });
164
+ }
165
+ },
166
+ };
167
+ },
168
+ });
@@ -1,7 +1,7 @@
1
1
  import { RuleTester } from '@typescript-eslint/rule-tester';
2
2
  import { afterAll, describe, it } from 'vitest';
3
3
 
4
- import rule from '../rules/aws-client-mandatory-config';
4
+ import rule from '../rules/aws-client-mandatory-config.js';
5
5
 
6
6
  RuleTester.afterAll = afterAll;
7
7
  RuleTester.describe = describe;
@@ -1,7 +1,7 @@
1
1
  import { RuleTester } from '@typescript-eslint/rule-tester';
2
2
  import { afterAll, describe, it } from 'vitest';
3
3
 
4
- import rule from '../rules/aws-client-shared-config';
4
+ import rule from '../rules/aws-client-shared-config.js';
5
5
 
6
6
  RuleTester.afterAll = afterAll;
7
7
  RuleTester.describe = describe;
@@ -1,7 +1,7 @@
1
1
  import { RuleTester } from '@typescript-eslint/rule-tester';
2
2
  import { afterAll, describe, it } from 'vitest';
3
3
 
4
- import rule from '../rules/jsx-no-dollar-interpolation';
4
+ import rule from '../rules/jsx-no-dollar-interpolation.js';
5
5
 
6
6
  RuleTester.afterAll = afterAll;
7
7
  RuleTester.describe = describe;
@@ -1,7 +1,7 @@
1
1
  import { RuleTester } from '@typescript-eslint/rule-tester';
2
2
  import { afterAll, describe, it } from 'vitest';
3
3
 
4
- import rule from '../rules/no-hydrate-reslocals';
4
+ import rule from '../rules/no-hydrate-reslocals.js';
5
5
 
6
6
  RuleTester.afterAll = afterAll;
7
7
  RuleTester.describe = describe;
@@ -0,0 +1,109 @@
1
+ import { RuleTester } from '@typescript-eslint/rule-tester';
2
+ import { afterAll, describe, it } from 'vitest';
3
+
4
+ import rule from '../rules/require-trpc-permission-middleware.js';
5
+
6
+ RuleTester.afterAll = afterAll;
7
+ RuleTester.describe = describe;
8
+ RuleTester.it = it;
9
+
10
+ const ruleTester = new RuleTester();
11
+
12
+ ruleTester.run('require-trpc-permission-middleware', rule, {
13
+ valid: [
14
+ {
15
+ code: 'const list = t.procedure.use(requireCoursePermissionEdit).query(async () => {});',
16
+ },
17
+ {
18
+ code: 'const m = t.procedure.use(requireCoursePermissionPreview).mutation(async () => {});',
19
+ },
20
+ {
21
+ code: `const m = t.procedure
22
+ .use(requireEnhancedAccessControl)
23
+ .use(requireCourseInstancePermissionView)
24
+ .query(async () => {});`,
25
+ },
26
+ {
27
+ code: 'const m = t.procedure.use(requireAdministrator).mutation(async () => {});',
28
+ },
29
+ {
30
+ code: `const m = t.procedure
31
+ .use(requireCourseInstancePermissionEdit)
32
+ .input(z.object({}))
33
+ .mutation(async () => {});`,
34
+ },
35
+ {
36
+ code: 'const list = t.procedure.use(requireCoursePermissionOwn).query(async () => {});',
37
+ },
38
+ // Not a t.procedure chain — should be ignored
39
+ {
40
+ code: 'const fn = somethingElse.query(async () => {});',
41
+ },
42
+ {
43
+ code: 'const fn = otherRouter.procedure.query(async () => {});',
44
+ },
45
+ // Intermediate procedure-base variable: permission middleware on the base
46
+ {
47
+ code: `
48
+ const protectedProcedure = t.procedure.use(requireCoursePermissionOwn);
49
+ const m = protectedProcedure.query(async () => {});
50
+ `,
51
+ },
52
+ // Intermediate procedure-base variable: permission added downstream
53
+ {
54
+ code: `
55
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
56
+ const m = featureProcedure.use(requireAdministrator).mutation(async () => {});
57
+ `,
58
+ },
59
+ // Imported procedure base — we can't follow across files, so don't fire
60
+ {
61
+ code: `
62
+ import { protectedProcedure } from './foo.js';
63
+ const m = protectedProcedure.query(async () => {});
64
+ `,
65
+ languageOptions: { parserOptions: { sourceType: 'module' } },
66
+ },
67
+ ],
68
+ invalid: [
69
+ {
70
+ code: 'const list = t.procedure.query(async () => {});',
71
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
72
+ },
73
+ {
74
+ code: 'const m = t.procedure.input(z.object({})).mutation(async () => {});',
75
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
76
+ },
77
+ // Feature gate alone is not a permission gate
78
+ {
79
+ code: 'const m = t.procedure.use(requireEnhancedAccessControl).mutation(async () => {});',
80
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
81
+ },
82
+ {
83
+ code: 'const m = t.procedure.use(requireAiGradingFeature).mutation(async () => {});',
84
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
85
+ },
86
+ {
87
+ code: `const m = t.procedure
88
+ .input(z.object({}))
89
+ .output(z.object({}))
90
+ .subscription(async () => {});`,
91
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
92
+ },
93
+ // Intermediate procedure-base variable with only a feature gate is still a miss
94
+ {
95
+ code: `
96
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
97
+ const m = featureProcedure.query(async () => {});
98
+ `,
99
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
100
+ },
101
+ {
102
+ code: `
103
+ const featureProcedure = t.procedure.use(requireAiGradingFeature);
104
+ const m = featureProcedure.input(z.object({})).mutation(async () => {});
105
+ `,
106
+ errors: [{ messageId: 'missingPermissionMiddleware' }],
107
+ },
108
+ ],
109
+ });
package/tsconfig.json CHANGED
@@ -1,9 +1,3 @@
1
1
  {
2
- // This must be a CJS package because ESLint doesn't support ESM plugins.
3
- "extends": "@prairielearn/tsconfig/tsconfig.package-cjs.json",
4
- "compilerOptions": {
5
- "outDir": "./dist",
6
- "rootDir": "./src",
7
- "types": ["node"]
8
- }
2
+ "extends": "@prairielearn/tsconfig/tsconfig.package-node.json"
9
3
  }