Add unit tests

.eslintrc.cjs

@@ -4,4 +4,12 @@ module.exports = {
     'no-bitwise': 'off',
     'class-methods-use-this': 'off',
   },
+  overrides: [
+    {
+      files: ['test/**/*.ts'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+      },
+    },
+  ],
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "flac-tagger",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Pure JavaScript FLAC Tag writer and reader.",
   "main": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -17,7 +17,9 @@
     "build": "npm-run-all -p build-esm build-cjs && tsconfig-to-dual-package",
     "type-check": "tsc --noEmit",
     "eslint-check": "eslint . --ext .cjs,.mjs,.ts",
-    "eslint-fix": "eslint . --ext .cjs,.mjs,.ts --fix"
+    "eslint-fix": "eslint . --ext .cjs,.mjs,.ts --fix",
+    "test-watch": "vitest",
+    "test": "vitest run"
   },
   "keywords": [
     "nodejs",
@@ -41,7 +43,8 @@
     "eslint-plugin-vue": "9.10.0",
     "npm-run-all": "^4.1.5",
     "tsconfig-to-dual-package": "^1.2.0",
-    "typescript": "5.0.4"
+    "typescript": "5.0.4",
+    "vitest": "^0.32.2"
   },
   "dependencies": {
     "imageinfo": "^1.0.4"

test/common.ts

@@ -0,0 +1,23 @@
+import { assert } from 'vitest'
+import { readFile } from 'fs/promises'
+import { FlacTags } from '../src/index'
+
+export const coverBuffer = await readFile('./test/cover.jpg')
+export const tags: FlacTags = {
+  tagMap: {
+    title: 'test-title',
+    artist: ['artist 1', 'artist 2'],
+    album: 'test-album',
+    albumSortOrder: 'TEST001',
+  },
+  picture: {
+    buffer: coverBuffer,
+  },
+}
+export const assertTags = (actualTags: FlacTags) => {
+  assert.equal(actualTags.tagMap.title, tags.tagMap.title)
+  assert.deepEqual(actualTags.tagMap.artist, tags.tagMap.artist)
+  assert.equal(actualTags.tagMap.album, tags.tagMap.album)
+  assert.equal(actualTags.tagMap.albumSortOrder, tags.tagMap.albumSortOrder)
+  assert.isTrue(coverBuffer.equals(actualTags.picture?.buffer))
+}

test/read.test.ts

@@ -0,0 +1,15 @@
+import { describe, test } from 'vitest'
+import { readFlacTags, readFlacTagsSync } from '../src/index'
+import { assertTags } from './common'
+
+const readPath = './test/audio-read.flac'
+describe('read FLAC tags', () => {
+  test('read async', async () => {
+    const actualTags = await readFlacTags(readPath)
+    assertTags(actualTags)
+  })
+  test('read sync', () => {
+    const actualTags = readFlacTagsSync(readPath)
+    assertTags(actualTags)
+  })
+})

test/write.test.ts

@@ -0,0 +1,25 @@
+import { describe, test, beforeEach, afterEach } from 'vitest'
+import { copyFile, unlink } from 'fs/promises'
+import { writeFlacTags, readFlacTags, writeFlacTagsSync, readFlacTagsSync } from '../src/index'
+import { assertTags, tags } from './common'
+
+const sourcePath = './test/audio-blank.flac'
+const writePath = './test/audio-write.flac'
+beforeEach(async () => {
+  await copyFile(sourcePath, writePath)
+})
+afterEach(async () => {
+  await unlink(writePath)
+})
+describe('write FLAC tags', () => {
+  test('write async', async () => {
+    await writeFlacTags(tags, writePath)
+    const actualTags = await readFlacTags(writePath)
+    assertTags(actualTags)
+  })
+  test('write sync', () => {
+    writeFlacTagsSync(tags, writePath)
+    const actualTags = readFlacTagsSync(writePath)
+    assertTags(actualTags)
+  })
+})