generated-signature 0.1.1 → 0.1.3

package/README.md

@@ -8,7 +8,7 @@ Sign generated files so hand edits are detected, while keeping manual sections e
 
 </div>
 
-Guides and the full reference are on the [docs site](https://jacobley.github.io/leyman/generated-signature/).
+Guides and the full reference are on the [docs site](https://jacobley.github.io/leyman/packages/generated-signature/).
 
 - **Offline check**: `verify()` needs only the file, not the generator, so it is cheap enough for a lint rule or a pre-commit hook.
 - **Manual sections**: mark regions a person may edit. Their content is left out of the signature and carried over when the file is regenerated.
@@ -186,7 +186,15 @@ Carries manual sections from an existing file into freshly generated text, match
 
 ### `commentStyle(filePath)`
 
-**Returns** the line comment syntax for a file, as `CommentStyle` (`{ start: string, end?: string }`), looked up by extension or file name (`Dockerfile`, `.gitignore`, …). `null` if unknown, or for formats without comments like `.json`.
+**Returns** the line comment syntax for a file, as `CommentStyle` (`{ start: string, end?: string }`), looked up by extension or file name (`Dockerfile`, `.gitignore`, …). `null` if unknown, or for formats without comments like `.json`. For any other file, pass `comment` instead of `filePath`.
+
+| `CommentStyle` | Files |
+|----------------|-------|
+| `//` | `.c`, `.cc`, `.cjs`, `.cpp`, `.cs`, `.cts`, `.go`, `.h`, `.hpp`, `.java`, `.js`, `.json5`, `.jsonc`, `.jsx`, `.kt`, `.less`, `.mjs`, `.mts`, `.rs`, `.scss`, `.swift`, `.ts`, `.tsx` |
+| `#` | `.bash`, `.cfg`, `.conf`, `.env`, `.ini`, `.pl`, `.properties`, `.py`, `.r`, `.rb`, `.sh`, `.toml`, `.yaml`, `.yml`, `.zsh`, and `.gitattributes`, `.gitignore`, `.npmignore`, `Dockerfile`, `Makefile` |
+| `/* */` | `.css` |
+| `<!-- -->` | `.htm`, `.html`, `.md`, `.mdx`, `.svg`, `.vue`, `.xml` |
+| `--` | `.hs`, `.lua`, `.sql` |
 
 ---
 
@@ -211,7 +219,7 @@ A JSON file recording generated files that don't carry their own token, e.g. JSO
 | Function | Description |
 |----------|-------------|
 | <a id="contenthashcontent"></a>`contentHash(content: string \| Uint8Array): string` | `v1:` and 32 hex characters of SHA-256. `\r\n` counts as `\n`, also in bytes. Manual sections are **not** excluded, so a file with manual sections should be signed inline. |
-| `verifyManifestEntry(content, entry): VerifyResult` | `valid` or `invalid` for a `hash` entry; [`verify()`](#verifytext)'s result for an `inline` entry. |
+| `verifyManifestEntry(content: string \| Uint8Array, entry): VerifyResult` | `valid` or `invalid` for a `hash` entry; [`verify()`](#verifytext)'s result for an `inline` entry. |
 | `parseManifest(text): Manifest` | Parses and validates. Throws `GeneratedSignatureManifestError` if the text is not a valid manifest. |
 | `serializeManifest(files): string` | Manifest text, with paths and inputs sorted so the output doesn't depend on write order. |
 
@@ -239,11 +247,11 @@ import generatedSignature from 'generated-signature/eslint';
 export default [generatedSignature.configs.recommended];
 ```
 
-`configs.recommended` registers the plugin (namespace `generated-signature`) and turns on every rule below as an error.
+`configs.recommended` registers the plugin (namespace `generated-signature`) and turns on every rule below as an error. `eslint` is an optional peer dependency (`^10.13.0`), needed only for this entry point. To choose rules yourself, register the plugin: `{ plugins: { 'generated-signature': generatedSignature }, rules: { 'generated-signature/valid': 'warn' } }`.
 
 ### `generated-signature/valid`
 
-Reports a file whose signature doesn't match (it was edited outside its manual sections), or whose token or manual sections are malformed. Unsigned files are ignored. There is no autofix: re-signing would just approve the edit. Regenerate the file instead, or move the change into a manual section.
+Reports a file whose signature doesn't match (it was edited outside its manual sections; reported on the token), or whose token or manual sections are malformed (`Generated file is malformed: <reason>`, reported on the line at fault). Unsigned files are ignored. There is no autofix: re-signing would just approve the edit. Regenerate the file instead, or move the change into a manual section.
 
 ```ts
 // @generated-signature v1:… Generated file. Do not edit outside of manual sections.

package/dist/eslint/rules/valid.js

@@ -4,7 +4,7 @@ export const valid = {
         type: 'problem',
         docs: {
             description: 'Disallow editing generated files outside of their manual sections',
-            url: 'https://jacobley.github.io/leyman/generated-signature/guides/eslint#generated-signature-valid'
+            url: 'https://jacobley.github.io/leyman/packages/generated-signature/guides/eslint#generated-signature-valid'
         },
         messages: {
             invalid: 'Generated file was edited outside of its manual sections. Regenerate it instead.',

package/dist/lib/manifest.js

@@ -59,14 +59,16 @@ export const parseManifest = (text)=>{
     if (typeof files !== 'object' || files === null || Array.isArray(files)) {
         throw new GeneratedSignatureManifestError('files is not an object');
     }
+    const entries = {};
     for (const [path, entry] of Object.entries(files)){
         if (!isEntry(entry)) {
             throw new GeneratedSignatureManifestError(`invalid entry for ${path}`);
         }
+        entries[path] = entry;
     }
     return {
         version,
-        files: files
+        files: entries
     };
 };
 const sortKeys = (record)=>Object.fromEntries(Object.entries(record).toSorted(([a], [b])=>a < b ? -1 : 1));

package/dist/lib/merge.d.ts

@@ -1,5 +1,8 @@
 import type { CommentOptions } from './comment-style.js';
 import type { ManualSection } from './sections.js';
+/**
+ * @import { GeneratedSignatureMalformedError } from './errors.js'
+ */
 /**
  * Find the manual sections in a file.
  *

package/dist/lib/merge.js

@@ -24,7 +24,7 @@ export const manualSection = ({ id, body = '', indent = '', ...options })=>{
         throw new GeneratedSignatureSectionIdError(id);
     }
     const style = resolveCommentStyle(options);
-    const lines = body === '' ? [] : body.replace(/\n$/u, '').split('\n');
+    const lines = body === '' ? [] : body.replace(/\n$/v, '').split('\n');
     return [
         renderComment(style, `@manual-start ${id}`),
         ...lines,

package/dist/lib/sections.js

@@ -1,6 +1,6 @@
 import { GeneratedSignatureMalformedError } from './errors.js';
-const markerPattern = /(?:^|\s)@manual-(?<kind>start|end)\b(?:\s+(?<id>\S+))?/u;
-const idPattern = /^[\w.-]+$/u;
+const markerPattern = /(?:^|\s)@manual-(?<kind>end|start)\b(?:\s+(?<id>\S+))?/v;
+const idPattern = /^[\w\-.]+$/v;
 export const isValidSectionId = (id)=>idPattern.test(id);
 export const scanSections = (text)=>{
     const sections = [];

package/dist/lib/signature.js

@@ -6,10 +6,11 @@ const VERSION = '1';
 const HASH_LENGTH = 32;
 const PLACEHOLDER = '0'.repeat(HASH_LENGTH);
 const TOKEN_NAME = '@generated-signature';
-const tokenPattern = new RegExp(String.raw`${TOKEN_NAME} v(?<version>\d+):(?<hash>[\da-f]{${HASH_LENGTH}})`, 'gu');
+const tokenPattern = new RegExp(String.raw`${TOKEN_NAME} v(?<version>\d+):(?<hash>[\da-f]{${HASH_LENGTH}})`, 'gv');
 const DEFAULT_MESSAGE = 'Generated file. Do not edit outside of manual sections.';
+const renderToken = (hash)=>`${TOKEN_NAME} v${VERSION}:${hash}`;
 const lineOf = (text, offset)=>text.slice(0, offset).split('\n').length;
-const findToken = (text)=>{
+const findHash = (text)=>{
     const [first, second] = text.matchAll(tokenPattern);
     if (!first) {
         return null;
@@ -29,20 +30,14 @@ const findToken = (text)=>{
             detail: `v${version} is not supported, expected v${VERSION}`
         });
     }
-    return {
-        hash,
-        hashStart: first.index + first[0].length - HASH_LENGTH
-    };
+    return hash;
 };
-const replaceHash = (text, token, hash)=>text.slice(0, token.hashStart) + hash + text.slice(token.hashStart + HASH_LENGTH);
 const computeHash = (text)=>{
-    const normalized = text.replaceAll('\r\n', '\n');
-    const token = findToken(normalized);
-    const withPlaceholder = replaceHash(normalized, token, PLACEHOLDER);
+    const withPlaceholder = text.replaceAll('\r\n', '\n').replaceAll(tokenPattern, ()=>renderToken(PLACEHOLDER));
     const hashable = replaceBodies(withPlaceholder, scanSections(withPlaceholder), ()=>'');
     return createHash('sha256').update(hashable).digest('hex').slice(0, HASH_LENGTH);
 };
-export const signatureToken = ()=>`${TOKEN_NAME} v${VERSION}:${PLACEHOLDER}`;
+export const signatureToken = ()=>renderToken(PLACEHOLDER);
 const insertHeader = (text, options)=>{
     const style = resolveCommentStyle(options);
     const lineBreak = text.includes('\r\n') ? '\r\n' : '\n';
@@ -51,7 +46,7 @@ const insertHeader = (text, options)=>{
         const firstLineEnd = text.indexOf('\n');
         return firstLineEnd === -1 ? text + lineBreak + header : text.slice(0, firstLineEnd + 1) + header + text.slice(firstLineEnd + 1);
     }
-    const frontMatter = style.start === '<!--' ? /^---\r?\n(?:[^\n]*\n)*?---\r?(?:\n|$)/u.exec(text) : null;
+    const frontMatter = style.start === '<!--' ? /^---\r?\n(?:[^\n]*\n)*?---\r?(?:\n|$)/v.exec(text) : null;
     if (frontMatter) {
         const [fenced] = frontMatter;
         return fenced.endsWith('\n') ? fenced + header + text.slice(fenced.length) : fenced + lineBreak + header;
@@ -60,24 +55,25 @@ const insertHeader = (text, options)=>{
 };
 export const sign = (text, options)=>{
     let withToken = text;
-    if (findToken(text) === null) {
+    if (findHash(text) === null) {
         if (!options) {
             throw new TypeError('Text has no signature token, provide `comment` or `filePath`');
         }
         withToken = insertHeader(text, options);
     }
-    return replaceHash(withToken, findToken(withToken), computeHash(withToken));
+    const hash = computeHash(withToken);
+    return withToken.replaceAll(tokenPattern, ()=>renderToken(hash));
 };
 export const verify = (text)=>{
     try {
-        const token = findToken(text.replaceAll('\r\n', '\n'));
-        if (token === null) {
+        const hash = findHash(text.replaceAll('\r\n', '\n'));
+        if (hash === null) {
             return {
                 status: 'unsigned'
             };
         }
         return {
-            status: computeHash(text) === token.hash ? 'valid' : 'invalid'
+            status: computeHash(text) === hash ? 'valid' : 'invalid'
         };
     } catch (err) {
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generated-signature",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Sign generated files so hand edits are detected, while keeping manual sections editable",
   "engines": {
     "node": ">=24"
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/JacobLey/leyman.git",
     "directory": "tools/generated-signature/generated-signature"
   },
-  "homepage": "https://github.com/JacobLey/leyman/tree/main/tools/generated-signature/generated-signature#readme",
+  "homepage": "https://jacobley.github.io/leyman/packages/generated-signature/",
   "bugs": {
     "url": "https://github.com/JacobLey/leyman/issues"
   },
@@ -36,7 +36,7 @@
     "!dist/tsconfig.tsbuildinfo"
   ],
   "peerDependencies": {
-    "eslint": "^10.12.0"
+    "eslint": "^10.13.0"
   },
   "peerDependenciesMeta": {
     "eslint": {
@@ -48,15 +48,15 @@
     "@leyman/eslint-config": "^0.0.1",
     "@leyman/expect": "^0.0.1",
     "@swc/cli": "^0.8.1",
-    "@swc/core": "^1.16.2",
+    "@swc/core": "^1.16.18",
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.19.0",
     "@typescript/native": "npm:typescript@^7.0.2",
     "c8": "^12.0.0",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "expect-type": "^1.4.0",
-    "mocha": "^12.0.2",
-    "mocha-chain": "^1.0.1",
+    "mocha": "^12.0.3",
+    "mocha-chain": "^1.0.2",
     "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "imports": {