Version 4.0.0

.codeclimate.yml

@@ -0,0 +1,83 @@
+version: '2' # required to adjust maintainability checks
+
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 4
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 4
+  file-lines:
+    enabled: true
+    config:
+      threshold: 300
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 5
+  method-count:
+    enabled: true
+    config:
+      threshold: 20
+  method-lines:
+    enabled: true
+    config:
+      threshold: 50
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+  identical-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+
+exclude_patterns:
+  - 'config/'
+  - 'db/'
+  - 'dist/'
+  - 'features/'
+  - '**/node_modules/'
+  - 'script/'
+  - '**/spec/'
+  - '**/test/'
+  - '**/tests/'
+  - '**/spec_tests/'
+  - '**/docs/'
+  - 'Tests/'
+  - '**/vendor/'
+  - '**/*_test.go'
+  - '**/*.d.ts'
+  - '**/*__init__.py'
+  - '**/*setup.py'
+  - '**/setup.cfg'
+  - '**/static/'
+  - '**/constants/'
+  - '**/deploy_hed/'
+  - '**/README*'
+  - '**/.gitignore'
+  - '**/LICENSE'
+  - '**/examples/'
+  - '**/*.yml'
+  - '**/*.yaml'
+  - '**/config_template.py'
+  - '**/*.txt'
+  - '**/*.html'
+  - '**/.coveragerc'
+  - '**/*.md'
+  - '**/*.rst'
+  - '**/templates/'
+  - '**/conf.py'
+  - '**/deprecated/'
+  - '**/versioneer.py'
+  - '**/_version.py'

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
-skip = datasets,.git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn,datasets
-ignore-words-list = covert,hed,recuse,afterAll
+skip = datasets,.git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn,datasets, docs/html/fonts, docs/html/scripts
+ignore-words-list = covert,hed,recuse,afterAll,hertzs,isnt

.github/dependabot.yml

@@ -0,0 +1,21 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    target-branch: 'develop'
+    schedule:
+      interval: 'weekly'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    target-branch: 'develop'
+    schedule:
+      interval: 'weekly'
+    ignore:
+      - dependency-name: 'chai'
+        update-types:
+          - 'version-update:semver-major'
+  - package-ecosystem: 'gitsubmodule'
+    directory: '/'
+    target-branch: 'develop'
+    schedule:
+      interval: 'daily'

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [master]
+    branches: [master, develop]
   pull_request:
-    branches: [master]
+    branches: [master, develop]
 
 jobs:
   Build:
@@ -30,6 +30,29 @@ jobs:
       - name: Test with Node.js ${{ matrix.node-version }}
         run: npm test
 
+  JSON-spec-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 'node']
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+      - name: Set up with Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Print Node.js version and CI environment
+        run: |
+          echo "Node.js version: $(node -v)"
+          echo "Environment: CI=${{ env.CI }}"
+      - name: Download dependencies
+        run: npm ci
+      - name: Run JSON spec tests with Node.js ${{ matrix.node-version }}
+        run: npm run testSpecs
+
   Coverage:
     runs-on: ubuntu-latest
 
@@ -43,8 +66,8 @@ jobs:
       - name: Download dependencies
         run: npm ci
       - name: Test & publish code coverage
-        uses: paambaati/codeclimate-action@v8.0.0
+        uses: paambaati/codeclimate-action@v9.0.0
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         with:
-          coverageCommand: ./node_modules/.bin/jest --coverage --testPathIgnorePatterns=spec_tests
+          coverageCommand: ./node_modules/.bin/jest --coverage

.gitignore

@@ -7,6 +7,7 @@ dist/
 spec_tests/*.txt
 spec_tests/temp*.json
 spec_tests/temp.spec.js
+tests/temp.spec.js
 
 # Unit test / coverage reports
 htmlcov/

.husky/pre-commit

@@ -1,4 +1,3 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx pretty-quick --staged
+npm test
+npm run testSpecs

README.md

@@ -5,43 +5,18 @@
 
 # hed-validator
 
-This package contains a JavaScript validator for HED (hierarchical event descriptor) strings.
+This package contains a JavaScript validator for HED (Hierarchical Event Descriptor) strings.
 
 [HED](https://www.hedtags.org/) is a system for annotating events using comma-separated path strings.
 Any type of event can be annotated using HED-type syntax.
 The HED annotation strategy is very general and a standardized vocabulary in the form of a
 [HED schema](https://github.com/hed-standard/hed-specification) enables
 annotation of events in an understandable, machine-actionable format.
 
-Additional [library schemas](https://github.com/hed-standard/hed-schema-library)
-with specialized vocabularies needed for particular subfields are under development.
-
-HED validation occurs at several levels.
-Syntactic validation checks that HED strings comply with the required syntax,
-but not whether tags comply with the additional requirements of a HED schema.
-
-Semantic validation verifies validity at many levels:
-
-1. **Tag-level validation** checks that tags are in the schema
-   and have correct units and value type.
-2. **String-level validation** performs additional checks for correctness.
-   In this implementation, tag-level and string-level validation occur at the same time.
-3. **Event-level validation** checks that the entire assembled HED annotation for an event is valid.
-   This includes checks for required tags, duplicate tags, top-level tags, top-level tag groups,
-   and unique tags. This usually implies the existence of an events file and an accompanying JSON sidecar
-   so that annotations for different columns of an events file can be assembled into a single string.
-4. **Dataset-level validation** parses out the definitions
-   and checks that the needed definitions are present and not duplications.
-   Dataset-level validation also checks for `Onset`-`Offset` tag consistency.
-
-The current version of `hed-validator` performs both syntactic and semantic validation.
-Because full validation of all the features of HED-3G (versions >= 8.0.0) requires full knowledge
-of an events file and its merged sidecars, the `hed-validator` currently only exposes its interface
-at the dataset level.
 The current focus of the `hed-validator` package is to support full validation of HED in
-[BIDS datasets](https://bids-specification.readthedocs.io/en/stable/).
+[BIDS datasets](https://bids-specification.readthedocs.io/en/stable/) under the BIDS validator 2.0.
 
-HED validation is currently also supported in an [online version of the HED validator](https://hedtools.ucsd.edu/hed),
+HED validation is currently also supported in an [online version of the HED validator](https://hedtools.org/hed),
 which is implemented in Python and developed in a [public GitHub repository](https://github.com/hed-standard/hed-python/).
 Validation and other HED operations are also available through web-services and a docker module.
 
@@ -57,3 +32,8 @@ To use the `hed-validator`, you must install the npm `hed-validator` package and
 
 A sample of current `hed-validator` usage can be found in the BIDS validator in
 [`hed.js`](https://github.com/bids-standard/bids-validator/blob/5dfc3938ea8ce128c7db295e7bebc8eed2de1ce6/bids-validator/validators/hed.js).
+
+## Repository notes:
+
+The `develop` branch is now the default branch. All changes to the repository should
+be done as PRs (pull requests) to the `develop` branch.