coderaiser / putout-editor / 36632654067

100%

push

github

docs: memory: putout types the whole plugin contract

I said the contract was untyped and recommended against TypeScript here. That
was wrong, and it was wrong because I grepped one .d.ts file instead of the
package. putout declares types in its package.json and re-exports the contract
from its entry point, and @putout/types/lib/plugin.d.ts types every rule
shape: Replacer, Includer, Traverser, Scan and Declarator.

The types cover exactly the mistakes that cost the most while writing rules
here, and that is checked rather than asserted - the includer fix that read
{path, key} and silently did nothing is a compile error against Fix:

  Type '({ path, key }: {...}) => void' is not assignable to type 'Fix'

Match's resolver takes (vars, path), which is where the bound __a values
arrive - the thing I read off report instead. Traverse's push takes a
NodePath, so push({path, message}) is an error rather than a rule that
reports undefined. Report is () => string, with no second parameter to reach
for.

packages/mcp is where that pays: 30 errors caught before CI saw them, none of
which a .js file reports.

The only reason left not to convert this package is the directory shape, which
AGENTS.md calls not negotiable - it must match @putout/plugin-tape and the 116
upstream plugins, and those are .js. That is a convention argument rather than
a tooling one, and it is the maintainer's to make.

1077 of 1077 branches covered (100.0%)

Branch coverage included in aggregate %.

6670 of 6670 relevant lines covered (100.0%)

61.48 hits per line