feat: add cli option "prefix"

Author: andreas-timm

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## [0.3.0] - 2024-06-13
+
+### Added
+- Cli option "prefix" for the commented line prefix.
+
+## [0.2.0] - 2024-05-15
+
+### Added
+- Initial import
+ 

README.md

@@ -30,9 +30,6 @@ This version maintains the clarity and objectives of your original text while sl
 ## Compatibility
 This tool has been developed and tested exclusively on **macOS**. It is not guaranteed to work on other operating systems.
 
-## Limitations
-Only comments of the double slash "`//`" type can be used at this time.
-
 ## Install
 ```shell
 git clone --depth=1 https://github.com/andreas-timm/code-signature-ts.git ~/.local/share/code-signature-ts
@@ -48,6 +45,20 @@ ln -s ~/.local/share/code-signature-ts/src/code-signature.ts ~/.local/bin/code-s
 ```
 
 ## Usage
+### Help
+```shell
+$ code-signature -h
+Usage: code-signature-ts [OPTIONS] <FILE|->
+OPTIONS:
+  --verify, -v — only verify
+  --write, -f — write file
+  --silent, -s — silent
+  --prefix, -p — commented line prefix
+  --out, -o — output file
+ENVIRONMENT:
+  MNEMONIC — mnemonic
+```
+
 ### Check
 ```shell
 code-signature -v src/code-signature.ts
@@ -60,7 +71,6 @@ MNEMONIC=$(pass show mnemonic) code-signature --write code-file.ts
 ```
 
 ## Roadmap
-
 - [ ] Add a demonstration static (SSG) frontend.
 
 ## License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-signature-ts",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "module": "src/code-signature.ts",
   "devDependencies": {
     "@types/bun": "^1.1.2",

src/code-signature.ts

@@ -4,14 +4,14 @@
 // To view a copy of this license, visit https://creativecommons.org/licenses/by/4.0/
 // Author: Andreas Timm
 // Repository: https://github.com/andreas-timm/code-signature-ts
-// Version: 0.2.0
-// @sha256sum 0xdaea6ea29e60619ef1050287fb380a9edc234c8d18e01103a5fb8027694f91f4
-// @eip191signature 0x96958f5875095d4b2967e37dda0b4a696611e2c2fb543ae30be41056f94b97f31d40970caf2ceeec179b2cfe23a7e37a1ef44a817113dc3a368f9296adab93531c
+// Version: 0.3.0
+// @sha256sum 0x904d8038d8a3ae6144e5b4275c5f5c76b3d28bddf574ada8cc394fb091a3e2c5
+// @eip191signature 0x6b55e4c5241cf7824a70f3f971b16be497ad5e2d808daca00280c975a5604a396a2fdfcf5d30d6f7c15c84a4f5a44d813311d7231acc7b2041a1aa20574e8c851b
 
 import { parseArgs } from 'util'
 import { hashMessage, recoverAddress, sha256 } from 'viem'
 import { english, generateMnemonic, mnemonicToAccount } from 'viem/accounts'
-import type { Options, SignResult, VerifyResult } from './types.ts'
+import type { Options, SignResult, VerifyResult, CliOptions } from './types.ts'
 
 export function splitIndexLines(content: string) {
     return content.split(/(\n+)/).reduce((acc: string[][], part: string, index: number) => {
@@ -24,14 +24,14 @@ export function splitIndexLines(content: string) {
     }, [])
 }
 
-export function getFilteredContent(content: string, key: string, replace?: string) {
+export function getFilteredContent(content: string, key: string, prefix: string, replace?: string) {
     const lines = splitIndexLines(content)
     let filtered = []
     let value: null | `0x${string}` = null
     let index
 
     for (index = 0; index < lines.length; index++) {
-        if (lines[index][0].match(new RegExp('^\\s*([*#;"]|//)?\\s*' + key))) {
+        if (lines[index][0].match(new RegExp(`^\\s*([*#;"]|${prefix})?\\s*` + key))) {
             value = lines[index][0].match(new RegExp(`${key}\\s+(\\S+)`))![1] as `0x${string}`
             if (replace !== undefined) {
                 filtered.push(
@@ -51,9 +51,9 @@ export function getFilteredContent(content: string, key: string, replace?: strin
     return { content: filtered.join(''), value }
 }
 
-export async function verify(content: string): Promise<VerifyResult> {
-    const sha256Filtered = getFilteredContent(content, '@sha256sum')
-    const signFiltered = getFilteredContent(sha256Filtered.content, '@eip191signature')
+export async function verify(content: string, prefix: string): Promise<VerifyResult> {
+    const sha256Filtered = getFilteredContent(content, '@sha256sum', prefix)
+    const signFiltered = getFilteredContent(sha256Filtered.content, '@eip191signature', prefix)
     const sha256sum = sha256(new TextEncoder().encode(sha256Filtered.content))
 
     const address =
@@ -97,19 +97,19 @@ export async function sign(verifyResult: VerifyResult, options: Options): Promis
         signature = await account.signMessage({ message: verifyResult.signFiltered.content })
 
         if (verifyResult.signFiltered.value !== null) {
-            toSha256Content = getFilteredContent(verifyResult.content, '@eip191signature', signature).content
+            toSha256Content = getFilteredContent(verifyResult.content, '@eip191signature', options.prefix, signature).content
         } else {
-            toSha256Content = ['// @eip191signature ' + signature, verifyResult.content].join('\n')
+            toSha256Content = [`${options.prefix} @eip191signature ` + signature, verifyResult.content].join('\n')
         }
 
         sha256sum = sha256(
-            new TextEncoder().encode(getFilteredContent(toSha256Content, '@sha256sum').content),
+            new TextEncoder().encode(getFilteredContent(toSha256Content, '@sha256sum', options.prefix).content),
         )
 
         if (verifyResult.sha256Filtered.value !== null) {
-            signedContent = getFilteredContent(toSha256Content, '@sha256sum', sha256sum).content
+            signedContent = getFilteredContent(toSha256Content, '@sha256sum', options.prefix, sha256sum).content
         } else {
-            signedContent = ['// @sha256sum ' + sha256sum, toSha256Content].join('\n')
+            signedContent = [`${options.prefix} @sha256sum ` + sha256sum, toSha256Content].join('\n')
         }
     }
 
@@ -128,6 +128,7 @@ function printHelp() {
     console.log('  --verify, -v — only verify')
     console.log('  --write, -f — write file')
     console.log('  --silent, -s — silent')
+    console.log('  --prefix, -p — commented line prefix')
     console.log('  --out, -o — output file')
     console.log('ENVIRONMENT:')
     console.log('  MNEMONIC — mnemonic')
@@ -156,7 +157,7 @@ export async function codeSignature(options: Options) {
         content = await Bun.file(options.filePath).text()
     }
 
-    const verifyResult = await verify(content)
+    const verifyResult = await verify(content, options.prefix)
     let signResult: null | SignResult = null
     let fail = false
 
@@ -173,8 +174,8 @@ export async function codeSignature(options: Options) {
         } else if (options.write) {
             await write(options, signResult.signedContent)
         } else if (!options.silent) {
-            console.log(`// @sha256sum ${signResult.sha256sum}`)
-            console.log(`// @eip191signature ${signResult.signature}`)
+            console.log(`${options.prefix} @sha256sum ${signResult.sha256sum}`)
+            console.log(`${options.prefix} @eip191signature ${signResult.signature}`)
         }
     } else {
         if (!options.silent) {
@@ -187,18 +188,20 @@ export async function codeSignature(options: Options) {
 }
 
 if (import.meta.main) {
-    const { values, positionals } = parseArgs({
+    const {values, positionals} = parseArgs({
         args: Bun.argv,
         options: {
             help: { type: 'boolean', short: 'h' },
             write: { type: 'boolean', short: 'w' },
             verify: { type: 'boolean', short: 'v' },
             silent: { type: 'boolean', short: 's' },
+            prefix: { type: 'string', short: 'p', default: '//' },
             out: { type: 'string', short: 'o' },
         },
         strict: true,
         allowPositionals: true,
     })
+    const cliOptions: CliOptions = values as CliOptions
 
     if (values.help) {
         printHelp()
@@ -212,7 +215,7 @@ if (import.meta.main) {
 
     const mnemonic = process.env.MNEMONIC
 
-    const res = await codeSignature({ filePath: positionals[2], ...values, mnemonic })
+    const res = await codeSignature({ filePath: positionals[2], ...cliOptions, mnemonic })
 
     if (res.fail) {
         process.exit(1)

src/types.ts

@@ -1,11 +1,16 @@
 import type { Address } from 'viem'
 
-export type Options = {
+export type CliOptions = {
+    help?: boolean,
+    write?: boolean,
+    verify?: boolean,
+    silent?: boolean,
+    prefix: string,
+    out?: string,
+}
+
+export type Options = CliOptions & {
     filePath: string
-    verify?: boolean
-    write?: boolean
-    silent?: boolean
-    out?: string
     mnemonic?: string
 }
 

test/code-signature.test.ts

@@ -15,18 +15,18 @@ test('main', async () => {
 
     const tmpFileObj = tmp.fileSync()
 
-    await codeSignature({ filePath, write: true, mnemonic, out: tmpFileObj.name, silent: true })
+    await codeSignature({ filePath, write: true, mnemonic, out: tmpFileObj.name, prefix: '//', silent: true })
     const signedContent = await Bun.file(tmpFileObj.name).text()
 
+    expect(signedContent).toContain(`// @sha256sum 0x786045f7ccc832aa68563116823b53c9d4a0d2755b06badd38c9b41f7accb694`)
     expect(signedContent).toContain(
-        `// @sha256sum 0x786045f7ccc832aa68563116823b53c9d4a0d2755b06badd38c9b41f7accb694`,
+        [
+            '// @sha256sum 0x786045f7ccc832aa68563116823b53c9d4a0d2755b06badd38c9b41f7accb694',
+            '// @eip191signature 0xde9fec4e5fd25321eafc169b0c3e80d28e98adbbbfcfc4339a6995b90174ad197912f0552867f8d562c6c33b42eaac525c05acc1cd21161206d4734f1ac3f6821b',
+        ].join('\n'),
     )
-    expect(signedContent).toContain([
-        '// @sha256sum 0x786045f7ccc832aa68563116823b53c9d4a0d2755b06badd38c9b41f7accb694',
-        '// @eip191signature 0xde9fec4e5fd25321eafc169b0c3e80d28e98adbbbfcfc4339a6995b90174ad197912f0552867f8d562c6c33b42eaac525c05acc1cd21161206d4734f1ac3f6821b',
-    ].join('\n'))
 
-    const { verifyResult } = await codeSignature({ filePath: tmpFileObj.name, verify: true })
+    const { verifyResult } = await codeSignature({ filePath: tmpFileObj.name, prefix: '//', verify: true })
     expect(verifyResult.address).toEqual(account.address)
 
     unlinkSync(tmpFileObj.name)