@bids/validator@2.0.5

Built and signed on GitHub Actions

Built and signed on GitHub Actions

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
import { FileIgnoreRules } from '../files/ignore.ts'

export interface BIDSFile {
  // Filename
  name: string
  // Dataset relative path for the file
  path: string
  // File size in bytes
  size: number
  // BIDS ignore status of the file
  ignored: boolean
  // ReadableStream to file raw contents
  stream: ReadableStream<Uint8Array>
  // Resolve stream to decoded utf-8 text
  text: () => Promise<string>
  // Read a range of bytes
  readBytes: (size: number, offset?: number) => Promise<Uint8Array<ArrayBuffer>>
  // Access the parent directory
  parent: FileTree
  // File has been viewed
  viewed: boolean
}

/**
 * Abstract FileTree for all environments (Deno, Browser, Python)
 */
export class FileTree {
  // Relative path to this FileTree location
  path: string
  // Name of this directory level
  name: string
  files: BIDSFile[]
  directories: FileTree[]
  viewed: boolean
  parent?: FileTree
  #ignore: FileIgnoreRules

  constructor(path: string, name: string, parent?: FileTree, ignore?: FileIgnoreRules) {
    this.path = path
    this.files = []
    this.directories = []
    this.name = name
    this.parent = parent
    this.viewed = false
    this.#ignore = ignore ?? new FileIgnoreRules([])
  }

  get ignored(): boolean {
    if (!this.parent) return false
    return this.#ignore.test(this.path)
  }

  _get(parts: string[]): BIDSFile | FileTree | undefined {
    if (parts.length === 0) {
      return undefined
    } else if (parts.length === 1) {
      return this.files.find((x) => x.name === parts[0]) ||
        this.directories.find((x) => x.name === parts[0])
    } else {
      const nextDir = this.directories.find((x) => x.name === parts[0])
      return nextDir?._get(parts.slice(1, parts.length))
    }
  }

  get(path: string): BIDSFile | FileTree | undefined {
    if (path.startsWith('/')) {
      path = path.slice(1)
    }
    return this._get(path.split('/'))
  }

  contains(parts: string[]): boolean {
    const value = this._get(parts)
    return value ? (value.viewed = true) : false
  }
}