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.8 KiB
Raw
/**
* Which files to lint: `.zena` files under the paths given, less build
* output, the compiler's bootstrap, and generated files.
*/
import { Future } from 'zena:async';
import { isDirectory, listDir, readFile, FileType } from 'zena:fs';
import { join2 } from 'zena:path';
/**
* `.zena` files at or under `path`, in directory order. A generated
* file is skipped: a generator's output says "Do not edit" in its first
* lines, and a test checks it against the generator. A file named on the
* command line is linted whatever directory it is in.
*/
export async function collectZenaFiles(path: String, out: GrowableArray<String>): Future<void> {
if (!(await isDirectory(path))) {
if (path.endsWith('.zena') && !(await isGenerated(path))) {
out.push(path);
}
return;
}
for (let entry in await listDir(path)) {
let name = entry.name;
// A `fixtures` directory holds test inputs, which are what they are
// on purpose — this package's own fixtures are written the old way so
// that the rules have something to find.
if (name == '.' || name == '..' || name == 'node_modules' || name == 'out' ||
name == 'bootstrap' || name == 'target' || name == 'fixtures' ||
name.startsWith('.')) {
continue;
}
let child = join2(path, name);
if (entry.fileType == FileType.Directory) {
await collectZenaFiles(child, out);
} else if (entry.fileType == FileType.RegularFile && name.endsWith('.zena') &&
!(await isGenerated(child))) {
out.push(child);
}
}
}
/** Whether the file's opening comment marks it as a generator's output. */
export async function isGenerated(path: String): Future<boolean> {
let source = await readFile(path);
let head = source.sliceBytes(0, if (source.length < 400) source.length else 400);
return head.contains('Do not edit') || head.contains('do not edit') ||
head.contains('DO NOT EDIT');
}
- 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 |
|
|