@okfit/cli 0.6.5 → 0.6.7

package/README.md

@@ -389,9 +389,11 @@ that one case.
 
 Every message `okfit` prints is lowercase, starts `error:` or `warning:`,
 never ends with a trailing period, and renders a path relative to the
-current directory when the path is under it, absolute otherwise. Colour, when
-stdout is a TTY and `NO_COLOR` is not `1`, wraps only the severity word —
-never the code, the path, or the message text.
+current directory when the path is under it, absolute otherwise. Colour,
+when stdout is a TTY and `NO_COLOR` is unset or empty (the
+[no-color.org](https://no-color.org) rule: any non-empty `NO_COLOR` value
+disables colour), wraps only the severity word — never the code, the
+path, or the message text.
 
 ## License
 

package/commands/context.js

@@ -1,8 +1,8 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { humanContext } from "../render/context.js";
 import { CLI_VERSION } from "../version.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { ContextEnvelope, contextEnvelope, jsonError, provideConfig, resolveProjectConfig, runContext } from "@okfit/engine";
 import { Console, Effect, Option, Schema } from "effect";
 
@@ -36,7 +36,7 @@ const contextCommand = Command.make("context", {
 }, (input) => Effect.gen(function* () {
 	const cwd = process.cwd();
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const { projectRoot, bundleRoot, config: merged, profile, profileName, discovered } = yield* resolveProjectConfig({
 			pathArg: input.path,

package/commands/graph.js

@@ -1,7 +1,7 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { GraphEnvelope, graphEnvelope, jsonError, provideConfig, resolveProjectConfig, runGraph } from "@okfit/engine";
 import { Console, Effect, Option, Schema } from "effect";
 import { OKF_SPEC_VERSION } from "@okfit/core";
@@ -40,7 +40,7 @@ const graphCommand = Command.make("graph", {
 }, (input) => Effect.gen(function* () {
 	const cwd = process.cwd();
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const { bundleRoot, config: merged, profile } = yield* resolveProjectConfig({
 			pathArg: input.path,

package/commands/init.js

@@ -1,10 +1,10 @@
 import { setExitCode } from "../internal/exit.js";
-import { useColor } from "../internal/tty.js";
 import { displayRoot, human, summary } from "../render/human.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
 import { CONFIG_RELATIVE_PATH, InitOverwriteError, Now, collect, configValue, files, forDiagnostics, provideConfig, resolveBundleRoot, resolveProjectRoot, run, targetPaths } from "@okfit/engine";
 import { Console, DateTime, Effect, FileSystem, Layer, Option, Path } from "effect";
 import { OKF_SPEC_VERSION, OkfitConfig, OkfitConfigFile, SCHEMA_DIRECTIVE } from "@okfit/core";
+import { CliColor } from "@effected/cli";
 import { Git } from "@effected/git";
 import { GitHistory, Profiles } from "@okfit/profiles";
 
@@ -159,7 +159,8 @@ const initCommand = Command.make("init", {
 			now
 		}).pipe(Effect.provide(Layer.mergeAll(Git.layer, GitHistory.layer)));
 		const diagnostics = collect(result.report.conformance, result.report.lint, result.profileDiagnostics);
-		for (const line of human(diagnostics, { color: useColor() })) yield* Console.log(line);
+		const color = yield* CliColor.enabled;
+		for (const line of human(diagnostics, { color })) yield* Console.log(line);
 		yield* Console.error(summary(countsOf(diagnostics, result.bundle.concepts.size), displayRoot(cwd, bundleRoot, path)));
 		setExitCode(forDiagnostics(diagnostics));
 	}));

package/commands/lint.js

@@ -1,12 +1,12 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
-import { useColor } from "../internal/tty.js";
 import { displayRoot, human, summary } from "../render/human.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { JsonEnvelope, Now, collect, forDiagnostics, json, jsonError, provideConfig, resolveProjectConfig, run } from "@okfit/engine";
 import { Console, Effect, Layer, Option, Path, Schema } from "effect";
 import { OKF_SPEC_VERSION } from "@okfit/core";
+import { CliColor } from "@effected/cli";
 import { Git } from "@effected/git";
 import { GitHistory } from "@okfit/profiles";
 
@@ -43,7 +43,7 @@ const lintCommand = Command.make("lint", {
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
 	const now = yield* Now;
 	const path = yield* Path.Path;
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const { bundleRoot, config: merged, profile } = yield* resolveProjectConfig({
 			pathArg: input.path,
@@ -76,7 +76,8 @@ const lintCommand = Command.make("lint", {
 			});
 			yield* Console.log(JSON.stringify(Schema.encodeSync(JsonEnvelope)(envelope)));
 		} else {
-			for (const diagnosticLine of human(diagnostics, { color: useColor() })) yield* Console.log(diagnosticLine);
+			const color = yield* CliColor.enabled;
+			for (const diagnosticLine of human(diagnostics, { color })) yield* Console.log(diagnosticLine);
 			const counts = {
 				errors: diagnostics.filter((d) => d.severity === "error").length,
 				warnings: diagnostics.filter((d) => d.severity === "warning").length,

package/commands/stale.js

@@ -1,9 +1,9 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
 import { displayRoot } from "../render/human.js";
 import { humanStale, staleSummary } from "../render/stale.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { Now, StaleEnvelope, jsonError, provideConfig, resolveProjectConfig, runStale, staleEnvelope } from "@okfit/engine";
 import { Console, Effect, Option, Path, Schema } from "effect";
 import { OKF_SPEC_VERSION } from "@okfit/core";
@@ -36,7 +36,7 @@ const staleCommand = Command.make("stale", {
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
 	const now = yield* Now;
 	const path = yield* Path.Path;
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const { bundleRoot, config: merged, profile } = yield* resolveProjectConfig({
 			pathArg: input.path,

package/commands/sync.js

@@ -1,9 +1,9 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
 import { displayRoot } from "../render/human.js";
 import { humanSync } from "../render/sync.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { Now, SyncEnvelope, jsonError, provideConfig, resolveProjectConfig, runSync, syncEnvelope } from "@okfit/engine";
 import { Console, DateTime, Effect, Layer, Option, Path, Schema } from "effect";
 import { Git } from "@effected/git";
@@ -77,7 +77,7 @@ const syncCommand = Command.make("sync", {
 }, (input) => Effect.gen(function* () {
 	const cwd = process.cwd();
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const path = yield* Path.Path;
 		const resolved = yield* resolveProjectConfig({

package/commands/validate.js

@@ -1,13 +1,13 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
-import { useColor } from "../internal/tty.js";
 import { displayRoot, human, summary } from "../render/human.js";
 import { readDocumentText } from "../internal/stdin.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { JsonEnvelope, Now, collect, forDiagnostics, json, jsonError, provideConfig, provideDocuments, resolveProjectConfig, run } from "@okfit/engine";
 import { Console, Effect, Layer, Option, Path, Schema } from "effect";
 import { OKF_SPEC_VERSION } from "@okfit/core";
+import { CliColor } from "@effected/cli";
 import { Git } from "@effected/git";
 import { GitHistory } from "@okfit/profiles";
 
@@ -46,7 +46,7 @@ const validateCommand = Command.make("validate", {
 	const discoveryCwd = Option.getOrElse(input.path, () => cwd);
 	const now = yield* Now;
 	const path = yield* Path.Path;
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const { bundleRoot, config: merged, profile } = yield* resolveProjectConfig({
 			pathArg: input.path,
@@ -83,7 +83,8 @@ const validateCommand = Command.make("validate", {
 			});
 			yield* Console.log(JSON.stringify(Schema.encodeSync(JsonEnvelope)(envelope)));
 		} else {
-			for (const diagnosticLine of human(diagnostics, { color: useColor() })) yield* Console.log(diagnosticLine);
+			const color = yield* CliColor.enabled;
+			for (const diagnosticLine of human(diagnostics, { color })) yield* Console.log(diagnosticLine);
 			const counts = {
 				errors: diagnostics.filter((d) => d.severity === "error").length,
 				warnings: diagnostics.filter((d) => d.severity === "warning").length,

package/commands/verify.js

@@ -1,9 +1,9 @@
-import { Distribution } from "../internal/distribution.js";
 import { setExitCode } from "../internal/exit.js";
 import { CLI_VERSION } from "../version.js";
 import { displayRoot } from "../render/human.js";
 import { humanVerify, humanVerifyBatch } from "../render/verify.js";
 import { Argument, Command, Flag } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { Now, VerifyBatchEnvelope, VerifyEnvelope, VerifySelectionError, jsonError, provideConfig, resolveProjectConfig, runVerify, runVerifyBatch, verifyBatchEnvelope, verifyEnvelope } from "@okfit/engine";
 import { Console, DateTime, Effect, Option, Path, Schema } from "effect";
 import { Timestamp } from "@okfit/core";
@@ -59,7 +59,7 @@ const verifyCommand = Command.make("verify", {
 	const batch = input.all || input.type.length > 0;
 	const effectivePath = batch && Option.isSome(input.id) && Option.isNone(input.path) ? input.id : input.path;
 	const discoveryCwd = Option.getOrElse(effectivePath, () => cwd);
-	const distribution = yield* Distribution;
+	const distribution = yield* CurrentDistribution;
 	const body = Effect.gen(function* () {
 		const path = yield* Path.Path;
 		const resolved = yield* resolveProjectConfig({

package/errors.js

@@ -20,9 +20,11 @@ const relativeToCwd = (path, cwd) => {
 * 1. A `ShowHelp` (any `_tag === "ShowHelp"`) renders as `[]` — the empty
 *    array. `Command.runWith` has already rendered the help document and any
 *    parse errors before re-failing, so a second rendering here would print
-*    "Help requested" after the help text. This is why the K-30 remap in
-*    `bin.ts` can run ahead of `reportFailures` without corrupting `--help`
-*    output.
+*    "Help requested" after the help text. In practice this branch is
+*    defensive only: `@effected/cli`'s `CliRuntime.main`/`reportFailures`
+*    already handles a `ShowHelp` before `render` is ever called
+*    (`main.ts`'s own doc comment), so `renderFailure` never actually sees
+*    one on the path this package uses.
 * 2. `ConfigPathNotFoundError` renders as its own `error: <message>` line;
 *    `InitOverwriteError` renders as the K-51 header, one two-space-indented
 *    relativised path per conflict, and the literal `Nothing was written.`.

package/index.d.ts

@@ -33,9 +33,11 @@ export declare const rootCommand: Command.Command<"okfit", {} | {}, {}, import("
  * 1. A `ShowHelp` (any `_tag === "ShowHelp"`) renders as `[]` — the empty
  *    array. `Command.runWith` has already rendered the help document and any
  *    parse errors before re-failing, so a second rendering here would print
- *    "Help requested" after the help text. This is why the K-30 remap in
- *    `bin.ts` can run ahead of `reportFailures` without corrupting `--help`
- *    output.
+ *    "Help requested" after the help text. In practice this branch is
+ *    defensive only: `@effected/cli`'s `CliRuntime.main`/`reportFailures`
+ *    already handles a `ShowHelp` before `render` is ever called
+ *    (`main.ts`'s own doc comment), so `renderFailure` never actually sees
+ *    one on the path this package uses.
  * 2. `ConfigPathNotFoundError` renders as its own `error: <message>` line;
  *    `InitOverwriteError` renders as the K-51 header, one two-space-indented
  *    relativised path per conflict, and the literal `Nothing was written.`.

package/internal/versionFormatter.js

@@ -1,7 +1,8 @@
-import { useColor } from "./tty.js";
-import { CliOutput } from "effect/unstable/cli";
+import { CurrentDistribution, distributionSuffix } from "@effected/engine";
 import { ENGINE_VERSION } from "@okfit/engine";
+import { Effect, Layer } from "effect";
 import { CONFIG_SCHEMA_VERSION, OKF_SPEC_VERSION } from "@okfit/core";
+import { CliColor } from "@effected/cli";
 
 //#region src/internal/versionFormatter.ts
 /**
@@ -13,20 +14,23 @@ import { CONFIG_SCHEMA_VERSION, OKF_SPEC_VERSION } from "@okfit/core";
 * exactly `okfit <CLI_VERSION>`; this appends the engine, okf, and
 * distribution parts.
 *
-* Only `formatVersion` is overridden -- every other `Formatter` method
-* (help, error rendering) is `CliOutput.defaultFormatter`'s own, built with
-* the SAME colour decision (`internal/tty.ts#useColor`, "exactly the
-* framework's own colour rule") the rest of this package already uses, so
-* help/error output is byte-identical to the built-in formatter.
+* Built on `@effected/cli`'s `CliColor.formatterLayer` (the kit's one
+* colour-decision point, read through the ambient `ConfigProvider`, never
+* `process` directly) and `@effected/engine`'s `distributionSuffix` for the
+* `via <name> <version>` segment -- the shape `effect-v4-cli`'s
+* `recipes.md#version-formatter` teaches. Only `formatVersion` is
+* overridden; every other `Formatter` method (help, error rendering) is
+* `CliColor.formatterLayer`'s own default, so help/error output stays
+* consistent with the rest of the program's colour decision.
+*
+* `Layer.unwrap` around `Effect.map(CurrentDistribution, ...)` reads the
+* distribution once, from the ambient `CurrentDistribution` reference
+* `main.ts` provides, rather than threading it in as a constructor argument
+* the way the hand-rolled formatter used to.
 *
 * @internal
 */
-const versionFormatter = (distribution) => ({
-	...CliOutput.defaultFormatter({ colors: useColor() }),
-	formatVersion: (name, version) => {
-		return `${name} ${version}${distribution === void 0 ? "" : ` via ${distribution.name} ${distribution.version}`} (engine ${ENGINE_VERSION}, okf ${OKF_SPEC_VERSION}, config-schema ${CONFIG_SCHEMA_VERSION})`;
-	}
-});
+const versionFormatterLayer = Layer.unwrap(Effect.map(CurrentDistribution, (distribution) => CliColor.formatterLayer({ formatVersion: (name, version) => `${name} ${version}${distributionSuffix(distribution)} (engine ${ENGINE_VERSION}, okf ${OKF_SPEC_VERSION}, config-schema ${CONFIG_SCHEMA_VERSION})` })));
 
 //#endregion
-export { versionFormatter };
+export { versionFormatterLayer };

package/main.d.ts

@@ -1,4 +1,4 @@
-import { Distribution } from "@okfit/engine";
+import { Distribution } from "@effected/engine";
 //#region src/main.d.ts
 /**
  * Options `@okfit/plugin`'s bin shims (and only they, today) pass to
@@ -15,6 +15,17 @@ export interface MainOptions {
  * Run the okfit CLI. Owns the process: installs the runtime teardown and
  * sets the exit code. `NodeRuntime.runMain` does not return a promise.
  *
+ * Assembled with `@effected/cli`'s `CliRuntime.main` (`effect-v4-cli`'s
+ * `recipes.md#the-main-assembly`), which already provides
+ * `platform` INSIDE failure reporting, a fresh `CliExit` cell, and the
+ * logger outermost -- the same order this package used to assemble by
+ * hand. `CliRuntime.main`/`reportFailures` also already remap a
+ * `CliError.ShowHelp` carrying parse errors to `usageExitCode` (64) and
+ * leave a bare `--help`/root invocation at 0 (`Command.runWith` has
+ * already rendered the help document either way), so the hand-rolled
+ * `catchTag("ShowHelp", ...)` remap this package used to carry is gone --
+ * it duplicated what the kit's own assembly already does.
+ *
  * @public
  */
 export declare const main: (options?: MainOptions) => void;

package/main.js

@@ -1,12 +1,12 @@
-import { Distribution } from "./internal/distribution.js";
 import { CLI_VERSION } from "./version.js";
 import { rootCommand } from "./commands/root.js";
 import { renderFailure } from "./errors.js";
-import { versionFormatter } from "./internal/versionFormatter.js";
-import { CliOutput, Command } from "effect/unstable/cli";
+import { versionFormatterLayer } from "./internal/versionFormatter.js";
+import { Command } from "effect/unstable/cli";
+import { CurrentDistribution } from "@effected/engine";
 import { Now, OkfitPlatform } from "@okfit/engine";
 import { DateTime, Effect, Option } from "effect";
-import { CliLogger, CliRuntime } from "@effected/cli";
+import { CliRuntime } from "@effected/cli";
 import * as NodeRuntime from "@effect/platform-node/NodeRuntime";
 
 //#region src/main.ts
@@ -29,18 +29,30 @@ const nowEffect = Option.fromNullishOr(process.env.OKFIT_NOW).pipe(Option.flatMa
 * Run the okfit CLI. Owns the process: installs the runtime teardown and
 * sets the exit code. `NodeRuntime.runMain` does not return a promise.
 *
+* Assembled with `@effected/cli`'s `CliRuntime.main` (`effect-v4-cli`'s
+* `recipes.md#the-main-assembly`), which already provides
+* `platform` INSIDE failure reporting, a fresh `CliExit` cell, and the
+* logger outermost -- the same order this package used to assemble by
+* hand. `CliRuntime.main`/`reportFailures` also already remap a
+* `CliError.ShowHelp` carrying parse errors to `usageExitCode` (64) and
+* leave a bare `--help`/root invocation at 0 (`Command.runWith` has
+* already rendered the help document either way), so the hand-rolled
+* `catchTag("ShowHelp", ...)` remap this package used to carry is gone --
+* it duplicated what the kit's own assembly already does.
+*
 * @public
 */
 const main = (options = {}) => {
 	const distribution = Option.fromNullishOr(options.distribution);
 	const program = Effect.gen(function* () {
 		const now = yield* nowEffect;
-		return yield* Command.run(rootCommand, { version: CLI_VERSION }).pipe(Effect.provideService(Now, now), Effect.provideService(Distribution, distribution), Effect.catchTag("ShowHelp", (help) => Effect.fail(CliRuntime.reported(help, help.errors.length > 0 ? 64 : 0))));
-	}).pipe(Effect.provide(CliOutput.layer(versionFormatter(options.distribution))), Effect.provide(OkfitPlatform), CliRuntime.reportFailures({
+		return yield* Command.run(rootCommand, { version: CLI_VERSION }).pipe(Effect.provideService(Now, now));
+	}).pipe(Effect.provide(versionFormatterLayer), Effect.provideService(CurrentDistribution, distribution));
+	NodeRuntime.runMain(CliRuntime.main(program, {
+		platform: OkfitPlatform,
 		exitCode: 3,
 		render: renderFailure
 	}));
-	NodeRuntime.runMain(program.pipe(Effect.provide(CliLogger.layer())));
 };
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@okfit/cli",
-	"version": "0.6.5",
+	"version": "0.6.7",
 	"private": false,
 	"description": "The okfit command line: validate, lint, index, and inspect Open Knowledge Format (OKF) bundles.",
 	"keywords": [
@@ -43,18 +43,19 @@
 	},
 	"dependencies": {
 		"@effect/platform-node": "4.0.0-rc.117",
-		"@effected/cli": "^0.7.0",
+		"@effected/cli": "^0.8.0",
 		"@effected/config-file": "^0.12.0",
+		"@effected/engine": "^0.1.0",
 		"@effected/git": "^0.17.0",
 		"@effected/glob": "^0.8.0",
 		"@effected/jsonc": "^0.13.0",
-		"@effected/markdown": "^0.12.0",
+		"@effected/markdown": "^0.12.1",
 		"@effected/toml": "^0.9.0",
 		"@effected/walker": "^0.12.0",
 		"@effected/yaml": "^0.17.0",
-		"@okfit/core": "0.7.4",
-		"@okfit/engine": "0.7.5",
-		"@okfit/profiles": "0.7.5",
+		"@okfit/core": "0.8.0",
+		"@okfit/engine": "0.9.0",
+		"@okfit/profiles": "0.8.0",
 		"effect": "4.0.0-rc.117"
 	},
 	"engines": {

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.59.1"
+      "packageVersion": "7.59.2"
     }
   ]
 }

package/version.js

@@ -11,7 +11,7 @@
 *
 * @public
 */
-const CLI_VERSION = "0.6.5";
+const CLI_VERSION = "0.6.7";
 
 //#endregion
 export { CLI_VERSION };

package/internal/distribution.js

@@ -1,21 +0,0 @@
-import { Context, Option } from "effect";
-
-//#region src/internal/distribution.ts
-/**
-* The meta-package this run's bins were installed through (currently only
-* `@okfit/plugin`), threaded from `main(options)` down to every command
-* that builds a JSON envelope or the custom `--version` formatter (okfit
-* #137). Defaults to `Option.none()` for a direct install of `@okfit/cli`;
-* `main()` provides `Option.some(options.distribution)` exactly once, at
-* the top of the command tree, when the caller supplied one.
-*
-* A `Context.Reference`, not a `Context.Service` (unlike `Now`): it carries
-* its own default, so a command can read it with no explicit provision at
-* all when no distribution was given.
-*
-* @internal
-*/
-const Distribution = Context.Reference("@okfit/cli/Distribution", { defaultValue: () => Option.none() });
-
-//#endregion
-export { Distribution };

package/internal/tty.js

@@ -1,13 +0,0 @@
-//#region src/internal/tty.ts
-/**
-* K-19: exactly the framework's own colour rule. Evaluated once per run at
-* the command boundary and passed to the renderers as a boolean, so every
-* renderer stays pure. The only reader of `process.stdout.isTTY`/`NO_COLOR`
-* in this package.
-*
-* @public
-*/
-const useColor = () => process.stdout.isTTY === true && process.env.NO_COLOR !== "1";
-
-//#endregion
-export { useColor };