@okfit/cli 0.4.1 → 0.5.0

package/README.md

@@ -113,6 +113,34 @@ $ echo $?
 and names every colliding file in one error. An ancestor directory's config
 is a legitimate discovery hit, not a collision, and is never probed.
 
+If the repository lints markdown, the bundle needs two exemptions from
+markdownlint's defaults, and neither can be satisfied at the source: MD025
+(one top-level heading) counts a concept's frontmatter `title:` as its H1,
+so the body H1 the spec requires reads as a second one, and the spec shapes
+every `index.md` as `# Section` groups, one H1 per concept type. `log.md`
+is fine: `init` and `sync` both start it with `# Log`. Add this to a
+`.markdownlint-cli2.jsonc` at the repository root, adjusting the bundle
+path if `bundle.path` is not `okf`:
+
+```jsonc
+"overrides": [
+ {
+  "combine": "merge",
+  "config": { "MD025": { "front_matter_title": "" } },
+  "filter": ["okf/**/*.md", "!okf/**/index.md"]
+ },
+ {
+  "combine": "merge",
+  "config": { "MD025": false },
+  "filter": ["okf/**/index.md"]
+ }
+]
+```
+
+A repository whose lint config cannot express overrides can drop a nested
+`okf/.markdownlint-cli2.jsonc` carrying `{ "config": { "MD025": false } }`
+instead; the bundle loader ignores non-markdown files.
+
 `--profile <name>` picks the profile `init` scaffolds for (default: the
 config's `bundle.profile`, itself defaulting to `software-project`); an
 unrecognised name is a warning, not a failure — `init` continues with the

package/commands/init.js

@@ -3,8 +3,7 @@ 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, SCHEMA_DIRECTIVE, collect, configValue, files, forDiagnostics, provideConfig, resolveBundleRoot, resolveProjectRoot, run, targetPaths } from "@okfit/engine";
-import { Console, DateTime, Effect, FileSystem, Layer, Option, Path, Schema } from "effect";
-import { TomlCodec } from "@effected/config-file";
+import { Console, DateTime, Effect, FileSystem, Layer, Option, Path } from "effect";
 import { Git } from "@effected/git";
 import { OKF_SPEC_VERSION, OkfitConfig, OkfitConfigFile } from "@okfit/core";
 import { GitHistory, Profiles } from "@okfit/profiles";
@@ -100,7 +99,8 @@ const initCommand = Command.make("init", {
 		explicitConfigPath: input.config,
 		discoveryCwd
 	})(Effect.gen(function* () {
-		const winner = (yield* (yield* OkfitConfigFile).discover)[0];
+		const configFile = yield* OkfitConfigFile;
+		const winner = (yield* configFile.discover)[0];
 		const fileConfig = winner === void 0 ? { extensions: {} } : winner.value;
 		const profileName = Option.getOrElse(input.profile, () => fileConfig.bundle?.profile ?? DEFAULT_PROFILE_NAME);
 		const profile = Profiles.get(profileName);
@@ -145,12 +145,10 @@ const initCommand = Command.make("init", {
 		});
 		for (const target of paths) yield* fs.makeDirectory(path.dirname(target), { recursive: true });
 		const bundlePath = merged.bundle?.path ?? DEFAULT_BUNDLE_PATH;
-		const encoded = yield* Schema.encodeEffect(OkfitConfig)(configValue({
+		yield* configFile.write(configValue({
 			...scaffoldOptions,
 			bundlePath
-		}));
-		const toml = yield* TomlCodec.stringify(encoded);
-		yield* fs.writeFileString(`${projectRoot}/${CONFIG_RELATIVE_PATH}`, `${SCHEMA_DIRECTIVE}${toml}`);
+		}), `${projectRoot}/${CONFIG_RELATIVE_PATH}`, { header: SCHEMA_DIRECTIVE });
 		const scaffoldFiles = yield* files(scaffoldOptions);
 		for (const file of scaffoldFiles) yield* fs.writeFileString(file.path, file.contents);
 		yield* Console.log(`Initialized ${displayRoot(cwd, bundleRoot, path)} with the ${profileName} profile`);

package/index.d.ts

@@ -20,7 +20,7 @@ import "effect";
  *
  * @public
  */
-export declare const rootCommand: Command.Command<"okfit", {} | {}, {}, import("@okfit/profiles").AgentActorUnconfiguredError | import("@okfit/core").BundleDepthExceededError | import("@okfit/core").BundleReadError | import("@okfit/core").BundleRootNotFoundError | import("@effected/config-file").ConfigCodecError | import("@effected/config-file").ConfigFileReadError | import("@okfit/engine").ConfigMalformedError | import("@okfit/engine").ConfigPathNotFoundError | import("@effected/config-file").ConfigValidationError | import("@effected/markdown").FrontmatterEncodeError | import("@effected/markdown").FrontmatterFormatMismatchError | import("@effected/markdown").FrontmatterValidationError | import("@effected/git").GitCommandError | import("@okfit/profiles").GitHistoryError | import("@okfit/profiles").HumanActorUnresolvedError | import("@okfit/engine").InitOverwriteError | import("@effected/markdown").MarkdownParseError | import("@effected/git").NotARepositoryError | import("effect/PlatformError").PlatformError | import("effect/Schema").SchemaError | import("@effected/git").UnknownRefError | import("@okfit/engine").VerifyConceptNotFoundError | import("@okfit/engine").VerifyUnsupportedFrontmatterError | import("@effected/yaml").YamlParseError, import("@effected/xdg").AppDirs | import("effect/unstable/process/ChildProcessSpawner").ChildProcessSpawner | import("effect/Crypto").Crypto | import("effect/FileSystem").FileSystem | import("@okfit/engine").Now | import("effect/Path").Path | import("@effected/xdg").Xdg>;
+export declare const rootCommand: Command.Command<"okfit", {} | {}, {}, import("@okfit/profiles").AgentActorUnconfiguredError | import("@okfit/core").BundleDepthExceededError | import("@okfit/core").BundleReadError | import("@okfit/core").BundleRootNotFoundError | import("@effected/config-file").ConfigCodecError | import("@effected/config-file").ConfigFileReadError | import("@effected/config-file").ConfigFileWriteError | import("@okfit/engine").ConfigMalformedError | import("@okfit/engine").ConfigPathNotFoundError | import("@effected/config-file").ConfigValidationError | import("@effected/markdown").FrontmatterEncodeError | import("@effected/markdown").FrontmatterFormatMismatchError | import("@effected/markdown").FrontmatterValidationError | import("@effected/git").GitCommandError | import("@okfit/profiles").GitHistoryError | import("@okfit/profiles").HumanActorUnresolvedError | import("@okfit/engine").InitOverwriteError | import("@effected/markdown").MarkdownParseError | import("@effected/git").NotARepositoryError | import("effect/PlatformError").PlatformError | import("effect/Schema").SchemaError | import("@effected/git").UnknownRefError | import("@okfit/engine").VerifyConceptNotFoundError | import("@okfit/engine").VerifyUnsupportedFrontmatterError | import("@effected/yaml").YamlParseError, import("@effected/xdg").AppDirs | import("effect/unstable/process/ChildProcessSpawner").ChildProcessSpawner | import("effect/Crypto").Crypto | import("effect/FileSystem").FileSystem | import("@okfit/engine").Now | import("effect/Path").Path | import("@effected/xdg").Xdg>;
 //#endregion
 //#region src/errors.d.ts
 /**
@@ -66,8 +66,9 @@ export declare const renderFailure: (error: unknown) => ReadonlyArray<string>;
 //#endregion
 //#region src/render/context.d.ts
 /**
- * The `human` format: a short header block, then one line per type and one
- * per tag. Pure; the caller pipes each line through `Console.log`.
+ * The `human` format: a short header block, then one line per type (plus
+ * its constraint lines, when it has any) and one per tag. Pure; the caller
+ * pipes each line through `Console.log`.
  *
  * The `profile:` line reads `profile: (none) (requested NAME, unknown)`
  * when `profile` and `profile_requested` disagree over an actually-unknown

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@okfit/cli",
-	"version": "0.4.1",
+	"version": "0.5.0",
 	"private": false,
 	"description": "The okfit command line: validate, lint, index, and inspect Open Knowledge Format (OKF) bundles.",
 	"keywords": [
@@ -43,18 +43,18 @@
 	},
 	"dependencies": {
 		"@effect/platform-node": "4.0.0-rc.115",
-		"@effected/cli": "^0.4.0",
-		"@effected/config-file": "^0.8.0",
-		"@effected/git": "^0.15.0",
+		"@effected/cli": "^0.4.1",
+		"@effected/config-file": "^0.9.0",
+		"@effected/git": "^0.15.1",
 		"@effected/glob": "^0.6.0",
 		"@effected/jsonc": "^0.11.0",
 		"@effected/markdown": "^0.10.0",
 		"@effected/toml": "^0.7.0",
-		"@effected/walker": "^0.8.0",
-		"@effected/yaml": "^0.15.0",
-		"@okfit/core": "0.3.1",
-		"@okfit/engine": "0.2.1",
-		"@okfit/profiles": "0.3.1",
+		"@effected/walker": "^0.9.0",
+		"@effected/yaml": "^0.15.1",
+		"@okfit/core": "0.4.0",
+		"@okfit/engine": "0.3.0",
+		"@okfit/profiles": "0.4.0",
 		"effect": "4.0.0-rc.115"
 	},
 	"engines": {

package/render/context.js

@@ -1,7 +1,20 @@
 //#region src/render/context.ts
+/** `kind (a | b)` for an enum field, `resource (path)` for a path field, bare `layer` for free text. */
+const renderField = (field) => field.values !== null ? `${field.name} (${field.values.map((v) => v.name).join(" | ")})` : field.kind !== null ? `${field.name} (${field.kind})` : field.name;
 /**
-* The `human` format: a short header block, then one line per type and one
-* per tag. Pure; the caller pipes each line through `Console.log`.
+* The constraint lines under one type bullet (issue #33): what `validate`
+* will require of a concept of this type, so an agent learns it here and
+* not from a lint error. Empty for a type that declares none.
+*/
+const constraintLines = (type) => [
+	...type.required !== null && type.required.length > 0 ? [`    required: ${type.required.join(", ")}`] : [],
+	...type.require_verified === true ? ["    verified: required"] : [],
+	...type.fields.length > 0 ? [`    fields: ${type.fields.map(renderField).join(", ")}`] : []
+];
+/**
+* The `human` format: a short header block, then one line per type (plus
+* its constraint lines, when it has any) and one per tag. Pure; the caller
+* pipes each line through `Console.log`.
 *
 * The `profile:` line reads `profile: (none) (requested NAME, unknown)`
 * when `profile` and `profile_requested` disagree over an actually-unknown
@@ -19,7 +32,7 @@ const humanContext = (envelope) => [
 	`agent: ${envelope.actors.agent ?? "(unset)"}`,
 	"",
 	"types:",
-	...envelope.types.map((t) => `  ${t.name}  ${t.description ?? ""}`),
+	...envelope.types.flatMap((t) => [`  ${t.name}  ${t.description ?? ""}`, ...constraintLines(t)]),
 	"",
 	"tags:",
 	...envelope.tags.map((t) => `  ${t.name}  ${t.description ?? ""}`)

package/version.js

@@ -8,7 +8,7 @@
 *
 * @public
 */
-const CLI_VERSION = "0.4.1";
+const CLI_VERSION = "0.5.0";
 
 //#endregion
 export { CLI_VERSION };