@okfit/profiles 0.10.3 → 0.10.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BodyProvenance.js +1 -2
- package/Canonical.js +1 -2
- package/Derivation.js +1 -2
- package/GitHistory.js +1 -2
- package/Profile.js +1 -2
- package/Profiles.js +1 -2
- package/Provenance.js +1 -2
- package/Publications.js +1 -2
- package/SoftwareProject.js +1 -2
- package/Trust.js +1 -2
- package/index.d.ts +0 -18
- package/internal/body.js +1 -2
- package/package.json +4 -4
- package/presets/index.js +1 -2
- package/presets/surfaces.js +1 -2
package/BodyProvenance.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Timestamp } from "@okfit/core";
|
|
2
2
|
import { Schema } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/BodyProvenance.ts
|
|
5
5
|
/**
|
|
6
6
|
* The body is at HEAD and last changed in the commit described here (P-9).
|
|
7
7
|
* `at` is that commit's author date (P-4); `committedAt` and the author
|
|
@@ -40,5 +40,4 @@ const BodyUncommitted = Schema.TaggedStruct("uncommitted", { reason: Schema.Lite
|
|
|
40
40
|
*/
|
|
41
41
|
const BodyProvenance = Schema.Union([BodyCommitted, BodyUncommitted]);
|
|
42
42
|
|
|
43
|
-
//#endregion
|
|
44
43
|
export { BodyCommitted, BodyProvenance, BodyUncommitted };
|
package/Canonical.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { body } from "./internal/body.js";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/Canonical.ts
|
|
4
4
|
/** Top-level keys that are bookkeeping, not authored content (spec section 4). */
|
|
5
5
|
const EXCLUDED_KEYS = /* @__PURE__ */ new Set([
|
|
6
6
|
"generated",
|
|
@@ -64,5 +64,4 @@ var Canonical = class {
|
|
|
64
64
|
static contentInput = contentInput;
|
|
65
65
|
};
|
|
66
66
|
|
|
67
|
-
//#endregion
|
|
68
67
|
export { Canonical };
|
package/Derivation.js
CHANGED
|
@@ -6,7 +6,7 @@ import { Crypto, DateTime, Duration, Effect, FileSystem, Option, Path, Schema }
|
|
|
6
6
|
import { Git } from "@effected/git";
|
|
7
7
|
import * as Hex from "effect/encoding/Hex";
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
// src/Derivation.ts
|
|
10
10
|
/**
|
|
11
11
|
* git has no identity to derive a `human:` actor from (P-13 step 4).
|
|
12
12
|
* `userName` and `userEmail` are the trimmed `configGet` answers when git had
|
|
@@ -281,5 +281,4 @@ var Derivation = class Derivation {
|
|
|
281
281
|
static staleAfter = staleAfter;
|
|
282
282
|
};
|
|
283
283
|
|
|
284
|
-
//#endregion
|
|
285
284
|
export { ActorConfigInvalidError, AgentActorUnconfiguredError, Derivation, HumanActorNotAllowedError, HumanActorUnresolvedError };
|
package/GitHistory.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Timestamp } from "@okfit/core";
|
|
|
2
2
|
import { Context, Effect, Layer, Schema } from "effect";
|
|
3
3
|
import { Git } from "@effected/git";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/GitHistory.ts
|
|
6
6
|
/**
|
|
7
7
|
* One record of the path log, newest first (P-3, P-5): the commit, both dates decoded through core's
|
|
8
8
|
* `Timestamp` (`%aI` / `%cI`, strict ISO with an offset; the `Type` is `DateTime.Utc`, P-4), the author
|
|
@@ -103,5 +103,4 @@ var GitHistory = class GitHistory extends Context.Service()("@okfit/profiles/Git
|
|
|
103
103
|
static layerTest = (script) => Layer.succeed(GitHistory, GitHistory.makeTest(script));
|
|
104
104
|
};
|
|
105
105
|
|
|
106
|
-
//#endregion
|
|
107
106
|
export { GitHistory, GitHistoryError, PathHistoryEntry, make };
|
package/Profile.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { DiagnosticRange, DiagnosticSeverity } from "@okfit/core";
|
|
2
2
|
import { Schema } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Profile.ts
|
|
5
5
|
/**
|
|
6
6
|
* Names of the profiles this package ships (P-38).
|
|
7
7
|
*
|
|
@@ -34,5 +34,4 @@ const ProfileDiagnostic = Schema.Struct({
|
|
|
34
34
|
message: Schema.String
|
|
35
35
|
});
|
|
36
36
|
|
|
37
|
-
//#endregion
|
|
38
37
|
export { PROFILE_NAMES, ProfileDiagnostic, ProfileDiagnosticCode };
|
package/Profiles.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { softwareProject } from "./SoftwareProject.js";
|
|
2
2
|
import { Option } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Profiles.ts
|
|
5
5
|
const REGISTRY = /* @__PURE__ */ new Map([[softwareProject.name, softwareProject]]);
|
|
6
6
|
/**
|
|
7
7
|
* The profile registry (P-38). No third-party registration in phase 1; the
|
|
@@ -23,5 +23,4 @@ var Profiles = class {
|
|
|
23
23
|
};
|
|
24
24
|
};
|
|
25
25
|
|
|
26
|
-
//#endregion
|
|
27
26
|
export { Profiles };
|
package/Provenance.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Derivation } from "./Derivation.js";
|
|
|
2
2
|
import { Diagnostic, DiagnosticRange, OkfitConfig, Timestamp } from "@okfit/core";
|
|
3
3
|
import { DateTime, Effect, Path, Schema } from "effect";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Provenance.ts
|
|
6
6
|
const encodeAt = Schema.encodeSync(Timestamp);
|
|
7
7
|
/**
|
|
8
8
|
* A profiles-owned lint over committed provenance (S-8). NOT a `Profile`
|
|
@@ -97,5 +97,4 @@ var Provenance = class {
|
|
|
97
97
|
});
|
|
98
98
|
};
|
|
99
99
|
|
|
100
|
-
//#endregion
|
|
101
100
|
export { Provenance };
|
package/Publications.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Derivation } from "./Derivation.js";
|
|
|
2
2
|
import { ConceptId, Diagnostic, DiagnosticRange, OkfitConfig } from "@okfit/core";
|
|
3
3
|
import { Effect, Option } from "effect";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Publications.ts
|
|
6
6
|
/**
|
|
7
7
|
* The concept type name of a documentation surface.
|
|
8
8
|
*
|
|
@@ -131,5 +131,4 @@ var Publications = class {
|
|
|
131
131
|
});
|
|
132
132
|
};
|
|
133
133
|
|
|
134
|
-
//#endregion
|
|
135
134
|
export { PUBLICATION_TYPE, Publications, SURFACE_TYPE };
|
package/SoftwareProject.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { DOCS_PRESETS } from "./presets/index.js";
|
|
2
2
|
import { DiagnosticRange } from "@okfit/core";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/SoftwareProject.ts
|
|
5
5
|
/**
|
|
6
6
|
* Hand-authored, typed `OkfitConfig` (P-25). Sets ONLY `concepts`, `types`,
|
|
7
7
|
* `tags`, `extensions: {}` and one `lint` opinion (`status_missing = "warn"`,
|
|
@@ -375,5 +375,4 @@ const softwareProject = {
|
|
|
375
375
|
check
|
|
376
376
|
};
|
|
377
377
|
|
|
378
|
-
//#endregion
|
|
379
378
|
export { softwareProject };
|
package/Trust.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Derivation } from "./Derivation.js";
|
|
|
2
2
|
import { Actor, Derive, Diagnostic, DiagnosticRange, OkfitConfig, Timestamp } from "@okfit/core";
|
|
3
3
|
import { DateTime, Effect, Schema } from "effect";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Trust.ts
|
|
6
6
|
const encodeAt = Schema.encodeSync(Timestamp);
|
|
7
7
|
/**
|
|
8
8
|
* Why a human verification no longer binds: the content changed, the entry has
|
|
@@ -152,5 +152,4 @@ var Trust = class {
|
|
|
152
152
|
static lint = lint;
|
|
153
153
|
};
|
|
154
154
|
|
|
155
|
-
//#endregion
|
|
156
155
|
export { DriftReason, Trust };
|
package/index.d.ts
CHANGED
|
@@ -2,7 +2,6 @@ import { Context, Crypto, DateTime, Effect, FileSystem, Layer, Option, Path, Pla
|
|
|
2
2
|
import { Git, GitCommandError, NotARepositoryError, UnknownRefError } from "@effected/git";
|
|
3
3
|
import { Actor, Diagnostic, DiagnosticRange, Digest, LoadedBundle, LoadedConcept, OkfitConfig, TrustTier } from "@okfit/core";
|
|
4
4
|
import { ChildProcessSpawner } from "effect/process";
|
|
5
|
-
//#region src/BodyProvenance.d.ts
|
|
6
5
|
/**
|
|
7
6
|
* The body is at HEAD and last changed in the commit described here (P-9).
|
|
8
7
|
* `at` is that commit's author date (P-4); `committedAt` and the author
|
|
@@ -59,8 +58,6 @@ export type BodyProvenance = typeof BodyProvenance.Type;
|
|
|
59
58
|
* @public
|
|
60
59
|
*/
|
|
61
60
|
type UncommittedReason = typeof BodyUncommitted.fields.reason.Type;
|
|
62
|
-
//#endregion
|
|
63
|
-
//#region src/Canonical.d.ts
|
|
64
61
|
/**
|
|
65
62
|
* Canonical encoding for okfit's content digest.
|
|
66
63
|
*
|
|
@@ -75,8 +72,6 @@ export declare class Canonical {
|
|
|
75
72
|
/** The exact string a content digest hashes. */
|
|
76
73
|
static readonly contentInput: (raw: Readonly<Record<string, unknown>>, source: string) => string;
|
|
77
74
|
}
|
|
78
|
-
//#endregion
|
|
79
|
-
//#region src/GitHistory.d.ts
|
|
80
75
|
declare const PathHistoryEntry_base: Schema.Class<PathHistoryEntry, Schema.Struct<{
|
|
81
76
|
readonly sha: Schema.String;
|
|
82
77
|
readonly authoredAt: Schema.Codec<import("effect/DateTime").Utc, string, never, never>;
|
|
@@ -159,8 +154,6 @@ export declare class GitHistory extends GitHistory_base {
|
|
|
159
154
|
*/
|
|
160
155
|
static readonly layerTest: (script: Readonly<Record<string, ReadonlyArray<PathHistoryEntry>>>) => Layer.Layer<GitHistory>;
|
|
161
156
|
}
|
|
162
|
-
//#endregion
|
|
163
|
-
//#region src/Derivation.d.ts
|
|
164
157
|
/**
|
|
165
158
|
* Who is writing now. Explicit, never read from the environment (P-16).
|
|
166
159
|
*
|
|
@@ -363,8 +356,6 @@ export declare class Derivation {
|
|
|
363
356
|
*/
|
|
364
357
|
static readonly staleAfter: (from: DateTime.Utc, config: OkfitConfig) => DateTime.Utc;
|
|
365
358
|
}
|
|
366
|
-
//#endregion
|
|
367
|
-
//#region src/Profile.d.ts
|
|
368
359
|
/**
|
|
369
360
|
* Names of the profiles this package ships (P-38).
|
|
370
361
|
*
|
|
@@ -483,8 +474,6 @@ interface Profile {
|
|
|
483
474
|
readonly docsPresets: ReadonlyArray<DocsPreset>;
|
|
484
475
|
readonly check: (bundle: LoadedBundle) => ReadonlyArray<ProfileDiagnostic>;
|
|
485
476
|
}
|
|
486
|
-
//#endregion
|
|
487
|
-
//#region src/Profiles.d.ts
|
|
488
477
|
/**
|
|
489
478
|
* The profile registry (P-38). No third-party registration in phase 1; the
|
|
490
479
|
* `DEFAULTS < profile < file` merge is the CLI's (D-28).
|
|
@@ -501,8 +490,6 @@ export declare class Profiles {
|
|
|
501
490
|
*/
|
|
502
491
|
static readonly get: (name: string) => Option.Option<Profile>;
|
|
503
492
|
}
|
|
504
|
-
//#endregion
|
|
505
|
-
//#region src/Provenance.d.ts
|
|
506
493
|
/**
|
|
507
494
|
* A profiles-owned lint over committed provenance (S-8). NOT a `Profile`
|
|
508
495
|
* member and NOT a `ProfileDiagnostic` -- it returns core `Diagnostic`s with
|
|
@@ -560,8 +547,6 @@ export declare class Provenance {
|
|
|
560
547
|
readonly skipGitTier?: boolean;
|
|
561
548
|
}) => Effect.Effect<ReadonlyArray<Diagnostic>, GitHistoryError | GitCommandError | UnknownRefError | PlatformError.PlatformError, Git | GitHistory | FileSystem.FileSystem | Path.Path | Crypto.Crypto>;
|
|
562
549
|
}
|
|
563
|
-
//#endregion
|
|
564
|
-
//#region src/Publications.d.ts
|
|
565
550
|
/**
|
|
566
551
|
* The concept type name of a documentation surface.
|
|
567
552
|
*
|
|
@@ -602,8 +587,6 @@ export declare class Publications {
|
|
|
602
587
|
/** Lints every Publication in `bundle`; diagnostics are sorted by file then code. */
|
|
603
588
|
static readonly lint: (bundle: LoadedBundle, config: OkfitConfig) => Effect.Effect<ReadonlyArray<Diagnostic>, PlatformError.PlatformError, Crypto.Crypto>;
|
|
604
589
|
}
|
|
605
|
-
//#endregion
|
|
606
|
-
//#region src/Trust.d.ts
|
|
607
590
|
/**
|
|
608
591
|
* Whether a concept's human verification still covers its content: `none` (no
|
|
609
592
|
* `human:` entry in `verified`), `current` (the latest human entry is bound by
|
|
@@ -695,6 +678,5 @@ export declare class Trust {
|
|
|
695
678
|
*/
|
|
696
679
|
static readonly lint: (bundle: LoadedBundle, config: OkfitConfig, now: DateTime.Utc, signals?: ReadonlyMap<string, ConceptSignal>) => Effect.Effect<Array<Diagnostic>, PlatformError.PlatformError, Crypto.Crypto>;
|
|
697
680
|
}
|
|
698
|
-
//#endregion
|
|
699
681
|
export type { ConceptSignal, DocsPreset, EvaluateInput, GeneratedAtError, GeneratedAtOptions, GeneratedByError, GeneratedByOptions, GitHistoryShape, GitIdentity, IntegrityState, Layout, LayoutDirectory, PathLogOptions, Profile, ProfileName, RendersEntry, SurfaceTemplate, UncommittedReason, VerifierError, Writer };
|
|
700
682
|
//# sourceMappingURL=index.d.ts.map
|
package/internal/body.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FrontmatterSource } from "@effected/markdown";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/internal/body.ts
|
|
4
4
|
const normalise = (text) => text.replace(/\r\n?/g, "\n").trimEnd();
|
|
5
5
|
/**
|
|
6
6
|
* The normalised body of a concept source (`FrontmatterSource.split(text).body`, then P-6 normalisation).
|
|
@@ -9,5 +9,4 @@ const normalise = (text) => text.replace(/\r\n?/g, "\n").trimEnd();
|
|
|
9
9
|
*/
|
|
10
10
|
const body = (text) => normalise(FrontmatterSource.split(text).body);
|
|
11
11
|
|
|
12
|
-
//#endregion
|
|
13
12
|
export { body };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@okfit/profiles",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.5",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Named OKF configuration profiles for okfit, starting with the software-project profile.",
|
|
6
6
|
"keywords": [
|
|
@@ -35,9 +35,9 @@
|
|
|
35
35
|
"./package.json": "./package.json"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
|
-
"@effected/git": "^0.
|
|
39
|
-
"@effected/markdown": "^0.
|
|
40
|
-
"@okfit/core": "^0.11.
|
|
38
|
+
"@effected/git": "^0.24.0",
|
|
39
|
+
"@effected/markdown": "^0.20.0",
|
|
40
|
+
"@okfit/core": "^0.11.4",
|
|
41
41
|
"effect": "^4.0.0"
|
|
42
42
|
},
|
|
43
43
|
"engines": {
|
package/presets/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CONTRIBUTOR_GUIDES, DOCS_PACKAGE, DOCS_PACKAGES, DOCS_REPO, README_PACKAGE, README_PACKAGES, README_PACKAGES_ONE_PAGE, README_PACKAGE_ONE_PAGE, README_ROOT, README_ROOT_ONE_PAGE, SITE } from "./surfaces.js";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/presets/index.ts
|
|
4
4
|
/**
|
|
5
5
|
* The docs-surface presets the `software-project` profile offers, one per
|
|
6
6
|
* repository shape. Three replace a repository's surfaces; `site` is
|
|
@@ -47,5 +47,4 @@ const DOCS_PRESETS = [
|
|
|
47
47
|
}
|
|
48
48
|
];
|
|
49
49
|
|
|
50
|
-
//#endregion
|
|
51
50
|
export { DOCS_PRESETS };
|
package/presets/surfaces.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/presets/surfaces.ts
|
|
2
2
|
const FENCE = "```";
|
|
3
3
|
/**
|
|
4
4
|
* The durable prose rules every surface body repeats, ported from the
|
|
@@ -314,5 +314,4 @@ const SITE = {
|
|
|
314
314
|
body: body("# Documentation site", "## Who reads this", "People using the project who want guides, reference and worked tutorials. This is the long-form home; the READMEs only point here.", "## Required structure", "Organize pages by what the reader is trying to do: a getting-started path first, task guides next, reference last. Give every page one clear job, a sentence-case title and a short summary before the first heading. Link between pages instead of repeating their content.", "Replace the placeholder `url` in this concept's frontmatter with the real published address before relying on it.", "## Other surfaces", "The README carries only the pitch, the install command and one quick start, and links here for everything else; contributor workflow belongs in contributor docs.", RULES)
|
|
315
315
|
};
|
|
316
316
|
|
|
317
|
-
//#endregion
|
|
318
317
|
export { CONTRIBUTOR_GUIDES, DOCS_PACKAGE, DOCS_PACKAGES, DOCS_REPO, README_PACKAGE, README_PACKAGES, README_PACKAGES_ONE_PAGE, README_PACKAGE_ONE_PAGE, README_ROOT, README_ROOT_ONE_PAGE, SITE };
|