PT-2358: Generate Markers Map

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  root: true,
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  rules: {
+    'no-null/no-null': 2,
+  },
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'no-null'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  env: {
+    browser: true,
+    node: true,
+  },
+};

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+* @tjcouch-sil @lyonsil
+# not package-lock.json
+/package-lock.json

.github/workflows/generate-markers-map.yml

@@ -0,0 +1,71 @@
+name: Generate Markers Map
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+    inputs:
+      schemaVersion:
+        description: 'Version of `usx.rng` to generate markers map from, e.g. 3.1. For testing, can specify `master` to use latest version from `ubsicap/usx` or `main` to use latest version from `usfm-bible/tcdocs`, but note that the markers map will have this exact string as its version.'
+        required: true
+        default: '3.1'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Apparently GitHub doesn't set the inputs to default if you run from other than manual dispatch, so setting defaults here
+      - name: Make default inputs consistent
+        id: inputs
+        run: |
+          echo "schemaVersion=${{ github.event.inputs.schemaVersion || '3.1' }}" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout usfm-tools
+        uses: actions/checkout@v4
+
+      - name: Clone `ubsicap/usx`, checkout the right branch, and move `usx.rng` to root
+        if: ${{ steps.inputs.outputs.schemaVersion == 'master' || steps.inputs.outputs.schemaVersion < '3.1' }}
+        run: |
+          git clone https://github.com/ubsicap/usx.git ../usx
+          cd ../usx
+          if [ "${{ steps.inputs.outputs.schemaVersion }}" != "master" ]; then
+            git checkout "usx${{ steps.inputs.outputs.schemaVersion }}"
+          fi
+          mv schema/usx.rng ../usfm-tools/usx.rng
+          echo "USX_REPO=https://github.com/ubsicap/usx.git" >> "$GITHUB_ENV"
+          echo "USX_COMMIT=$(git rev-parse HEAD)" >> "$GITHUB_ENV"
+
+      - name: Clone `usfm-bible/tcdocs` and checkout the right branch, and move `usx.rng` to root
+        if: ${{ steps.inputs.outputs.schemaVersion != 'master' && steps.inputs.outputs.schemaVersion >= '3.1' }}
+        run: |
+          git clone https://github.com/usfm-bible/tcdocs.git ../tcdocs
+          cd ../tcdocs
+          if [ "${{ steps.inputs.outputs.schemaVersion }}" != "main" ]; then
+            git checkout "${{ steps.inputs.outputs.schemaVersion }}"
+          fi
+          mv grammar/usx.rng ../usfm-tools/usx.rng
+          echo "USX_REPO=https://github.com/usfm-bible/tcdocs.git" >> "$GITHUB_ENV"
+          echo "USX_COMMIT=$(git rev-parse HEAD)" >> "$GITHUB_ENV"
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate markers map
+        run: npm run generate-markers-map -- --schema usx.rng --version "${{ steps.inputs.outputs.schemaVersion }}" --repo "${{ env.USX_REPO }}" --commit "${{ env.USX_COMMIT }}"
+
+      - name: Upload Markers Map
+        uses: actions/upload-artifact@v4
+        with:
+          name: markers-map
+          path: |
+            dist/*
+          retention-days: 90

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    # The branches below should be a subset of the branches above
+    branches: ['main']
+
+jobs:
+  test:
+    name: Build on ${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Install packages
+        run: npm ci
+
+      - name: npm unit tests
+        run: npm test
+
+      - name: check JS/TS linting
+        run: npm run lint

.gitignore

@@ -137,3 +137,6 @@ dist
 # Vite logs files
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+
+# Local copies of files from other repositories
+usx.rng

.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+
+# generated files
+package-lock.json
+src/test-data
+src/markers-3.1.json

.prettierrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  printWidth: 100,
+  tabWidth: 2,
+  singleQuote: true,
+  trailingComma: 'es5',
+  bracketSpacing: true,
+  bracketSameLine: false,
+  arrowParens: 'avoid',
+  proseWrap: 'preserve',
+  // prettier-plugin-jsdoc options
+  tsdoc: true,
+  plugins: ['prettier-plugin-jsdoc'],
+  overrides: [
+    {
+      files: '*.sql',
+      options: {
+        parser: 'sql',
+        language: 'sqlite',
+        keywordCase: 'upper',
+        linesBetweenQueries: 1,
+      },
+    },
+  ],
+};

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Paranext
+Copyright (c) 2025 SIL Global and United Bible Societies.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal