@fairfox/polly 0.21.0 → 0.23.0

package/dist/tools/quality/src/index.js.map

@@ -1,10 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../tools/quality/src/no-as-casting.ts"],
-  "sourcesContent": [
-    "/**\n * No-as-casting conformance check.\n *\n * Bans all TypeScript type assertions (`as Type`) except the allowed\n * patterns: `as const` (literal narrowing), `as unknown as` (explicit\n * escape hatch), import/export renames, and `as` inside strings or\n * comments. Violations include pattern-specific fix advice.\n *\n * This module exports the check logic as a library so consuming\n * applications can import it from `@fairfox/polly/quality` and run it\n * programmatically. Polly's own `scripts/check-no-as-casting.ts` is a\n * thin CLI wrapper around these exports.\n */\n\nimport { readFileSync } from \"node:fs\";\nimport { Glob } from \"bun\";\n\nexport interface Violation {\n  file: string;\n  line: number;\n  content: string;\n  advice?: string;\n}\n\nexport interface CheckResult {\n  violations: Violation[];\n  print: () => void;\n}\n\nexport interface CheckOptions {\n  rootDir: string;\n  exclude?: string[];\n  filePatterns?: string;\n}\n\n/**\n * Check whether a line contains a forbidden `as` type assertion.\n * Returns true if the line is clean (no violation), false if it violates.\n */\n// biome-ignore lint/complexity/noExcessiveCognitiveComplexity: Source-text scanning with many skip rules is inherently branchy.\nexport function isLineClean(line: string): boolean {\n  if (!line.includes(\" as \")) return true;\n\n  const trimmed = line.trim();\n\n  if (trimmed.startsWith(\"//\") || trimmed.startsWith(\"*\") || trimmed.startsWith(\"/*\")) {\n    return true;\n  }\n\n  if (line.match(/\\bas const\\b/)) {\n    const withoutAsConst = line.replace(/\\bas const\\b/g, \"\");\n    if (!withoutAsConst.includes(\" as \")) return true;\n  }\n\n  if (line.includes(\" as unknown as \") || line.trimEnd().endsWith(\"as unknown as\")) {\n    const withoutEscapeHatch = line.replace(/\\bas unknown as\\b/g, \"\");\n    if (!withoutEscapeHatch.includes(\" as \")) return true;\n  }\n\n  if (\n    line.match(/\\b(import|export)\\s+.*\\s+as\\s+\\w+/) ||\n    line.match(/\\b(import|export)\\s+\\*\\s+as\\s+\\w+/) ||\n    line.match(/\\b(import|export)\\s+type\\s+.*\\s+as\\s+\\w+/) ||\n    line.match(/^\\s*\\w+\\s+as\\s+\\w+,?\\s*$/) ||\n    line.match(/^\\s*type\\s+\\w+\\s+as\\s+\\w+,?\\s*$/)\n  ) {\n    return true;\n  }\n\n  if (line.match(/\\bas\\s*[=:,]/)) return true;\n  if (line.match(/\\)\\s+as\\s+\\w+/)) return true;\n\n  const idx = line.indexOf(\" as \");\n  if (idx >= 0) {\n    const before = line.substring(0, idx);\n    const singleQuotes = (before.match(/'/g) ?? []).length;\n    const doubleQuotes = (before.match(/\"/g) ?? []).length;\n    const backticks = (before.match(/`/g) ?? []).length;\n    if (singleQuotes % 2 === 1 || doubleQuotes % 2 === 1 || backticks % 2 === 1) {\n      return true;\n    }\n  }\n\n  const commentIdx = line.indexOf(\"//\");\n  if (commentIdx >= 0 && line.indexOf(\" as \", commentIdx) >= 0) {\n    const beforeComment = line.substring(0, commentIdx);\n    if (!beforeComment.includes(\" as \")) return true;\n  }\n\n  if (line.includes(\" satisfies \")) return true;\n\n  return false;\n}\n\n/**\n * Suggest a concrete fix for a specific violation pattern.\n */\n// biome-ignore lint/complexity/noExcessiveCognitiveComplexity: Pattern-matching advice is a linear chain of if-returns.\nexport function suggestFix(line: string): string | undefined {\n  if (line.includes(\"JSON.parse\")) {\n    return \"Use a validation function or type guard to parse and validate the result.\";\n  }\n  if (\n    line.includes(\"as HTMLInputElement\") ||\n    line.includes(\"as HTMLTextAreaElement\") ||\n    line.includes(\"as HTMLButtonElement\")\n  ) {\n    return \"Use instanceof: if (el instanceof HTMLInputElement) { el.value ... }\";\n  }\n  if (line.includes(\"as HTMLElement\") || line.includes(\"as Element\")) {\n    return \"Use instanceof: if (el instanceof HTMLElement) { ... }\";\n  }\n  if (line.includes(\".doc()\") && line.includes(\"as \")) {\n    return \"Type the DocHandle generic: repo.find<MyType>(id) returns DocHandle<MyType>.\";\n  }\n  if (\n    line.includes(\"Record<string, unknown>\") &&\n    (line.includes(\"window\") || line.includes(\"globalThis\"))\n  ) {\n    return \"Extract a type guard: function getGlobalProp(name: string): unknown { ... }\";\n  }\n  if (line.includes(\"Record<string, unknown>\")) {\n    return \"Use a type guard function that narrows the unknown value to the target shape.\";\n  }\n  if (line.includes(\"as PeerId\") || line.includes(\"as DocumentId\")) {\n    return \"Use the library's branded-type constructor if available, or centralise the cast in a factory.\";\n  }\n  if (line.includes(\"as string\") || line.includes(\"as number\") || line.includes(\"as boolean\")) {\n    return \"Narrow with typeof: if (typeof x === 'string') { ... }\";\n  }\n  if (line.includes(\"as any\")) {\n    return \"Replace 'any' with 'unknown' and add a type guard or validation at the boundary.\";\n  }\n  return undefined;\n}\n\n/**\n * Run the no-as-casting check against a directory. Returns a result\n * object with the violations and a print function for CLI output.\n */\nexport async function checkNoAsCasting(options: CheckOptions): Promise<CheckResult> {\n  const rootDir = options.rootDir;\n  const excludeDirs = new Set(options.exclude ?? [\"node_modules\", \"dist\", \".git\", \".bun\"]);\n  const pattern = options.filePatterns ?? \"**/*.{ts,tsx}\";\n  const glob = new Glob(pattern);\n  const violations: Violation[] = [];\n\n  for await (const file of glob.scan({ cwd: rootDir, absolute: true })) {\n    const relative = file.replace(`${rootDir}/`, \"\");\n    const segments = relative.split(\"/\");\n    if (segments.some((s) => excludeDirs.has(s))) continue;\n\n    const content = readFileSync(file, \"utf-8\");\n    const lines = content.split(\"\\n\");\n\n    for (let i = 0; i < lines.length; i++) {\n      const line = lines[i] ?? \"\";\n      if (!isLineClean(line)) {\n        violations.push({\n          file: relative,\n          line: i + 1,\n          content: line.trim(),\n          advice: suggestFix(line.trim()),\n        });\n      }\n    }\n  }\n\n  return {\n    violations,\n    print() {\n      if (violations.length === 0) {\n        console.log(\"[no-as-casting] ✅ No violations found.\");\n        return;\n      }\n      console.log(`[no-as-casting] ❌ ${violations.length} violation(s) found:\\n`);\n      for (const v of violations) {\n        console.log(`  ${v.file}:${v.line}`);\n        console.log(`    ${v.content}`);\n        if (v.advice) console.log(`    💡 ${v.advice}`);\n        console.log();\n      }\n      console.log(\"[no-as-casting] Use type guards, validation, or fix the types at the source.\");\n      console.log('[no-as-casting] Only \"as const\" and \"as unknown as\" are allowed.');\n    },\n  };\n}\n"
-  ],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA;AACA;AAyBO,SAAS,WAAW,CAAC,MAAuB;AAAA,EACjD,IAAI,CAAC,KAAK,SAAS,MAAM;AAAA,IAAG,OAAO;AAAA,EAEnC,MAAM,UAAU,KAAK,KAAK;AAAA,EAE1B,IAAI,QAAQ,WAAW,IAAI,KAAK,QAAQ,WAAW,GAAG,KAAK,QAAQ,WAAW,IAAI,GAAG;AAAA,IACnF,OAAO;AAAA,EACT;AAAA,EAEA,IAAI,KAAK,MAAM,cAAc,GAAG;AAAA,IAC9B,MAAM,iBAAiB,KAAK,QAAQ,iBAAiB,EAAE;AAAA,IACvD,IAAI,CAAC,eAAe,SAAS,MAAM;AAAA,MAAG,OAAO;AAAA,EAC/C;AAAA,EAEA,IAAI,KAAK,SAAS,iBAAiB,KAAK,KAAK,QAAQ,EAAE,SAAS,eAAe,GAAG;AAAA,IAChF,MAAM,qBAAqB,KAAK,QAAQ,sBAAsB,EAAE;AAAA,IAChE,IAAI,CAAC,mBAAmB,SAAS,MAAM;AAAA,MAAG,OAAO;AAAA,EACnD;AAAA,EAEA,IACE,KAAK,MAAM,mCAAmC,KAC9C,KAAK,MAAM,mCAAmC,KAC9C,KAAK,MAAM,0CAA0C,KACrD,KAAK,MAAM,0BAA0B,KACrC,KAAK,MAAM,iCAAiC,GAC5C;AAAA,IACA,OAAO;AAAA,EACT;AAAA,EAEA,IAAI,KAAK,MAAM,cAAc;AAAA,IAAG,OAAO;AAAA,EACvC,IAAI,KAAK,MAAM,eAAe;AAAA,IAAG,OAAO;AAAA,EAExC,MAAM,MAAM,KAAK,QAAQ,MAAM;AAAA,EAC/B,IAAI,OAAO,GAAG;AAAA,IACZ,MAAM,SAAS,KAAK,UAAU,GAAG,GAAG;AAAA,IACpC,MAAM,gBAAgB,OAAO,MAAM,IAAI,KAAK,CAAC,GAAG;AAAA,IAChD,MAAM,gBAAgB,OAAO,MAAM,IAAI,KAAK,CAAC,GAAG;AAAA,IAChD,MAAM,aAAa,OAAO,MAAM,IAAI,KAAK,CAAC,GAAG;AAAA,IAC7C,IAAI,eAAe,MAAM,KAAK,eAAe,MAAM,KAAK,YAAY,MAAM,GAAG;AAAA,MAC3E,OAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,aAAa,KAAK,QAAQ,IAAI;AAAA,EACpC,IAAI,cAAc,KAAK,KAAK,QAAQ,QAAQ,UAAU,KAAK,GAAG;AAAA,IAC5D,MAAM,gBAAgB,KAAK,UAAU,GAAG,UAAU;AAAA,IAClD,IAAI,CAAC,cAAc,SAAS,MAAM;AAAA,MAAG,OAAO;AAAA,EAC9C;AAAA,EAEA,IAAI,KAAK,SAAS,aAAa;AAAA,IAAG,OAAO;AAAA,EAEzC,OAAO;AAAA;AAOF,SAAS,UAAU,CAAC,MAAkC;AAAA,EAC3D,IAAI,KAAK,SAAS,YAAY,GAAG;AAAA,IAC/B,OAAO;AAAA,EACT;AAAA,EACA,IACE,KAAK,SAAS,qBAAqB,KACnC,KAAK,SAAS,wBAAwB,KACtC,KAAK,SAAS,sBAAsB,GACpC;AAAA,IACA,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,gBAAgB,KAAK,KAAK,SAAS,YAAY,GAAG;AAAA,IAClE,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,QAAQ,KAAK,KAAK,SAAS,KAAK,GAAG;AAAA,IACnD,OAAO;AAAA,EACT;AAAA,EACA,IACE,KAAK,SAAS,yBAAyB,MACtC,KAAK,SAAS,QAAQ,KAAK,KAAK,SAAS,YAAY,IACtD;AAAA,IACA,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,yBAAyB,GAAG;AAAA,IAC5C,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,WAAW,KAAK,KAAK,SAAS,eAAe,GAAG;AAAA,IAChE,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,WAAW,KAAK,KAAK,SAAS,WAAW,KAAK,KAAK,SAAS,YAAY,GAAG;AAAA,IAC3F,OAAO;AAAA,EACT;AAAA,EACA,IAAI,KAAK,SAAS,QAAQ,GAAG;AAAA,IAC3B,OAAO;AAAA,EACT;AAAA,EACA;AAAA;AAOF,eAAsB,gBAAgB,CAAC,SAA6C;AAAA,EAClF,MAAM,UAAU,QAAQ;AAAA,EACxB,MAAM,cAAc,IAAI,IAAI,QAAQ,WAAW,CAAC,gBAAgB,QAAQ,QAAQ,MAAM,CAAC;AAAA,EACvF,MAAM,UAAU,QAAQ,gBAAgB;AAAA,EACxC,MAAM,OAAO,IAAI,KAAK,OAAO;AAAA,EAC7B,MAAM,aAA0B,CAAC;AAAA,EAEjC,iBAAiB,QAAQ,KAAK,KAAK,EAAE,KAAK,SAAS,UAAU,KAAK,CAAC,GAAG;AAAA,IACpE,MAAM,WAAW,KAAK,QAAQ,GAAG,YAAY,EAAE;AAAA,IAC/C,MAAM,WAAW,SAAS,MAAM,GAAG;AAAA,IACnC,IAAI,SAAS,KAAK,CAAC,MAAM,YAAY,IAAI,CAAC,CAAC;AAAA,MAAG;AAAA,IAE9C,MAAM,UAAU,aAAa,MAAM,OAAO;AAAA,IAC1C,MAAM,QAAQ,QAAQ,MAAM;AAAA,CAAI;AAAA,IAEhC,SAAS,IAAI,EAAG,IAAI,MAAM,QAAQ,KAAK;AAAA,MACrC,MAAM,OAAO,MAAM,MAAM;AAAA,MACzB,IAAI,CAAC,YAAY,IAAI,GAAG;AAAA,QACtB,WAAW,KAAK;AAAA,UACd,MAAM;AAAA,UACN,MAAM,IAAI;AAAA,UACV,SAAS,KAAK,KAAK;AAAA,UACnB,QAAQ,WAAW,KAAK,KAAK,CAAC;AAAA,QAChC,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAEA,OAAO;AAAA,IACL;AAAA,IACA,KAAK,GAAG;AAAA,MACN,IAAI,WAAW,WAAW,GAAG;AAAA,QAC3B,QAAQ,IAAI,wCAAuC;AAAA,QACnD;AAAA,MACF;AAAA,MACA,QAAQ,IAAI,qBAAoB,WAAW;AAAA,CAA8B;AAAA,MACzE,WAAW,KAAK,YAAY;AAAA,QAC1B,QAAQ,IAAI,KAAK,EAAE,QAAQ,EAAE,MAAM;AAAA,QACnC,QAAQ,IAAI,OAAO,EAAE,SAAS;AAAA,QAC9B,IAAI,EAAE;AAAA,UAAQ,QAAQ,IAAI,oBAAS,EAAE,QAAQ;AAAA,QAC7C,QAAQ,IAAI;AAAA,MACd;AAAA,MACA,QAAQ,IAAI,8EAA8E;AAAA,MAC1F,QAAQ,IAAI,kEAAkE;AAAA;AAAA,EAElF;AAAA;",
-  "debugId": "0688395DF586B58B64756E2164756E21",
-  "names": []
-}