@effected/templates 0.9.0 → 0.10.0

package/CommentStyle.js

@@ -23,8 +23,7 @@ const Delimiter = Schema.String.check(Schema.isPattern(/^\P{Cc}+$/u));
 * @remarks
 * A **line** style carries only a `prefix` (`#`, `//`); a **wrapped** style
 * carries a `suffix` as well (`<!--` … `-->`). The wrapped form is what makes
-* managed sections representable in Markdown, HTML and XML, which the two-way
-* literal union this replaces could not express.
+* managed sections representable in Markdown, HTML and XML.
 *
 * The preset set is a convenience, not a closed world: a format nobody
 * anticipated is one `CommentStyle.make({ prefix: "%" })` away.
@@ -54,7 +53,7 @@ var CommentStyle = class CommentStyle extends Schema.Class("CommentStyle")({
 	static semicolon = CommentStyle.make({ prefix: ";" });
 	/** SQL, Lua, Haskell. */
 	static dash = CommentStyle.make({ prefix: "--" });
-	/** Markdown, HTML, XML — the wrapped style v3 could not represent. */
+	/** Markdown, HTML, XML — a wrapped style. */
 	static html = CommentStyle.make({
 		prefix: "<!--",
 		suffix: "-->"
@@ -88,8 +87,8 @@ var CommentStyle = class CommentStyle extends Schema.Class("CommentStyle")({
 	* The `NUL` separator is not cosmetic: without it `{ prefix: "ab" }`
 	* and `{ prefix: "a", suffix: "b" }` would produce the same id and two
 	* genuinely different styles would collide in a lookup table. `NUL`
-	* cannot occur in a delimiter, which the single-line check guarantees is
-	* printable-ish, so the encoding is unambiguous.
+	* cannot occur in a delimiter, because delimiters exclude control characters,
+	* so the encoding is unambiguous.
 	*/
 	get id() {
 		return `${this.prefix}\u0000${this.suffix ?? ""}`;

package/ManagedSection.js

@@ -40,9 +40,7 @@ const notFound = (error) => error.reason._tag === "NotFound";
 * BOM-carrying file silently delete the BOM, which violates this package's
 * central promise that every byte outside a managed span survives. Reading
 * bytes and decoding with `ignoreBOM: true` keeps the mark in the leading
-* text span, where it is preserved like any other content — pinned by
-* `__test__/integration/ManagedSection.int.test.ts`'s "preserves a
-* byte-order mark through a sync".
+* text span, where it is preserved like any other content.
 */
 const decoder = new TextDecoder("utf-8", { ignoreBOM: true });
 const make = (options = {}) => Effect.gen(function* () {

package/README.md

@@ -7,10 +7,10 @@
 
 Managed sections: delimited `BEGIN`/`END` blocks inside files whose surrounding content belongs to the user. A tool owns the block, the user owns everything else, and neither destroys the other — the mechanism behind a generated hook, a managed config fragment, or any file your tool and your user both need to edit.
 
-> **Pre-release.** This package is part of the `@effected/*` kit, in pre-`1.0.0`
-> development against a single pinned Effect v4 prerelease. Packages graduate to
-> `1.0.0` once Effect `4.0.0` ships. To hold your own `effect` versions at
-> exactly the ones the kit is built and tested against, install
+> **Pre-`1.0.0`.** This package is part of the `@effected/*` kit, built on stable
+> Effect v4 (`effect` `^4.0.0`) and still in `0.x` development. Stable Effect
+> makes a kit `1.0.0` possible, not automatic. To keep your `effect` and
+> `@effect/*` versions on the line the kit is built and tested against, install
 > [`@effected/pnpm-plugin-effect`](https://www.npmjs.com/package/@effected/pnpm-plugin-effect).
 >
 > **Stability: unstable.** This package's API surface is not yet considered

package/Section.js

@@ -22,7 +22,7 @@ import { Effect, Schema } from "effect";
 *
 * @public
 */
-const SectionKey = Schema.String.check(Schema.isPattern(/^[A-Za-z0-9][A-Za-z0-9._-]*$/));
+const SectionKey = Schema.String.check(Schema.isPattern(/^[A-Za-z0-9][A-Za-z0-9._-]*$/u));
 /**
 * What identifies a managed section inside a document: its key and the
 * comment style its markers are written in.
@@ -74,10 +74,8 @@ var SectionId = class extends Schema.Class("SectionId")({
 * markers.
 *
 * @remarks
-* Equality is **structural and whitespace-significant**. The v3 model this
-* replaces compared trimmed, whitespace-collapsed content, which silently
-* swallowed any template change that altered only indentation — the change
-* compared equal, reported `Unchanged`, and never reached the file. The one
+* Equality is **structural and whitespace-significant**: a template change that
+* alters only indentation is a real change and reaches the file. The one
 * normalization this package applies is to line endings, and it happens at
 * parse time rather than inside equality, so `Equal.equals` stays honest for
 * a consumer comparing two sections directly.

package/SectionDialect.js

@@ -56,9 +56,7 @@ const escapeRegex = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 const GAP = "[ \\t]+";
 /**
 * Compiled matchers are cached per dialect instance. A `WeakMap` rather than
-* a field keeps `SectionDialect` a pure schema class — v3 hung a non-schema
-* private field off its definition class and had to hand-copy it on every
-* derivation.
+* a field keeps `SectionDialect` a pure schema class.
 */
 const matcherCache = /* @__PURE__ */ new WeakMap();
 /**
@@ -86,7 +84,7 @@ var SectionDialect = class SectionDialect extends Schema.Class("SectionDialect")
 	* phrase can never contain the `---` rule and make a marker ambiguous
 	* against itself.
 	*/
-	phrase: Schema.String.check(Schema.isPattern(/^[A-Za-z0-9][A-Za-z0-9 _]*$/)),
+	phrase: Schema.String.check(Schema.isPattern(/^[A-Za-z0-9][A-Za-z0-9 _]*$/u)),
 	/** Which comment styles the document scanner recognizes. At least one. */
 	styles: Schema.Array(CommentStyle).check(Schema.isMinLength(1))
 }) {

package/index.d.ts

@@ -12,8 +12,7 @@ declare const CommentStyle_base: Schema.Class<CommentStyle, Schema.Struct<{
  * @remarks
  * A **line** style carries only a `prefix` (`#`, `//`); a **wrapped** style
  * carries a `suffix` as well (`<!--` … `-->`). The wrapped form is what makes
- * managed sections representable in Markdown, HTML and XML, which the two-way
- * literal union this replaces could not express.
+ * managed sections representable in Markdown, HTML and XML.
  *
  * The preset set is a convenience, not a closed world: a format nobody
  * anticipated is one `CommentStyle.make({ prefix: "%" })` away.
@@ -38,7 +37,7 @@ export declare class CommentStyle extends CommentStyle_base {
   static readonly semicolon: CommentStyle;
   /** SQL, Lua, Haskell. */
   static readonly dash: CommentStyle;
-  /** Markdown, HTML, XML — the wrapped style v3 could not represent. */
+  /** Markdown, HTML, XML — a wrapped style. */
   static readonly html: CommentStyle;
   /** CSS, and the block form of every C-family language. */
   static readonly block: CommentStyle;
@@ -59,8 +58,8 @@ export declare class CommentStyle extends CommentStyle_base {
    * The `NUL` separator is not cosmetic: without it `{ prefix: "ab" }`
    * and `{ prefix: "a", suffix: "b" }` would produce the same id and two
    * genuinely different styles would collide in a lookup table. `NUL`
-   * cannot occur in a delimiter, which the single-line check guarantees is
-   * printable-ish, so the encoding is unambiguous.
+   * cannot occur in a delimiter, because delimiters exclude control characters,
+   * so the encoding is unambiguous.
    */
   get id(): string;
   /** True when the style wraps its content, i.e. it carries a suffix. */
@@ -144,10 +143,8 @@ declare const Section_base: Schema.Class<Section, Schema.Struct<{
  * markers.
  *
  * @remarks
- * Equality is **structural and whitespace-significant**. The v3 model this
- * replaces compared trimmed, whitespace-collapsed content, which silently
- * swallowed any template change that altered only indentation — the change
- * compared equal, reported `Unchanged`, and never reached the file. The one
+ * Equality is **structural and whitespace-significant**: a template change that
+ * alters only indentation is a real change and reaches the file. The one
  * normalization this package applies is to line endings, and it happens at
  * parse time rather than inside equality, so `Equal.equals` stays honest for
  * a consumer comparing two sections directly.
@@ -319,11 +316,8 @@ export declare class SectionDialect extends SectionDialect_base {
  * What a sync did to one declared section.
  *
  * @remarks
- * `Updated` carries **both sides** rather than a diff. The model this replaces
- * computed a set difference over lines, which deduplicated, ignored order, and
- * reported a pure line reordering as no change at all — a diff that could say
- * "nothing changed" about changed content. Every consumer of that model read
- * only the tag, so the honest primitive is the pair; a caller wanting a
+ * `Updated` carries **both sides** rather than a diff, so a pure line
+ * reordering is never reported as "nothing changed". A caller wanting a
  * rendering diffs `before.content` against `after.content` with the diff
  * library of its choice.
  *
@@ -438,10 +432,8 @@ export declare const SyncOutcome: {
  * What a check found, without touching the document.
  *
  * @remarks
- * Three flat variants rather than the `Found({ isUpToDate, diff })` +
- * `NotFound` pair they replace: a boolean beside a diff that already encodes
- * the same fact is two sources of truth for one question, and it forces every
- * caller through a nested branch.
+ * Three flat variants (`Absent`, `UpToDate`, `Drifted`), so every caller
+ * branches once on one tag instead of through a nested check.
  *
  * @public
  */
@@ -729,11 +721,9 @@ export declare class SectionFileError extends SectionFileError_base {
  * the service class, and so the surface is a reviewable declaration rather
  * than whatever the implementation happened to return.
  *
- * Every member is **data-first**: the path comes first and nothing is dual.
- * The model this replaces made all seven members dual, which doubled the
- * declared surface for a data-last form no call site used — and a dual member
- * cannot be stubbed with a one-line override in {@link ManagedSection.layerTest},
- * because the override has to satisfy both overloads.
+ * Every member is **data-first**: the path comes first and nothing is dual,
+ * so a member can be stubbed with a one-line override in
+ * {@link ManagedSection.layerTest}.
  *
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/templates",
-	"version": "0.9.0",
+	"version": "0.10.0",
 	"private": false,
 	"description": "Managed-section blocks in user-editable files: parse, reconcile, sync and check delimited regions.",
 	"keywords": [
@@ -37,7 +37,7 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"effect": "4.0.0-rc.118"
+		"effect": "^4.0.0"
 	},
 	"engines": {
 		"node": ">=24.11.0"