@oml/cli 0.7.0

package/src/cli.ts

@@ -0,0 +1,147 @@
+// Copyright (c) 2026 Modelware. All rights reserved.
+
+import { OmlLanguageMetaData } from '@oml/language';
+import chalk from 'chalk';
+import { Command } from 'commander';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import * as url from 'node:url';
+import { OmlCliAuthService } from './auth.js';
+import { compileAction } from './commands/compile.js';
+import { lintAction } from './commands/lint.js';
+import { renderAction } from './commands/render.js';
+import { notifyIfCliUpdateAvailable } from './update.js';
+import { validateAction } from './commands/validate.js';
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+export async function runCli(argv: string[] = process.argv): Promise<void> {
+    const packagePath = path.resolve(__dirname, '..', 'package.json');
+    const packageContent = await fs.readFile(packagePath, 'utf-8');
+    const packageJson = JSON.parse(packageContent) as { version: string };
+    const updateCheck = notifyIfCliUpdateAvailable(packageJson.version);
+
+    const program = new Command();
+    program.version(packageJson.version);
+    const authService = new OmlCliAuthService();
+
+    program
+        .command('login')
+        .description('run GitHub device-flow sign-in for CLI authorization checks')
+        .action(async () => {
+            await authService.login({});
+        });
+
+    program
+        .command('logout')
+        .description('remove the local beta sign-in session')
+        .action(async () => {
+            await authService.logout();
+        });
+
+    program
+        .command('whoami')
+        .description('print the current beta sign-in session and authorization state')
+        .action(async () => {
+            await authService.whoami();
+        });
+
+    const fileExtensions = OmlLanguageMetaData.fileExtensions.join(', ');
+    program
+        .command('lint')
+        .argument('[file]', `source file (possible file extensions: ${fileExtensions})`)
+        .option('-w, --workspace <dir>', 'workspace root used to resolve cross-file references', '.')
+        .description('lints OML files and prints any syntax or validation errors')
+        .action(lintAction);
+
+    program
+        .command('render')
+        .option('-w, --workspace <workspace-folder>', 'workspace root used to resolve workspace:/ links (default: current directory)')
+        .requiredOption('-md, --md <input-folder>', 'folder containing markdown files to render')
+        .requiredOption('-web, --web <output-folder>', 'folder where rendered static site files are written')
+        .option('-owl, --owl <dir>', 'folder where compiled RDF and entailment files are written')
+        .option('-f, --format <ext>', 'RDF format extension for compile/reason output: ttl, trig, nt, nq, or n3', 'ttl')
+        .option('-c, --context <model-uri>', 'default model URI/path used for markdown files without contextUri; also enables wikilink template page generation')
+        .option('--clean', 'remove output folders before rebuilding')
+        .option('--only', 'skip reason/compile/lint and render from the existing owl output folder')
+        .option('--pretty', 'pretty-print Turtle/TriG output with blank lines between top-level blocks')
+        .option('-u, --unique-names-assumption [value]', 'enable or disable the unique names assumption', parseBooleanOption, true)
+        .option('-e, --explanations [value]', 'enable or disable inconsistency explanations', parseBooleanOption, true)
+        .option('-p, --profile [value]', 'include phase timings in the reasoner result', parseBooleanOption, false)
+        .description('reason the workspace, then render markdown files under the selected markdown folder to static html and copy referenced non-markdown assets')
+        .action(renderAction);
+
+    program
+        .command('compile')
+        .option('-w, --workspace <dir>', 'workspace root used to resolve and compile OML files', '.')
+        .option('-owl, --owl <dir>', 'folder where compiled RDF files are written')
+        .option('-f, --format <ext>', 'RDF format extension: ttl, trig, nt, nq, or n3', 'ttl')
+        .option('--clean', 'remove output folder before compiling')
+        .option('--only', 'skip lint and compile from the current workspace state')
+        .option('--pretty', 'pretty-print Turtle/TriG output with blank lines between top-level blocks')
+        .description('compile OML files to RDF and write them to an output folder')
+        .action(compileAction);
+
+    program
+        .command('reason')
+        .option('-w, --workspace <dir>', 'workspace root used to resolve and compile OML files', '.')
+        .option('-owl, --owl <dir>', 'folder where compiled RDF and entailment files are written')
+        .option('-f, --format <ext>', 'RDF format extension for compile output: ttl, trig, nt, nq, or n3', 'ttl')
+        .option('--clean', 'remove output folder before compiling')
+        .option('--only', 'skip compile/lint and reason from the existing owl output folder')
+        .option('--pretty', 'pretty-print Turtle/TriG output with blank lines between top-level blocks')
+        .option('-c, --check-only', 'only check consistency; skip entailment materialization and file output')
+        .option('-u, --unique-names-assumption [value]', 'enable or disable the unique names assumption', parseBooleanOption, true)
+        .option('-e, --explanations [value]', 'enable or disable inconsistency explanations', parseBooleanOption, true)
+        .option('-p, --profile [value]', 'include phase timings in the reasoner result', parseBooleanOption, false)
+        .description('compile OML files, then run consistency checking for every ontology in dependency order')
+        .action(async (opts) => {
+            const { reasonAction } = await import('./commands/reason.js');
+            await reasonAction(opts);
+        });
+
+    program
+        .command('validate')
+        .requiredOption('-md, --md <input-folder>', 'folder containing markdown files to validate recursively')
+        .option('-w, --workspace <dir>', 'workspace root used to resolve and compile OML files', '.')
+        .option('-owl, --owl <dir>', 'folder where compiled RDF and entailment files are written')
+        .option('-f, --format <ext>', 'RDF format extension for compile output: ttl, trig, nt, nq, or n3', 'ttl')
+        .option('--clean', 'remove output folder before compiling')
+        .option('--only', 'skip compile/lint and reason from the existing owl output folder')
+        .option('--pretty', 'pretty-print Turtle/TriG output with blank lines between top-level blocks')
+        .option('-u, --unique-names-assumption [value]', 'enable or disable the unique names assumption', parseBooleanOption, true)
+        .option('-e, --explanations [value]', 'enable or disable inconsistency explanations', parseBooleanOption, true)
+        .option('-p, --profile [value]', 'include phase timings in the reasoner result', parseBooleanOption, false)
+        .description('compile and reason the workspace, then validate nested markdown table-editor SHACL blocks against their context models')
+        .action(validateAction);
+
+    program.hook('preAction', async (_thisCommand, actionCommand) => {
+        if (actionCommand.name() === 'login' || actionCommand.name() === 'logout' || actionCommand.name() === 'whoami') {
+            return;
+        }
+        await authService.ensureAuthenticated('OML CLI');
+    });
+
+    await program.parseAsync(argv);
+    await updateCheck;
+}
+
+function parseBooleanOption(value: string | boolean): boolean {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    const normalized = value.trim().toLowerCase();
+    if (normalized === 'true') {
+        return true;
+    }
+    if (normalized === 'false') {
+        return false;
+    }
+    throw new Error(`Expected a boolean value, received '${value}'.`);
+}
+
+process.on('unhandledRejection', (error) => {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(chalk.red(message));
+    process.exit(1);
+});