lint 0.0.2-preview.1
Lint rules for Zena source, each with a fix
lint#
Lint rules for Zena source code, each with an automated fix. The compiler and type checker drive every rule, and when a fix is applied it is type-checked again before it is kept.
Usage#
Command Line#
zena lint [--fix] [--only a,b] [--skip a,b] <paths...>
zena lint --list-rules
A path is a .zena file or a directory, searched for them. Without --fix the command prints each finding as path:line:column: message [rule] and exits 1 when there is one; with --fix it rewrites the files. -v on the command lists every fix and the text of any rejected one.
The language server (zena lsp) publishes the findings as warnings and offers each as a quick fix, plus a source.fixAll.zena code action for the whole file.
Library API#
import { LintOptions, lintFile } from 'lint';
import { Project } from 'lint/checking';
import { allRules } from 'lint/rules';
let project = new Project();
let options = new LintOptions(allRules());
let report = await lintFile(project, 'src/main.zena', options);
Rules#
| Rule | Rewrite |
|---|---|
function-declaration |
top-level let f = (…) => … → function f(…) { … } |
unnecessary-cast |
x as T where x: T → x (from the checker's warning, less contextually typed operands) |
unnecessary-optional-chain |
x?.f, x?[i], f?(…) on a non-nullable target → x.f, x[i], f(…) |
unnecessary-annotation |
let x: T = e with e: T; return types the body implies; callback parameter types |
collection-literal |
new Array<T>() + push runs → growable<T>([…]); new Map<K, V>() + []= → {k => v} |
if-initializer |
var x = d; if (c) { x = a; } → let x = if (c) a else d |
nullish |
if (x != null) x else d → x ?? d; if (x != null) x.f else null → x?.f |
match-to-if |
one- and two-arm match → if, if (x is T), if (let P = x) |
else-if |
else { if (…) { … } } → else if (…) { … } |
for-in |
index loops that read only xs[i] → for (let x in xs) |
boolean-return |
if (c) { return true; } return false; → return c;; if (c) true else false → c |
template-literal |
three or more +-joined strings → a template literal |
console-to-string |
console.log(`${x}`) and console.log(i32ToString(x)) → console.log(x) |
arrow-body |
(x) => { return e; } → (x) => e |
prefer-let |
var never assigned again → let |
immutable-field |
var field nothing assigns → immutable field (#private, or the class is not exported) |
empty-constructor |
new() {} on a class with no other constructor → removed; the default is synthesized |
Libraries#
lint/lint/lint— lint driver (lintFile,lintSource,LintOptions,FileReport)lint/checking— compiler project wrapper and overlay host (Project,CheckedFile)lint/checked— checked module wrapper (CheckedFile)lint/rules— rule registry (allRules,ruleNamed)lint/rule— rule runner (NamedRule,proposeEdits,messageOf)lint/context— rule traversal context (RuleContext)lint/source— byte-range edits (Edit,applyEdits,columnOf)lint/files—.zenafile discovery (collectZenaFiles)
License#
MIT
1.4 KiB
Raw
/**
* What a rule is, and one pass of a rule set over a checked file. No
* filesystem here: the language service runs this on a document it
* checked itself.
*/
import { CheckedFile } from './checked.zena';
import { RuleContext, Rule } from './context.zena';
import { Edit, disjointEdits } from './source.zena';
/**
* A rule by name, with the one-line finding it reports. The message says
* what is there and what it should be, in the voice of a diagnostic.
*/
export final class NamedRule(name: String, run: Rule, message: String)
/**
* The findings of one pass on a checked file: every rule's proposals,
* less those that overlap an earlier one. What an editor shows, and what
* a report lists.
*/
export function proposeEdits(checked: CheckedFile, rules: GrowableArray<NamedRule>): GrowableArray<Edit> {
return disjointEdits(runRules(checked, rules));
}
/** Every rule's proposals for one checked file, overlapping or not. */
export function runRules(checked: CheckedFile, rules: GrowableArray<NamedRule>): GrowableArray<Edit> {
let ctx = new RuleContext(checked);
for (let rule in rules) {
ctx.rule = rule.name;
rule.run(ctx);
}
return ctx.edits;
}
/** The message of the rule an edit came from. */
export function messageOf(edit: Edit, rules: GrowableArray<NamedRule>): String {
for (let rule in rules) {
if (rule.name == edit.rule) {
return rule.message;
}
}
return edit.rule;
}
- compiler compiler.zena-lang.pkg.zena-lang.dev 0.0.2-preview.1
| Version | Published | Dependencies | Approved by |
|---|---|---|---|
| 0.0.2-preview.1 | 2026-11-19 |
|
|