Skip to content

BlackGlory/bundle

Repository files navigation

bundle

一种用于描述文档的目录结构, 受到TextBundle的强烈启发.

与TextBundle的不同点:

  • Bundle直接以目录结构直接在文件系统里表示, 不需要打包.
  • Bundle的文本文件和元数据文件的格式是任意的, 不局限于Markdown和JSON.

Install

npm install --save @blackglory/bundle
# or
yarn add @blackglory/bundle

定义

一个典型的bundle目录结构如下:

.
├── assets
│   ├── hello.png
│   └── world.png
├── text.md
└── meta.json

bundle目录下的其他文件和目录会被忽略, 从而允许在此存放临时文件, 系统文件和版本控制系统.

/

bundle的根目录, 目录名称是随意的, 只需要便于人类识别.

/text

bundle的文本, 格式不受限制, 取决于具体实现.

如果text文件不存在, 则不会将此目录视作一个bundle.

/meta

bundle的元数据, 它是一种能够被解析为键值对字典的文件, 格式不受限制, 取决于具体实现.

如果meta文件不存在, 则不会将此目录视作一个bundle.

/assets

一个目录, 用于存放bundle使用到的资源.

API

interface IBundle {
  /**
   * The path of the root directory
   */
  root: string

  /**
   * The path of the meta file, relative to the root directory
   */
  meta: string

  /**
   * The path of the text file, relative to the root directory
   */
  text: string

  /**
   * The path of assets, relative to the root directory
   */
  assets: string[]
}

buildBundle

/**
 * @throws {NotDirectoryError}
 * @throws {TooManyIndexFilesError}
 * @throws {NoIndexFileError}
 * @throws {TooManyMetaFilesError}
 * @throws {NoMetaFileError}
 */
function buildBundle(path: string): Promise<IBundle>

isBundle

function isBundle(path: string): Promise<boolean>

findAllBundles

function findAllBundles(path: string): AsyncIterable<IBundle>