@zettelyay/api-types v2.4.1

Zettel: Public API Types

Models and types definition for Zettel public API.

Installation

$ npm install @zettelyay/api-types

Development

Clone the repository locally:

$ git clone https://github.com/zettelyay/api-types.git

Install the dependencies:

$ cd api-types
$ npm install

It's recommended to use VS Code to develop this project. You need to have Prettier and ESLint extensions to be installed on your IDE.

Linting will be called automatically before committing. Any linting error will abort the process. Therefore, you possibly need to lint the staged changes manualy before trying to commit them yourself and fix all the errors and as much as possible of warnings first.

Lint check before commit:

$ npm run lint-staged   # Alternatively:   $ npm run .l

Publication

Publish a new version of the NPM package:

• Push all the changes. The workspace needs to be cleaned.
• Make sure you're on master branch.

$ npm version patch   # / minor / major / any other valid semantic version

Misc

Validate all peer dependencies:

$ npm run peers.validate

Upgrade all Zettel's official dependencies:

$ npm run zettel.upgrade   # Alternatively:   $ npm run .u

Check for all the updates available on the dependencies:

$ npm run updates.check

Upgrade all the dependencies to their very latest versions:

$ npm run updates.install

View GIT history visualized:

$ npm run gource

You probably need to install gource locally first. See this link.

Summarize the size of the code base in lines of code:

$ npm run status

Copyright: Zettel, 2020-23