Merge pull request #555 from VisLab/test_update

Updated tests to correspond to new error messages

Author: VisLab

src/bids/datasetParser.js

@@ -7,7 +7,7 @@
  * Note: An implementation of the BidsFileAccessor class for web folder access is not included in the
  * hed-javascript Node distribution, but is included in the hed-javascript GitHub repository in the browser folder.
  *
- * @module datasetParser
+ * @module bids/datasetParser
  */
 
 import fsp from 'node:fs/promises'

src/bids/schema.js

@@ -1,12 +1,10 @@
 /**
  * This module contains functions for building HED schemas for BIDS datasets.
- * @module schema
+ * @module bids/schema
  */
 
 import { buildSchemas } from '../schema/init'
-import { IssueError } from '../issues/issues'
 import { SchemasSpec } from '../schema/specs'
-import { BidsJsonFile } from './types/json'
 
 /**
  * Build a HED schema collection based on the defined BIDS schemas.

src/bids/tsvParser.js

@@ -1,7 +1,7 @@
 /**
  * This module provides functions for parsing TSV files.
  *
- * @module tsvParser
+ * @module bids/tsvParser
  */
 
 const stripBOM = (str) => str.replace(/^\uFEFF/, '')

src/bids/types/dataset.js

@@ -1,6 +1,6 @@
 /**
  * This module contains the {@link BidsDataset} class, which represents a BIDS dataset for HED validation.
- * @module dataset
+ * @module bids/types/dataset
  */
 import { BidsFileAccessor } from '../datasetParser'
 import { BidsSidecar } from './json'

src/bids/types/file.js

@@ -1,7 +1,7 @@
 /**
  * This module contains the {@link BidsFile} class, which is the base class for BIDS files.
  *
- * @module file
+ * @module bids/types/file
  */
 
 import { BidsHedIssue } from './issues'

src/bids/types/issues.js

@@ -1,6 +1,6 @@
 /**
  * Provides a wrapper for HED validation issues that is compatible with the BIDS validator.
- * @module issues
+ * @module bids/types/issues
  */
 import { generateIssue, IssueError } from '../../issues/issues.js'
 
@@ -140,7 +140,7 @@ export class BidsHedIssue {
 
       const numErrors = issueList.length
       const numFiles = new Set(issueList.map((issue) => issue.location)).size
-      newIssue.issueMessage += ` There are ${numErrors} total errors of this type in ${numFiles} unique files.`
+      newIssue.issueMessage += ` There are ${numErrors} total issues of this type in ${numFiles} unique files.`
 
       reducedIssues.push(newIssue)
     }

src/bids/types/json.js

@@ -1,7 +1,7 @@
 /**
  * This module contains classes for representing BIDS JSON files, including {@link BidsJsonFile} and {@link BidsSidecar}.
  *
- * @module json
+ * @module bids/types/json
  */
 import isPlainObject from 'lodash/isPlainObject'
 

src/bids/types/tsv.js

@@ -1,7 +1,7 @@
 /**
  * This module contains classes for representing BIDS TSV files and their components.
  *
- * @module tsv
+ * @module bids/types/tsv
  */
 import isPlainObject from 'lodash/isPlainObject'
 

src/bids/validator/sidecarValidator.js

@@ -1,3 +1,7 @@
+/** This module holds the sidecar validator class.
+ * @module bids/validator/sidecarValidator
+ */
+
 import { BidsHedIssue } from '../types/issues'
 import ParsedHedString from '../../parser/parsedHedString'
 import { generateIssue, IssueError, updateIssueParameters } from '../../issues/issues'

src/bids/validator/tsvValidator.js

@@ -1,3 +1,6 @@
+/** This module holds the tsv validator class.
+ * @module bids/validator/tsvValidator
+ */
 import { BidsHedIssue } from '../types/issues'
 import { BidsTsvElement, BidsTsvRow } from '../types/tsv'
 import { BidsValidator } from './validator'