@wirecannon/linter
v0.1.2
Published
Validates .wcf files against the Wirecannon grammar specification
Readme
@wirecannon/linter
Validates .wcf files against the Wirecannon grammar specification.
Status
Not yet implemented. See CONTRIBUTING.md if you want to build this.
Interface contract
interface LintError {
file: string
line: number
rule: number // validation rule number from GRAMMAR.md
message: string
}
// Returns empty array for a valid project
async function lint(projectRoot: string): Promise<LintError[]>CLI usage (planned)
npx @wirecannon/linter ./wireframesValidation rules
All validation rules are defined in GRAMMAR.md.
When installed from npm, the language reference is included in the package:
node_modules/@wirecannon/linter/docs/GRAMMAR.mdThe docs/ directory also includes the root README, changelog, contribution guide,
and WIRECANNON.md model bootstrap instructions.
