dsh-nsfc-form-check

Configuration

Every tunable lives in the Schemastery schema in src/config.ts. The roster is the one thing this plugin cannot work without: an identity check needs a list of the terms to look for, and that list is institution-specific, so it stays in the deployment's own configuration rather than travelling with the package.

Key	Type	Default	Description
rulesFile	string	rules/nsfc-form-check.yaml	Rule-pack path, relative to the package root
disabledRules	string[]	[]	Rule ids to stop running; each appears in skipped
onlyRules	string[]	[]	Run only these rule ids; empty runs every rule
skipNotes	string	""	Note appended to every skipped reason
authorNames	string[]	[]	Applicant names to look for
institutionNames	string[]	[]	Institution and unit names to look for
advisorNames	string[]	[]	Advisor names to look for
allowList	string[]	[]	Terms to ignore even when they match
timeoutMs	number	120000	Cooperative tool timeout budget

Rule-level parameters worth knowing:

• NF-009 coverLines — how many leading lines count as the cover page. Empty means the plugin does not assume any institution's template.
• NF-010 maxLines / maxChars — the length limit for the year and project type you are filing under. maxLines counts extracted paragraphs, which is not the same as typeset pages.
• NF-011 require — your form-review item list, as [{ label, match }] pairs.
• NF-012 markerPatterns / requiredDisclosure — how a repeat proposal is recognised in your template, and what it must disclose.
• NF-014 requireMention + advisorNames — the inverse check, off until you enable it for the year.
• NF-015 secretTerms — your confidentiality office's term list. The plugin ships none, because what counts as classified is defined by state secrecy rules, not by this plugin.