Add tests, fix some errors

Author: codeit-ninja

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+    push:
+        branches:
+            - '**'
+    pull_request:
+
+jobs:
+    test:
+        name: Test
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v4
+
+            - name: Install pnpm
+              uses: pnpm/action-setup@v3
+              with:
+                  version: 10
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: 'pnpm'
+
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+
+            - name: Lint
+              run: pnpm run lint
+
+            - name: Test
+              run: pnpm run test

.github/workflows/coverage.yml

@@ -35,6 +35,9 @@ jobs:
             - name: Install dependencies
               run: pnpm install --frozen-lockfile
 
+            - name: Test
+              run: pnpm run test
+
             - name: Build project
               run: pnpm run build
 

.github/workflows/publish.yml

@@ -35,7 +35,6 @@
     "devDependencies": {
         "@changesets/cli": "^2.30.0",
         "@eslint/js": "^10.0.1",
-        "@types/lodash-es": "^4.17.12",
         "@types/node": "^25.5.0",
         "@vitest/coverage-v8": "^4.1.2",
         "c8": "^7.14.0",
@@ -50,8 +49,5 @@
         "vitepress": "^1.6.4",
         "vitest": "^4.1.2",
         "vue": "^3.5.31"
-    },
-    "dependencies": {
-        "lodash-es": "^4.17.23"
     }
 }

package.json

@@ -0,0 +1,168 @@
+import { describe, it, expect } from 'vitest';
+import { isHeader, isStyle, isNote, isCue, isRegion, isComment } from './helpers';
+
+describe('isHeader', () => {
+    it('matches bare WEBVTT', () => {
+        expect(isHeader('WEBVTT')).toBe(true);
+    });
+
+    it('matches WEBVTT with a description', () => {
+        expect(isHeader('WEBVTT - English captions')).toBe(true);
+    });
+
+    it('matches WEBVTT with metadata lines below', () => {
+        expect(isHeader('WEBVTT\nKind: captions\nLanguage: en')).toBe(true);
+    });
+
+    it('matches WEBVTT with UTF-8 BOM', () => {
+        expect(isHeader('\uFEFFWEBVTT')).toBe(true);
+    });
+
+    it('matches WEBVTT BOM with description', () => {
+        expect(isHeader('\uFEFFWEBVTT Live captions')).toBe(true);
+    });
+
+    it('does not match an empty string', () => {
+        expect(isHeader('')).toBe(false);
+    });
+
+    it('does not match a cue timing line', () => {
+        expect(isHeader('00:00:01.000 --> 00:00:04.000')).toBe(false);
+    });
+
+    it('does not match lowercase webvtt', () => {
+        expect(isHeader('webvtt')).toBe(false);
+    });
+
+    it('does not match a mid-string WEBVTT occurrence', () => {
+        expect(isHeader('NOTE WEBVTT')).toBe(false);
+    });
+
+    it('does not match WEBVTTx (7th char must be space/tab/LF or end)', () => {
+        expect(isHeader('WEBVTTx rest of content')).toBe(false);
+    });
+
+    it('matches WEBVTT followed by tab', () => {
+        expect(isHeader('WEBVTT\tThis is a description')).toBe(true);
+    });
+
+    it('matches WEBVTT followed by LF', () => {
+        expect(isHeader('WEBVTT\nKind: captions')).toBe(true);
+    });
+});
+
+describe('isStyle', () => {
+    it('matches STYLE', () => {
+        expect(isStyle('STYLE')).toBe(true);
+    });
+
+    it('matches STYLE with content', () => {
+        expect(isStyle('STYLE\n::cue { color: white; }')).toBe(true);
+    });
+
+    it('does not match lowercase style', () => {
+        expect(isStyle('style')).toBe(false);
+    });
+
+    it('does not match other segment types', () => {
+        expect(isStyle('REGION')).toBe(false);
+    });
+});
+
+describe('isNote', () => {
+    it('matches bare NOTE', () => {
+        expect(isNote('NOTE')).toBe(true);
+    });
+
+    it('matches NOTE with inline text', () => {
+        expect(isNote('NOTE This is a comment')).toBe(true);
+    });
+
+    it('matches NOTE with a block body', () => {
+        expect(isNote('NOTE\nThis is a comment')).toBe(true);
+    });
+
+    it('does not match lowercase note', () => {
+        expect(isNote('note')).toBe(false);
+    });
+});
+
+describe('isCue', () => {
+    it('matches a simple cue without identifier', () => {
+        const cue = '00:00:01.000 --> 00:00:04.000\nHello world';
+        expect(isCue(cue)).toBe(true);
+    });
+
+    it('matches a cue with a string identifier', () => {
+        const cue = 'intro\n00:00:00.000 --> 00:00:05.000\nWelcome';
+        expect(isCue(cue)).toBe(true);
+    });
+
+    it('matches a cue with a numeric identifier', () => {
+        const cue = '1\n00:00:01.000 --> 00:00:04.000\nHello';
+        expect(isCue(cue)).toBe(true);
+    });
+
+    it('matches a cue with cue settings on the timing line', () => {
+        const cue = '00:00:01.000 --> 00:00:04.000 align:center size:80%\nHello';
+        expect(isCue(cue)).toBe(true);
+    });
+
+    it('matches short mm:ss.mmm timestamps', () => {
+        const cue = '01:23.456 --> 01:26.789\nShort form';
+        expect(isCue(cue)).toBe(true);
+    });
+
+    it('does not match a WEBVTT header', () => {
+        expect(isCue('WEBVTT')).toBe(false);
+    });
+
+    it('does not match a NOTE block', () => {
+        expect(isCue('NOTE\nA comment')).toBe(false);
+    });
+
+    it('does not match a REGION block', () => {
+        expect(isCue('REGION\nid:fred')).toBe(false);
+    });
+
+    it('does not match a STYLE block', () => {
+        expect(isCue('STYLE\n::cue { color: white; }')).toBe(false);
+    });
+});
+
+describe('isRegion', () => {
+    it('matches bare REGION', () => {
+        expect(isRegion('REGION')).toBe(true);
+    });
+
+    it('matches REGION with settings', () => {
+        expect(isRegion('REGION\nid:fred\nwidth:40%')).toBe(true);
+    });
+
+    it('does not match REGIONS (plural)', () => {
+        expect(isRegion('REGIONS')).toBe(false);
+    });
+
+    it('does not match lowercase region', () => {
+        expect(isRegion('region')).toBe(false);
+    });
+});
+
+describe('isComment', () => {
+    it('matches bare NOTE', () => {
+        expect(isComment('NOTE')).toBe(true);
+    });
+
+    it('matches NOTE with block body', () => {
+        expect(isComment('NOTE\nThis is a comment')).toBe(true);
+    });
+
+    it('does not match NOTE with inline text (uses isNote for that)', () => {
+        // isComment checks ^NOTE(\n|$) so "NOTE text" should NOT match
+        expect(isComment('NOTE This is inline')).toBe(false);
+    });
+
+    it('does not match lowercase note', () => {
+        expect(isComment('note')).toBe(false);
+    });
+});

src/helpers.test.ts

@@ -1,5 +1,5 @@
 export const isHeader = (line: string) => {
-    return /^WEBVTT/.test(line) || /^\uFEFFWEBVTT/.test(line);
+    return /^(?:\uFEFF)?WEBVTT(?:[\t \n]|$)/.test(line);
 };
 
 export const isStyle = (line: string) => {
@@ -11,7 +11,9 @@ export const isNote = (line: string) => {
 };
 
 export const isCue = (str: string) => {
-    return /^(?:[^\n]+\n)?\d{2}:\d{2}:\d{2}\.\d{3}\s+-->\s+\d{2}:\d{2}:\d{2}\.\d{3}/.test(str);
+    return /^(?:[^\n]+\n)?(?:\d+:)?\d{2}:\d{2}\.\d{3}\s+-->\s+(?:\d+:)?\d{2}:\d{2}\.\d{3}/.test(
+        str,
+    );
 };
 
 export const isRegion = (str: string) => {