@wrote/read-dir-structure/types/index.xml

Reads directory structure.

<types namespace="_wrote">
  <import from="fs" name="Stats" />
  <type name="File">
    <prop name="lstat" type="!fs.Stats">The stats of the item.</prop>
    <prop string name="path">The full path of the item.</prop>
    <prop string name="relativePath">The name of the item.</prop>
  </type>

  <type name="ReadDirStructureOpts" desc="Options for reading the dir structure." noToc>
    <prop type="!Array<string>" name="ignore" opt>
      The list of paths inside of the directory to ignore, e.g., `[.git]`.
    </prop>
  </type>

  <type type="Object<string, !_wrote.DirectoryStructure>" name="Content" desc="The recursive content of the directory." noToc/>

  <type name="DirectoryStructure" desc="A directory structure representation." noToc>
    <prop opt name="type" type="string">
      The type of the item.
    </prop>
    <prop opt name="content" type="!_wrote.Content">
      The recursive content if the item is a directory.
    </prop>
  </type>
</types>