files.md

Files parser

Input

The files parser is intended to just list the name and mimetype of the files and subdirectories in a given directory. Unlike other parsers, this one doesn't parse the file content per se, but only list those files so that you can point to them (get back their path or URL relative to your bundle) easily in your code. The parser accepts multiple files or directories, which it will recursively search for files that match the given filter (default .*).

The list of files will be converted into a structured directory tree, where each directory contains a list of the files and directories within that directory. For example the following file tree:

Files/
  test.txt
  a video.mp4
  subfolder/
    more.txt
    files.txt
  folder/
    file.dat

will be parsed into the following structure (not showing the rest of the structure, such as values and types):

[
  "files": [
    "test.txt",
    "a video.mp4"
  ],
  "directories": [
    "subfolder": [
      "files": [
        "more.txt",
        "files.txt"
      ]
    ],
    "folder": [
      "files": [
        "file.dat"
      ]
    ]
  ]
]

Output

The output context has the following structure:

• groups: Array — list of file groups (input folders):
  • name: String — name of the group
  • files: Array<File> — list of files in the base directory specified
  • directories: Array — tree structure of subdirectory and its contents
    • name: String — name of the directory
    • files: Array<File> — list of files in this directory
    • directories: Array — recursive tree of subdirectories

Each File has the following properties:

• name: String — name of the file
• ext: String — file extension
• path: String — the path to the file, relative to the folder being scanned
• mimeType: String — mime type of the file

Example

groups:
- directories:
  - directories:
    - files:
      - ext: "mp4"
        mimeType: "video/mp4"
        name: "another video"
        path: "empty intermediate/subfolder"
      name: "subfolder"
    name: "empty intermediate"
  - directories:
    - files:
      - ext: "svg"
        mimeType: "image/svg+xml"
        name: "graphic"
        path: "subdir/subdir"
      name: "subdir"
    files:
    - ext: "mp4"
      mimeType: "video/mp4"
      name: "A Video With Spaces"
      path: "subdir"
    name: "subdir"
  files:
  - ext: ""
    mimeType: "application/octet-stream"
    name: "File"
    path: ""
  - ext: "txt"
    mimeType: "text/plain"
    name: "test"
    path: ""
  name: "Files"