Merge pull request #1 from limulus/v1-webvtt-feature

Add WebVTT generation from samples

Author: limulus

.github/workflows/cd.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '22' ]
+        node: ['20', '22']
     name: verify using node v${{ matrix.node }}
     steps:
       - uses: actions/checkout@v4
@@ -18,6 +18,7 @@ jobs:
       - run: npm ci
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GPR_READ_TOKEN }}
+      - run: npx playwright install --with-deps --only-shell chromium
       - run: npm run verify
       - uses: actions/upload-artifact@v4
         if: ${{ always() }}

CLAUDE.md

@@ -1,4 +1,15 @@
-# Create Project Helper Guide
+# tcx2webvtt Helper Guide
+
+See `PLAN.md` to learn what the purpose and plan is for this project.
+
+## Software Development Methodology
+
+- Use Test Driven Development:
+  - Write tests first
+  - Ensure new tests fail
+  - Write minimal production code to make tests pass
+  - Consider refactoring production code
+  - Ensure tests continue to pass
 
 ## Commands
 

PLAN.md

@@ -0,0 +1,20 @@
+# tcx2webvtt Todo List
+
+The end goal for this project is for a CLI utility that takes a TCX (Garmin Training Center)
+XML file containing sensor/location data from a workout and generate a WebVTT file with the
+same data as JSON metadata. Optional arguments can be specified (for example, a Final Cut
+Pro XML export) to omit parts of the output and ensure synchronization with an edited video.
+
+## Todos
+
+- [x] Set up vitest browser testing that will enable testing of WebVTT output
+- [] Class to generate WebVTT file from array of `Sample`s
+- [] Parse timecode data from a Final Cut Pro XML export
+- [] Create a class that uses the timecode info from the FCP XML and creates a list of
+  datetime intervals that the video project includes
+- [] Create a function or class that uses the time interval series to filter array of
+  `Sample`s
+- [] Create a CLI Node.js executable that takes the XML files as arguments/options, probably
+  an initial datetime to sync timecode with, and outputs WebVTT.
+- [] Create a JSON schema that WebVTT metadata will conform to, for consumers of WebVTT
+  tracks to validate against and get TS types