markbackjs

JavaScript/TypeScript linter for the MarkBack format.

Install

npm install markbackjs

Usage

const { lintString, formatDiagnostics } = require("markbackjs");

const text = "Content here.\n<<< positive\n";
const result = lintString(text, { checkSources: false, checkCanonical: false });

if (result.hasErrors) {
  console.log(formatDiagnostics(result.diagnostics));
}

Supported Headers

• @uri - Unique identifier for the record
• @source - Reference to external content file
• @prior - Reference to a file that precedes the source (e.g., a prompt that generated it)

API

• lintString(text, options)
• lintFile(path, options)
• lintFiles(paths, options)
• formatDiagnostics(diagnostics, format)
• summarizeResults(results)

Options:

• sourceFile: string
• checkSources: boolean (default true)
• checkCanonical: boolean (default true)

Build

npm run build