generated-signature 0.1.2 → 0.1.3

package/README.md

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generated-signature",
-  "version": "0.1.2",
+  "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": {