feat: provide parse/format customization

README.md

@@ -27,7 +27,9 @@ const tower = createTower({
   branch:         'tagtower',     // Branch for storing tags. Defaults to 'tagtower'
   temp:           './temp',       // Dir to hold temporary git channels. Defaults to fs.mkdtemp(path.join(os.tmpdir(), 'tempy-tagtower-'))
   committerName:  'Foo Bar',      // Username and email to sign annotaged git tags
-  committerEmail: '[email protected]'   // Defaults to Semrel Extra Bot <[email protected]>
+  committerEmail: '[email protected]',  // Defaults to Semrel Extra Bot <[email protected]>
+  format:         v => v + '',    // Opt value formatter. Defaults to JSON.stringify
+  parse:          v => v          // Opt parser. Defaults to JSON.parse
 })
 
 const id: string = 'some@tag'

src/main/ts/index.ts

@@ -3,12 +3,14 @@ import {TTagEntry, TTower, TTowerFactory, TTowerOpts} from './interface'
 
 export const createTower: TTowerFactory = (opts: TTowerOpts): TTower => ({
   async create(tag, data){
-    await pushTags({...opts, tags: [{tag, body: JSON.stringify(data)}]})
+    const formatter = opts.format || format
+    await pushTags({...opts, tags: [{tag, body: formatter(data)}]})
   },
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   async read(id?: string) {
-    const entries: TTagEntry[] = (await readTags(opts)).map(({tag: id, body}) => ({id, data: jsonParse(body)}))
+    const parser = opts.parse || parse
+    const entries: TTagEntry[] = (await readTags(opts)).map(({tag: id, body}) => ({id, data: parser(body)}))
     if (id === undefined) {
       return entries
     }
@@ -24,7 +26,8 @@ export const createTower: TTowerFactory = (opts: TTowerOpts): TTower => ({
   }
 })
 
-const jsonParse = (value: any): TTagEntry['data'] => {
+const format = JSON.stringify
+const parse = (value: any): TTagEntry['data'] => {
   try {
     return JSON.parse(value.trim())
   } catch {

src/main/ts/interface.ts

@@ -1,7 +1,7 @@
 
 export type TTagEntry = {
   id: string,
-  data: Record<string, any>
+  data: any
 }
 
 export type TTower = {
@@ -20,6 +20,8 @@ export type TTowerOpts = {
   temp?: string
   committerName?: string
   committerEmail?: string
+  parse?: (v: string) => any
+  format?: (v: any) => string
 }
 
 export type TAnnotatedTag = {

src/test/ts/index.test.ts

@@ -40,4 +40,21 @@ describe('tagTower', () => {
     await tower.delete(id)
     assert.equal(await tower.read(id), null)
   })
+
+  it('supports custom parse/format', async () => {
+    const cwd = path.resolve(temp, 'custom-format')
+    await fs.mkdir(cwd, { recursive: true })
+    await exec('git', ['init', '--bare'], {cwd})
+
+    const tower = createTower({
+      url: cwd,
+      branch: 'test-tag-tower',
+      temp,
+      format(v) { return `--${v}--`},
+      parse(v) { return `++${v.trim().slice(2, -2)}++` }
+    })
+
+    await tower.create('foo', 'bar')
+    assert.equal((await tower.read('foo'))?.data, '++bar++')
+  })
 })