Merge pull request #2181 from nellh/type-exports

fix: Export types for typescript library users
bids-standard · Oct 28, 2024 · d1a5bf9 · d1a5bf9
2 parents d2c9fbb + 4b249a9
commit d1a5bf9
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/bids-validator/deno.json b/bids-validator/deno.json
@@ -6,7 +6,8 @@
     "./main": "./src/main.ts",
     "./output": "./src/utils/output.ts",
     "./files": "./src/files/deno.ts",
-    "./options": "./src/setup/options.ts"
+    "./options": "./src/setup/options.ts",
+    "./issues": "./src/issues/datasetIssues.ts"
   },
   "publish": {
     "exclude": [

diff --git a/bids-validator/src/files/deno.ts b/bids-validator/src/files/deno.ts
@@ -7,6 +7,7 @@ import { type BIDSFile, FileTree } from '../types/filetree.ts'
 import { requestReadPermission } from '../setup/requestPermissions.ts'
 import { FileIgnoreRules, readBidsIgnore } from './ignore.ts'
 import { logger } from '../utils/logger.ts'
+export { type BIDSFile, FileTree }
 
 /**
  * Thrown when a text file is decoded as UTF-8 but contains UTF-16 characters

diff --git a/bids-validator/src/issues/datasetIssues.ts b/bids-validator/src/issues/datasetIssues.ts
@@ -1,5 +1,6 @@
 import { nonSchemaIssues } from './list.ts'
-import type { Issue, Severity } from '../types/issues.ts'
+import type { Issue, Severity, IssueDefinition, IssueFile } from '../types/issues.ts'
+export type { Issue, Severity, IssueDefinition, IssueFile }
 
 // Code is deprecated, return something unusual but JSON serializable
 const CODE_DEPRECATED = Number.MIN_SAFE_INTEGER

diff --git a/bids-validator/src/main.ts b/bids-validator/src/main.ts
@@ -8,6 +8,7 @@ import { validate } from './validators/bids.ts'
 import { consoleFormat, resultToJSONStr } from './utils/output.ts'
 import { setupLogging } from './utils/logger.ts'
 import type { ValidationResult } from './types/validation-result.ts'
+export type { ValidationResult } from './types/validation-result.ts'
 
 /**
  * Validation entrypoint intended for command line usage with Deno