Extends the conformance ESLint layer with the consent-check rule:
- `no-undeclared-consent-check` (warn): `consent.isGranted("X")` in a
use-case file must match a category declared in `manifest.requiresConsent`;
also warns when requiresConsent is declared but no isGranted call is found.
- `_manifest-ast.js`: adds `parseManifestFully` which extracts top-level
`name`, `requiredCores`, `requiresConsent`, and per-use-case maps from the
manifest AST; `requiresConsent` extraction tested in `_manifest-ast.test.js`.
- `_rule-context.js` / `_rule-schema.js`: shared helpers extracted from the
existing per-rule files so the new rule can resolve use-case name + feature
root without duplication.
- Existing rules (`no-undeclared-audit`, `no-undeclared-event-publish`,
`no-undeclared-analytics-event`) updated to use the shared helpers.
- `plugin.js` + `base.js` register the rule at warn severity.
- CLAUDE.md + conformance-quickref.md: rule count advanced from 11 → 12.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
150 lines
4.2 KiB
JavaScript
150 lines
4.2 KiB
JavaScript
import { describe, it, expect } from "vitest";
|
|
import path from "node:path";
|
|
import os from "node:os";
|
|
import fs from "node:fs";
|
|
import { parseManifestUseCases, parseManifestFully } from "./_manifest-ast.js";
|
|
|
|
function writeManifest(content) {
|
|
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "manifest-ast-"));
|
|
const fp = path.join(dir, "feature.manifest.ts");
|
|
fs.writeFileSync(fp, content);
|
|
return fp;
|
|
}
|
|
|
|
describe("parseManifestUseCases", () => {
|
|
it("returns an empty object for a manifest with no useCases", () => {
|
|
const fp = writeManifest(`export const xManifest = defineFeature({
|
|
name: "x",
|
|
requiredCores: [],
|
|
useCases: {},
|
|
realtimeChannels: [],
|
|
jobs: [],
|
|
} as const);`);
|
|
expect(parseManifestUseCases(fp)).toEqual({});
|
|
});
|
|
|
|
it("extracts per-use-case publishes/audits/consumes arrays", () => {
|
|
const fp = writeManifest(`export const authManifest = defineFeature({
|
|
name: "auth",
|
|
requiredCores: [],
|
|
useCases: {
|
|
signIn: { mutates: false, audits: [], publishes: [], consumes: [] },
|
|
signUp: { mutates: true, audits: ["user.created"], publishes: ["auth.signed-up"], consumes: [] },
|
|
signOut: { mutates: true, audits: ["session.ended"], publishes: [], consumes: [] },
|
|
},
|
|
realtimeChannels: [],
|
|
jobs: [],
|
|
} as const);`);
|
|
expect(parseManifestUseCases(fp)).toEqual({
|
|
signIn: {
|
|
mutates: false,
|
|
audits: [],
|
|
publishes: [],
|
|
consumes: [],
|
|
analyticsEvents: [],
|
|
},
|
|
signUp: {
|
|
mutates: true,
|
|
audits: ["user.created"],
|
|
publishes: ["auth.signed-up"],
|
|
consumes: [],
|
|
analyticsEvents: [],
|
|
},
|
|
signOut: {
|
|
mutates: true,
|
|
audits: ["session.ended"],
|
|
publishes: [],
|
|
consumes: [],
|
|
analyticsEvents: [],
|
|
},
|
|
});
|
|
});
|
|
|
|
it("returns null when file does not exist", () => {
|
|
expect(parseManifestUseCases("/nonexistent/manifest.ts")).toBeNull();
|
|
});
|
|
|
|
it("returns null when the file has no defineFeature call", () => {
|
|
const fp = writeManifest(`export const x = 1;`);
|
|
expect(parseManifestUseCases(fp)).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe("parseManifestFully", () => {
|
|
it("returns name + requiredCores + useCases for a complete manifest", () => {
|
|
// Use the writeManifest helper that already exists in the test file
|
|
const fp = writeManifest(`export const authManifest = defineFeature({
|
|
name: "auth",
|
|
requiredCores: ["audit", "events"],
|
|
useCases: {
|
|
signIn: { mutates: false, audits: [], publishes: [], consumes: [] },
|
|
signUp: { mutates: true, audits: ["user.created"], publishes: [], consumes: [] },
|
|
},
|
|
realtimeChannels: [],
|
|
jobs: [],
|
|
} as const);`);
|
|
expect(parseManifestFully(fp)).toEqual({
|
|
name: "auth",
|
|
requiredCores: ["audit", "events"],
|
|
requiresConsent: [],
|
|
useCases: {
|
|
signIn: {
|
|
mutates: false,
|
|
audits: [],
|
|
publishes: [],
|
|
consumes: [],
|
|
analyticsEvents: [],
|
|
},
|
|
signUp: {
|
|
mutates: true,
|
|
audits: ["user.created"],
|
|
publishes: [],
|
|
consumes: [],
|
|
analyticsEvents: [],
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
it("extracts requiresConsent categories from the manifest", () => {
|
|
const fp = writeManifest(`export const consentManifest = defineFeature({
|
|
name: "consent",
|
|
requiredCores: [],
|
|
requiresConsent: ["analytics", "marketing"],
|
|
useCases: {},
|
|
realtimeChannels: [],
|
|
jobs: [],
|
|
} as const);`);
|
|
expect(parseManifestFully(fp)).toEqual({
|
|
name: "consent",
|
|
requiredCores: [],
|
|
requiresConsent: ["analytics", "marketing"],
|
|
useCases: {},
|
|
});
|
|
});
|
|
|
|
it("returns null when the manifest has no name", () => {
|
|
const fp = writeManifest(`export const x = 1;`);
|
|
expect(parseManifestFully(fp)).toBeNull();
|
|
});
|
|
|
|
it("is not fooled by 'name:' inside a JSDoc comment (regex would false-match)", () => {
|
|
const fp = writeManifest(`/**
|
|
* Sample comment with name: "fake" embedded in it.
|
|
*/
|
|
export const realManifest = defineFeature({
|
|
name: "real",
|
|
requiredCores: [],
|
|
useCases: {},
|
|
realtimeChannels: [],
|
|
jobs: [],
|
|
} as const);`);
|
|
expect(parseManifestFully(fp)).toEqual({
|
|
name: "real",
|
|
requiredCores: [],
|
|
requiresConsent: [],
|
|
useCases: {},
|
|
});
|
|
});
|
|
});
|