Coder/deepseek-harness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(scripts): keep rfc-index module internals unexported

Browse Source 
knip: the walker/renderer internals (the closed sets, the heading and
marker helpers, the per-lifecycle renderer) have no importer beyond
this module — the public surface is rfcRoot, walkRfcTree, and
spliceReadme, the three names the generator CLI and the gate consume.
This commit is contained in:
Tianyi Cui
2026-07-04 14:52:09 +08:00
parent 5611f772b1
commit 5477d5fb5b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
scripts/rfc-index.ts
View File

@@ -23,20 +23,20 @@ import { globSync } from 'node:fs'
export const rfcRoot = resolve(import.meta.dirname, '../docs/rfc') export const rfcRoot = resolve(import.meta.dirname, '../docs/rfc')
/** The closed set of RFC lifecycles (top-level folders under docs/rfc/). */ /** The closed set of RFC lifecycles (top-level folders under docs/rfc/). */
export const LIFECYCLES = ['proposed', 'implemented', 'rejected'] as const const LIFECYCLES = ['proposed', 'implemented', 'rejected'] as const
/** /**
* The closed set of RFC classes (nested folder under each lifecycle). Adding a * The closed set of RFC classes (nested folder under each lifecycle). Adding a
* class is a deliberate act: extend this list AND the README's Classification * class is a deliberate act: extend this list AND the README's Classification
* section. The gate rejects any folder not listed here. * section. The gate rejects any folder not listed here.
*/ */
export const CLASSES = ['feature', 'bug-fix', 'simplification', 'architecture', 'process', 'testing'] as const const CLASSES = ['feature', 'bug-fix', 'simplification', 'architecture', 'process', 'testing'] as const
/** Non-RFC Markdown allowed to sit directly at a lifecycle root. */ /** Non-RFC Markdown allowed to sit directly at a lifecycle root. */
const ROOT_ALLOWLIST = new Set(['AGENTS.md', 'CLAUDE.md']) const ROOT_ALLOWLIST = new Set(['AGENTS.md', 'CLAUDE.md'])
/** Title-case a class/lifecycle folder name for a README heading. */ /** Title-case a class/lifecycle folder name for a README heading. */
export const heading = (s: string): string => s.charAt(0).toUpperCase() + s.slice(1) const heading = (s: string): string => s.charAt(0).toUpperCase() + s.slice(1)
/** One RFC file, as discovered by the walker. */ /** One RFC file, as discovered by the walker. */
export interface Rfc { export interface Rfc {
@@ -95,7 +95,7 @@ export function walkRfcTree(): { rfcs: Rfc[]; errors: string[] } {
} }
/** The begin/end marker lines that delimit one lifecycle's generated region. */ /** The begin/end marker lines that delimit one lifecycle's generated region. */
export const markers = (lifecycle: string): { begin: string; end: string } => ({ const markers = (lifecycle: string): { begin: string; end: string } => ({
begin: `<!-- gen-rfc-index:begin ${lifecycle} -->`, begin: `<!-- gen-rfc-index:begin ${lifecycle} -->`,
end: `<!-- gen-rfc-index:end ${lifecycle} -->`, end: `<!-- gen-rfc-index:end ${lifecycle} -->`,
}) })
@@ -105,7 +105,7 @@ export const markers = (lifecycle: string): { begin: string; end: string } => ({
* `| Title | First proposed |` table for every non-empty class, in CLASSES * `| Title | First proposed |` table for every non-empty class, in CLASSES
* order, rows sorted by date then filename. * order, rows sorted by date then filename.
*/ */
export function renderLifecycle(rfcs: Rfc[], lifecycle: string): string { function renderLifecycle(rfcs: Rfc[], lifecycle: string): string {
const sections: string[] = [] const sections: string[] = []
for (const cls of CLASSES) { for (const cls of CLASSES) {
const rows = rfcs const rows = rfcs