taglify 1.0.1

package/README.md

@@ -0,0 +1,120 @@
+# Taglify — keep generated content in sync, everywhere
+
+[![npm version](https://img.shields.io/npm/v/taglify)](https://www.npmjs.com/package/taglify)
+[![license](https://img.shields.io/npm/l/taglify)](./LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)](./tsconfig.json)
+[![CI](https://github.com/jayf0x/taglify/actions/workflows/ci.yml/badge.svg)](https://github.com/jayf0x/taglify/actions/workflows/ci.yml)
+
+![Preview](./assets/preview.png)
+
+> ⭐ **Star this [repository](https://github.com/jayf0x/taglify) if you’d like to support its growth.**
+
+I was writing bash functions to have my e2e tests output live stats in the
+README of [compress-shader-literals](https://github.com/jayf0x/compress-shader-literals).
+Then I started reaching for the same trick in other tools and thought "why not ship this".
+Enjoy 🤗
+
+## Installation
+
+```bash
+bun add taglify
+# OR npm / pnpm / yarn ...
+```
+
+## Example
+
+In your README:
+
+```md
+<!-- STATS:START -->
+<!-- STATS:END -->
+```
+
+You build or release flow:
+
+```js
+// scripts/sync-readme.js
+import { taglifyFile } from 'taglify';
+
+const coverageSummary = '...';
+taglifyFile('./README.md', { STATS: coverageSummary });
+```
+
+```json
+// package.json
+{
+  "scripts": {
+    "prepublishOnly": "bun run scripts/sync-readme.js"
+  }
+}
+```
+
+result:
+
+```md
+| Browser | Passed | Failed |
+| ------- | ------ | ------ |
+| Brave   | 127    | 0      |
+| Firefox | 127    | 0      |
+| Edge    | 0      | 127    |
+```
+
+---
+
+Same idea works in a CI step, a git pre-commit hook, or a cron job.
+
+## API
+
+### `taglifyText(text, tags)`
+
+| Param  | Type                     | Description                    |
+| ------ | ------------------------ | ------------------------------ |
+| `text` | `string`                 | Source text                    |
+| `tags` | `Record<string, string>` | Tag name → replacement content |
+
+Returns `{ text: string, changed: boolean }`.
+
+### `taglifyFile(filePath, tags)`
+
+Reads `filePath`, applies `taglifyText`, and writes back only if the content
+changed.
+
+- Returns `boolean` — whether the file was modified.
+- Throws a friendly error (`File not found: <path>`) if the file doesn't
+  exist.
+
+---
+
+## Marker format
+
+```html
+<!-- TAG:START -->
+content
+<!-- TAG:END -->
+```
+
+| Rule                       | Behavior                                  |
+| -------------------------- | ----------------------------------------- |
+| Tag name casing            | Case-insensitive, normalized to uppercase |
+| Content between markers    | Fully replaced                            |
+| Markers themselves         | Always preserved                          |
+| Multiple blocks, same tag  | All replaced                              |
+| Tag with no matching block | Skipped                                   |
+| Replacement value type     | `string` only                             |
+
+---
+
+## Roadmap
+
+Taglify is a small, deliberately minimal util today. These are ideas for
+where it could go — see [BACKLOG.md](./BACKLOG.md) for the full list.
+
+- [ ] Configurable marker syntax and comment styles (`//`, `#`, `/* */`)
+- [ ] Create missing blocks instead of skipping
+- [ ] CLI with dry-run and diff output
+- [ ] Glob / directory processing
+- [ ] Support non-string values, serialized as formatted JSON
+
+## License
+
+[MIT](./LICENSE) © [jayF0x](https://github.com/jayf0x)

package/dist/index.cjs

@@ -0,0 +1,81 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+function __accessProp(key) {
+  return this[key];
+}
+var __toCommonJS = (from) => {
+  var entry = (__moduleCache ??= new WeakMap).get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (var key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(entry, key))
+        __defProp(entry, key, {
+          get: __accessProp.bind(from, key),
+          enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+        });
+  }
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __moduleCache;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: __exportSetter.bind(all, name)
+    });
+};
+
+// src/index.ts
+var exports_src = {};
+__export(exports_src, {
+  taglifyText: () => taglifyText,
+  taglifyFile: () => taglifyFile
+});
+module.exports = __toCommonJS(exports_src);
+var import_node_fs = require("node:fs");
+var escapeRegExp = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+var taglifyText = (text, tags) => {
+  let output = text;
+  for (const [tagName, replacement] of Object.entries(tags)) {
+    const tag = escapeRegExp(tagName.toUpperCase());
+    const blockRegex = new RegExp(`<!-- ${tag}:START -->(.*?)<!-- ${tag}:END -->`, "gis");
+    output = output.replace(blockRegex, (_match, block) => {
+      const lineEnding = block.includes(`\r
+`) ? `\r
+` : `
+`;
+      return `<!-- ${tag}:START -->${lineEnding}${replacement}${lineEnding}<!-- ${tag}:END -->`;
+    });
+  }
+  return {
+    text: output,
+    changed: output !== text
+  };
+};
+var taglifyFile = (filePath, tags) => {
+  let text;
+  try {
+    text = import_node_fs.readFileSync(filePath, "utf8");
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      throw new Error(`File not found: ${filePath}`);
+    }
+    throw error;
+  }
+  const result = taglifyText(text, tags);
+  if (result.changed) {
+    import_node_fs.writeFileSync(filePath, result.text, "utf8");
+  }
+  return result.changed;
+};

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+export interface TaglifyResult {
+    text: string;
+    changed: boolean;
+}
+/**
+ * Replaces content between HTML comment markers.
+ *
+ * Example:
+ * <!-- BADGES:START -->
+ * old content
+ * <!-- BADGES:END -->
+ */
+export declare const taglifyText: (text: string, tags: Record<string, string>) => TaglifyResult;
+/**
+ * Applies tag replacements to a file.
+ *
+ * Returns true if the file was modified.
+ * Throws a friendly error if the file does not exist.
+ */
+export declare const taglifyFile: (filePath: string, tags: Record<string, string>) => boolean;

package/dist/index.js

@@ -0,0 +1,38 @@
+// src/index.ts
+import { readFileSync, writeFileSync } from "node:fs";
+var escapeRegExp = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+var taglifyText = (text, tags) => {
+  let output = text;
+  for (const [tagName, replacement] of Object.entries(tags)) {
+    const tag = escapeRegExp(tagName.toUpperCase());
+    const blockRegex = new RegExp(`<!-- ${tag}:START -->(.*?)<!-- ${tag}:END -->`, "gis");
+    output = output.replace(blockRegex, (_match, block) => {
+      const lineEnding = block.includes("\r\n") ? "\r\n" : "\n";
+      return `<!-- ${tag}:START -->${lineEnding}${replacement}${lineEnding}<!-- ${tag}:END -->`;
+    });
+  }
+  return {
+    text: output,
+    changed: output !== text
+  };
+};
+var taglifyFile = (filePath, tags) => {
+  let text;
+  try {
+    text = readFileSync(filePath, "utf8");
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      throw new Error(`File not found: ${filePath}`);
+    }
+    throw error;
+  }
+  const result = taglifyText(text, tags);
+  if (result.changed) {
+    writeFileSync(filePath, result.text, "utf8");
+  }
+  return result.changed;
+};
+export {
+  taglifyFile,
+  taglifyText
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "taglify",
+  "version": "1.0.1",
+  "description": "Synchronize generated content inside marker blocks in any text file.",
+  "keywords": [
+    "markers",
+    "codegen",
+    "sync",
+    "readme",
+    "text"
+  ],
+  "type": "module",
+  "private": false,
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "devDependencies": {
+    "@size-limit/file": "^11.0.0",
+    "@trivago/prettier-plugin-sort-imports": "^5.0.0",
+    "@types/bun": "latest",
+    "@types/node": "^22.20.1",
+    "esbuild": "^0.24.0",
+    "prettier": "^3.0.0",
+    "size-limit": "^11.0.0",
+    "typescript": "^5.6.0"
+  },
+  "license": "MIT",
+  "author": "jayF0x",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "rm -rf dist && esbuild src/index.ts --bundle --outfile=dist/index.js --platform=node --format=esm && bun build src/index.ts --outdir dist --entry-naming index.cjs --target node --format cjs && tsc",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "bun test",
+    "test:run": "bun test",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "npm:deploy": "bash ./scripts/publish-npm.sh",
+    "rm:stalepr": "git branch -vv | grep '\\[gone\\]' | awk '{print $1}' | xargs git branch -D",
+    "size": "size-limit",
+    "rkit:pull": "bunx repokit pull",
+    "rkit:push": "bunx repokit push"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jayf0x/taglify.git"
+  },
+  "homepage": "https://github.com/jayf0x/taglify#readme",
+  "bugs": {
+    "url": "https://github.com/jayf0x/taglify/issues"
+  }
+}