asljs-rq-cli 0.1.2 → 0.1.3

package/README.md

@@ -35,10 +35,6 @@ covered by them.
   `## Status` section; a failed test fails every requirement above it.
 - `rq coverage <target>...` asks an AI agent whether each requirement's
   sub-requirements and tests fully cover it, and records the verdict.
-- `rq view [path]` serves the graph as a clickable diagram, each border coloured
-  by the result and drawn solid, dashed or dotted by the coverage, and each
-  document of the documents folder rendered as HTML, including documents outside
-  the requirements folder that the requirements link to.
 - `rq agents` prints the formats and the rules every change keeps, for an AI
   agent that edits the files without `rq`.
 - `rq config` prints the folders, `rq.json`, the agent and the log settings, and
@@ -50,8 +46,9 @@ covered by them.
 
 The model and the commands themselves are functions of the [rq library][RQL].
 This package is the `rq` command. The [rq-mcp][MCP] server, `asljs-rq-mcp`,
-serves the same commands as MCP tools, and `rq view` runs the web server of
-[asljs-rq-srv][SRV]. An application that wants the functions without a command
+serves the same commands as MCP tools, and the [rq-srv][SRV] web server,
+`asljs-rq-srv`, serves the graph as a clickable diagram and the documents
+rendered and editable. An application that wants the functions without a command
 line imports `asljs-rq` instead.
 
 ## Scope
@@ -68,8 +65,6 @@ line imports `asljs-rq` instead.
 - Steps run in order, in the test's folder, until the first that fails. An
   instruction step needs an AI agent, `claude` or `copilot`; the first one
   installed is used unless `--ai` names one.
-- The view draws the graph with `asljs-ui-diagram`, served by `rq view` itself,
-  so it needs no network; it has a search over the nodes' titles.
 
 ## Installation
 
@@ -80,8 +75,9 @@ npm install asljs-rq-cli
 ## Usage
 
 Every command takes `--loglevel <level>`, `--logfile <target>` and `--logformat
-<format>`, or `RQ_LOG_LEVEL`, `RQ_LOG_FILE` and `RQ_LOG_FORMAT`, to log what it
-does, e.g. `--loglevel debug --logfile stderr`; nothing is logged without them.
+<format>`, or `RQ_LOG_LEVEL`, `RQ_LOG_FILE` and `RQ_LOG_FORMAT`, or `logLevel`,
+`logFile` and `logFormat` of `rq.json`, to log what it does, e.g. `--loglevel
+debug --logfile stderr`; nothing is logged without them.
 
 Build the graph with the commands, and write the statements, descriptions and
 steps as text:
@@ -156,14 +152,8 @@ Run a single requirement and everything below it by id, from any folder:
 npx rq test R1 --recurse --working-dir path/to/project
 ```
 
-Browse the graph and the documents:
-
-```bash
-npx rq view requirements --port 8080
-```
-
 With `rq.json` at the project root, the commands default to the requirements
-folder, and the view serves the whole project:
+folder, and the documents folder is the whole project:
 
 ```json
 {
@@ -173,7 +163,7 @@ folder, and the view serves the whole project:
 ```
 
 ```bash
-npx rq view
+npx rq check
 npx rq config
 ```
 
@@ -185,9 +175,8 @@ npx rq config
   built.
 - [Querying the graph][QG] and [Changing the graph][CG] - the structural
   commands.
-- [rq check][CK], [rq test][TS], [rq coverage][CV], [rq view][VW] and
-  [rq config][CF] - checking, testing, checking coverage, viewing and the
-  configuration.
+- [rq check][CK], [rq test][TS], [rq coverage][CV] and [rq config][CF] -
+  checking, testing, checking coverage and the configuration.
 - [rq agents][AG] - the instructions for an AI agent that edits the files
   without `rq`.
 - [rq-mcp][MC] - the MCP server with a tool per command.
@@ -199,7 +188,7 @@ Questions and bugs: [asljs/issues][IS].
 
 - [rq library][RQL] - the requirements model and the commands as functions.
 - [asljs-rq-mcp][MCP] - the `rq-mcp` MCP server.
-- [asljs-rq-srv][SRV] - the `rq view` web server.
+- [asljs-rq-srv][SRV] - the `rq-srv` web server; see [rq-srv][VW].
 - `asljs-part` defines project artefacts in markdown and checks them with rules.
 
 ## License
@@ -222,4 +211,4 @@ MIT
 [SK]: skills
 [SRV]: ../rq-srv/README.md
 [TS]: <docs/rq test.md>
-[VW]: <../rq-srv/docs/rq view.md>
+[VW]: ../rq-srv/docs/rq-srv.md

package/dist/cli.d.ts

@@ -1,6 +1,5 @@
 import { type Folders, Io } from 'asljs-rq';
 import { Command } from 'commander';
-import { Server } from 'node:http';
 /**
  * What a run of the command line leaves: its exit code, and the Io of the
  * command, with `--working-dir`, `--requirements-dir` and
@@ -19,20 +18,17 @@ export interface CliState {
  * The `rq` command line, not yet run: the program, and the state its
  * actions set.
  */
-export declare function createCli(args: string[], io: Io, servers?: Server[]): {
+export declare function createCli(args: string[], io: Io): {
     cli: Command;
     state: CliState;
 };
 /**
- * Runs the `rq` command line and returns the exit code. `rq view`
- * returns once the server listens, and adds it to `servers`; it serves until
- * whoever passed `servers` closes it.
+ * Runs the `rq` command line and returns the exit code.
  */
-export declare function runCli(args: string[], io: Io, servers?: Server[]): Promise<number>;
+export declare function runCli(args: string[], io: Io): Promise<number>;
 /**
  * The `rq` executable: runs the command line with a logger provider made
- * from `--loglevel`, `--logfile`, `--logformat` and the `RQ_LOG_`
- * variables, and disposes it before it returns the exit code. A server that
- * `view` started serves until SIGINT or SIGTERM first.
+ * from `--loglevel`, `--logfile`, `--logformat`, the `RQ_LOG_` variables and
+ * `rq.json` (`runMain`), and disposes it before it returns the exit code.
  */
 export declare function main(args: string[], io: Io): Promise<number>;

package/dist/cli.js

@@ -1,19 +1,17 @@
 import { AI_AGENTS, parseAgentSpec } from 'asljs-agents';
-import { createLoggerProvider, readLoggerOptions } from 'asljs-logging';
-import { postProcess, takeWritten, untilStopped } from 'asljs-mdcli';
-import { execAdd, execAgents, execBacklinks, execCheck, execCoverage, execLink, execLinks, execList, execLog, execMove, execRemove, execTest, execToJson, execUnlink, getLogger, resolveFolders } from 'asljs-rq';
-import { execView } from 'asljs-rq-srv';
+import { commandLine, messageOf, postProcess, runMain, takeWritten } from 'asljs-appbase';
+import { CONFIG_FILE, execAdd, execAgents, execBacklinks, execCheck, execCoverage, execLink, execLinks, execList, execLog, execMove, execRemove, execTest, execToJson, execUnlink, getLogger, resolveFolders } from 'asljs-rq';
 import { Command, CommanderError } from 'commander';
 import path from 'node:path';
 import { execConfig } from './config.js';
 const WORKING_DIR = 'The folder to work in: paths resolve against it, rq.json is looked for from it up, and its .rq folder holds the results; the current directory by default';
 const REQUIREMENTS_DIR = 'The folder of the requirements: the default path, and where ids and .md names are searched for; requirementsDir of rq.json, else the working folder';
-const DOCUMENTS_DIR = 'The folder of every document, containing the requirements folder: what view serves, and where backlinks and links to rewrite are searched for; documentsDir of rq.json, else the requirements folder';
+const DOCUMENTS_DIR = 'The folder of every document, containing the requirements folder: what rq-srv serves, and where backlinks and links to rewrite are searched for; documentsDir of rq.json, else the requirements folder';
 /**
  * The `rq` command line, not yet run: the program, and the state its
  * actions set.
  */
-export function createCli(args, io, servers = []) {
+export function createCli(args, io) {
     const state = { exitCode: 0,
         io,
         folders: null };
@@ -23,15 +21,9 @@ export function createCli(args, io, servers = []) {
             : JSON.stringify(arg))]
         .join(' ');
     const cli = new Command();
-    cli.name('rq')
-        .description('AI-assisted requirements management: test and view requirements and tests written in markdown.')
-        .helpCommand(false)
-        .configureOutput({ writeOut: value => io.stdout.write(value),
-        writeErr: value => io.stderr.write(value) })
-        .exitOverride()
-        .option('--loglevel <level>', 'Log level: trace, debug, information, warning, error')
-        .option('--logfile <target>', 'Where logs go: a file path, stdout or stderr')
-        .option('--logformat <format>', 'Log format: auto, json, text or pretty')
+    commandLine(cli.name('rq')
+        .description('AI-assisted requirements management: test and check requirements and tests written in markdown.')
+        .helpCommand(false), io)
         .hook('preAction', async (_cli, action) => {
         const options = action.opts();
         const cwd = options.workingDir === undefined
@@ -40,8 +32,7 @@ export function createCli(args, io, servers = []) {
         state.folders =
             await resolveFolders(cwd, options);
         // A folder left to its default stays unset, so that a command can
-        // tell it from one that was given; `view` serves the folder of its
-        // path then.
+        // tell it from one that was given.
         const given = (setting) => setting.source === 'default'
             ? undefined
             : setting.value;
@@ -80,23 +71,6 @@ export function createCli(args, io, servers = []) {
                     ? undefined
                     : parseAgentSpec(options.ai) });
     });
-    cli.command('view')
-        .description('Serve the requirements graph and the rendered documents over HTTP')
-        .argument('[path]', 'A requirement file, or a folder of requirements; the requirements folder by default')
-        .option('--port <port>', 'Port to listen on, exactly; 0 picks a free one. By default the first free port from 3000 on')
-        .action(async (target, options) => {
-        const port = options.port === undefined
-            ? undefined
-            : Number(options.port);
-        if (port !== undefined
-            && (!Number.isInteger(port)
-                || port < 0
-                || port > 65535)) {
-            throw new Error(`Invalid port: ${options.port}`);
-        }
-        servers.push(await execView(state.io, { target,
-            port }));
-    });
     cli.command('check')
         .description('Check the structure of the graph and its documents without running anything')
         .argument('[path]', 'A requirement file, or a folder of requirements; the requirements folder by default')
@@ -247,12 +221,10 @@ export function createCli(args, io, servers = []) {
         state };
 }
 /**
- * Runs the `rq` command line and returns the exit code. `rq view`
- * returns once the server listens, and adds it to `servers`; it serves until
- * whoever passed `servers` closes it.
+ * Runs the `rq` command line and returns the exit code.
  */
-export async function runCli(args, io, servers = []) {
-    const { cli, state } = createCli(args, io, servers);
+export async function runCli(args, io) {
+    const { cli, state } = createCli(args, io);
     if (args.length === 0) {
         cli.outputHelp();
         return 0;
@@ -267,14 +239,12 @@ export async function runCli(args, io, servers = []) {
         if (error instanceof CommanderError) {
             return error.exitCode;
         }
-        io.stderr.write(`${error instanceof Error
-            ? error.message
-            : String(error)}\n`);
+        io.stderr.write(`${messageOf(error)}\n`);
         state.exitCode = 1;
     }
     try {
         const processed = await postProcess({ ...state.io,
-            logger: getLogger(state.io, 'rq.post-process') }, takeWritten(), 'rq.json');
+            logger: getLogger(state.io, 'rq.post-process') }, takeWritten(), CONFIG_FILE);
         logger.debug({ exitCode: state.exitCode,
             postProcessing: processed }, 'command finished');
         return state.exitCode === 0
@@ -282,9 +252,7 @@ export async function runCli(args, io, servers = []) {
             : state.exitCode;
     }
     catch (error) {
-        io.stderr.write(`${error instanceof Error
-            ? error.message
-            : String(error)}\n`);
+        io.stderr.write(`${messageOf(error)}\n`);
         return 1;
     }
 }
@@ -294,22 +262,11 @@ function collect(value, previous) {
 }
 /**
  * The `rq` executable: runs the command line with a logger provider made
- * from `--loglevel`, `--logfile`, `--logformat` and the `RQ_LOG_`
- * variables, and disposes it before it returns the exit code. A server that
- * `view` started serves until SIGINT or SIGTERM first.
+ * from `--loglevel`, `--logfile`, `--logformat`, the `RQ_LOG_` variables and
+ * `rq.json` (`runMain`), and disposes it before it returns the exit code.
  */
 export async function main(args, io) {
-    const loggerProvider = createLoggerProvider('RQ_LOG_', readLoggerOptions(args));
-    const servers = [];
-    try {
-        const exitCode = await runCli(args, { ...io,
-            loggerProvider }, servers);
-        for (const server of servers) {
-            await untilStopped(server);
-        }
-        return exitCode;
-    }
-    finally {
-        await loggerProvider.dispose();
-    }
+    return await runMain(args, io, { prefix: 'RQ_LOG_',
+        configFile: CONFIG_FILE }, async (loggerProvider) => await runCli(args, { ...io,
+        loggerProvider }));
 }

package/dist/config.d.ts

@@ -41,11 +41,11 @@ export interface Configuration {
 }
 /**
  * A log setting and where it comes from: its option, its `RQ_LOG_`
- * variable, or the default.
+ * variable, `rq.json`, or the default.
  */
 export interface LogSetting {
     value: string;
-    source: 'option' | 'environment' | 'default';
+    source: 'option' | 'environment' | 'rq.json' | 'default';
 }
 /**
  * Prints the configuration: the folders and where they come from, the

package/dist/config.js

@@ -1,8 +1,6 @@
 import { AI_AGENTS } from 'asljs-agents';
 import { readLoggerOptions } from 'asljs-logging';
-import { findConfig } from 'asljs-mdcli';
-import { CONFIG_FILE } from 'asljs-rq';
-import { createRequire } from 'node:module';
+import { configLogging, configString, packageVersion } from 'asljs-appbase';
 /**
  * The environment variables `rq` reads.
  */
@@ -26,33 +24,37 @@ export async function execConfig(io, options) {
  * The configuration `rq` runs with in the working folder of `io`.
  */
 export async function readConfiguration(io, folders, args) {
-    const found = await findConfig(io.cwd, CONFIG_FILE);
     const environment = Object.fromEntries(ENVIRONMENT_VARIABLES.map(name => [name,
         io.env[name] || null]));
     const overrides = readLoggerOptions(args);
-    const pick = (option, variable, fallback) => option !== undefined
+    const configured = configLogging(folders.config);
+    const pick = (option, variable, fromFile, fallback) => option !== undefined
         ? { value: option,
             source: 'option' }
         : environment[variable] !== null
             ? { value: environment[variable],
                 source: 'environment' }
-            : { value: fallback,
-                source: 'default' };
-    const file = pick(overrides.file, 'RQ_LOG_FILE', 'stdout');
-    return { version: packageVersion(),
+            : fromFile !== undefined
+                ? { value: fromFile,
+                    source: 'rq.json' }
+                : { value: fallback,
+                    source: 'default' };
+    const file = pick(overrides.file, 'RQ_LOG_FILE', configured.file, 'stdout');
+    return { version: packageVersion(import.meta.url),
         workingDir: io.cwd,
-        configFile: folders.configFile,
+        configFile: folders.config.file,
         requirementsDir: folders.requirementsDir,
         documentsDir: folders.documentsDir,
-        markdownPostProcessing: found?.config.markdownPostProcessing?.trim()
+        markdownPostProcessing: configString(folders.config, 'markdownPostProcessing')
+            ?.trim()
             || null,
         agent: { command: environment.RQ_AI_COMMAND,
             agents: [...AI_AGENTS] },
-        log: { level: pick(overrides.level, 'RQ_LOG_LEVEL', file.source === 'default'
+        log: { level: pick(overrides.level, 'RQ_LOG_LEVEL', configured.level, file.source === 'default'
                 ? 'silent'
                 : 'information'),
             file,
-            format: pick(overrides.format, 'RQ_LOG_FORMAT', 'auto') },
+            format: pick(overrides.format, 'RQ_LOG_FORMAT', configured.format, 'auto') },
         environment };
 }
 function describe(configuration) {
@@ -73,6 +75,3 @@ function describe(configuration) {
         ...Object.entries(configuration.environment).map(([name, value]) => `  ${name}=${value ?? ''}`)];
     return `${lines.join('\n')}\n`;
 }
-function packageVersion() {
-    return createRequire(import.meta.url)('../package.json').version;
-}

package/docs/rq config.md

@@ -41,8 +41,8 @@ environment:
   needs one.
 - `logLevel`, `logFile`, `logFormat` - the log settings, and where each comes
   from: `option` (`--loglevel`, `--logfile`, `--logformat`), `environment`
-  (`RQ_LOG_LEVEL`, `RQ_LOG_FILE`, `RQ_LOG_FORMAT`) or `default`. See the
-  repository's logging rules.
+  (`RQ_LOG_LEVEL`, `RQ_LOG_FILE`, `RQ_LOG_FORMAT`), `rq.json` (`logLevel`,
+  `logFile`, `logFormat`) or `default`. See the repository's logging rules.
 - `environment` - each variable `rq` reads, and its value, empty when it is not
   set.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "asljs-rq-cli",
-  "version": "0.1.2",
-  "description": "The rq command line over asljs-rq: query, change, check, test and view requirements.",
+  "version": "0.1.3",
+  "description": "The rq command line over asljs-rq: query, change, check and test requirements.",
   "type": "module",
   "asljs": {
     "type": "app"
@@ -60,9 +60,8 @@
   "dependencies": {
     "asljs-agents": "^0.1.0",
     "asljs-logging": "^0.1.2",
-    "asljs-mdcli": "^0.1.3",
+    "asljs-appbase": "^0.1.3",
     "asljs-rq": "^0.1.6",
-    "asljs-rq-srv": "^0.1.1",
     "commander": "^15.0.0"
   },
   "devDependencies": {