Skip to content
This repository has been archived by the owner on Jul 21, 2021. It is now read-only.

sivrad/matrix-collection-tools

Repository files navigation

Logo

Matrix Collection Tools
Collection CI/CD.

[ Installation 💾 | Usage 🤓 | NPM 📦 | Github 🕸 ]

Installation

yarn add -D @sivrad/matrix-collection-tools

Usage

Lint the Collection

This will compare files that match:

  • ./collection.json
  • ./types/*.json
matrix lint

Or using a script and yarn:

"scripts": {
  "lint": "yarn matrix lint"
}

Build the Collection Package

This will build the files in ./src/.

matrix build

Make a new Type

You can quickly create a new type with this command.

matrix mk-type YourTypeName

Build

The main function of this the collection tools is the Build functionality.

This will create all the files for the collection package.

These files include:

  • ./src/
  • ./src/index.ts
  • ./src/collection.ts
  • ./src/types
  • ./src/types/index.ts
  • ./src/types/YourTypeName.ts