Package: akitainu

Main package of the akitainu toolchain. Also serves the akitainu CLI.

npm install -D akitainu

CLI Usage

Prepare an akitainu config file, then run:

npx akitainu

(or, when running from npm scripts, just akitainnu is enough.

If there is no error, process exists with exit code 0. If there is an error, process exists with exit code 64.

Programmatic Use

This package exports a run function along with a bunch of type definitons for akitainu plugin creators. The run function behaves the same as the CLI, except that it does not automatically exit the process but returns a Promise<boolean> whose boolean value is true if there is no error, and false otherwise.

import { run } from "akitainu";

const result = await run();
if (result) {
  console.log("Lint succeeded!");
} else {
  console.log("There is an error! :(");
}