@prestack/thread 0.0.1 → 0.0.2

package/dist/core/finding.ts

@@ -0,0 +1,38 @@
+import { stdout } from 'node:process'
+
+export interface Finding {
+  readonly detail: string
+  readonly instead: string
+  readonly file?: string
+  readonly at?: { readonly line?: number; readonly column?: number }
+  readonly severity?: 'forbidden' | 'warning'
+}
+
+export const forbids = (finding: Finding): boolean => finding.severity !== 'warning'
+
+function locate(finding: Finding): string {
+  if (finding.file === undefined) return ''
+  const line = finding.at?.line
+  const column = finding.at?.column
+  const position = line === undefined ? '' : `:${String(line)}${column === undefined ? '' : `:${String(column)}`}`
+  return ` (${finding.file}${position})`
+}
+
+export function runChecker(name: string, findings: readonly Finding[], measured: string): void {
+  if (findings.length === 0) {
+    stdout.write(`${name}: ${measured} — no findings.\n`)
+    process.exitCode = 0
+    return
+  }
+
+  const lines = findings.map(
+    (finding) => `  ${forbids(finding) ? '' : 'warning: '}${finding.detail}${locate(finding)}\n    Instead: ${finding.instead}`,
+  )
+  const forbidding = findings.filter(forbids).length
+  stdout.write(
+    `${name}: ${String(findings.length)} finding${findings.length === 1 ? '' : 's'}` +
+      `${forbidding === findings.length ? '' : `, ${String(findings.length - forbidding)} of them warnings`} — ${measured}\n\n` +
+      `${lines.join('\n')}\n`,
+  )
+  process.exitCode = forbidding === 0 ? 0 : 1
+}

package/dist/core/generators/meta.js

@@ -58,6 +58,9 @@ try {
 catch {
     sheet = {};
 }
+const shows = sheet['catalogue'];
+const shown = typeof shows === 'function' ? await shows() : [];
+const teaches = Array.isArray(sheet['TEACHES']) ? sheet['TEACHES'] : [];
 const inSheet = (() => {
     const only = sheet[LIST];
     if (Array.isArray(only))
@@ -662,6 +665,8 @@ if (words[0] === 'add') {
     exit(0);
 }
 stdout.write(`${listing}\n`);
+for (const line of shown)
+    stdout.write(`${line}\n`);
 const flagged = argv.indexOf(RECEIPT);
 if (flagged === -1) {
     const nonce = issue(TREE.at, listing);
@@ -678,6 +683,7 @@ if (flagged === -1) {
                 `  ${'at:'.padEnd(WIDTH)}${FILES.replace('*', '<name>')} — where it lives is never typed`,
                 `  ${`${asFlag(BODY)}:`.padEnd(WIDTH)}what goes in that file, given on the command. Leave it out and the settle writes the starter`,
             ]),
+        ...(teaches.length === 0 ? [] : ['', ...teaches]),
         '',
         `  thread create ${NOUN} new <name> ${RECEIPT} ${nonce}`,
         `  thread create ${NOUN} read <mark>           no receipt, writes nothing`,