@zettelyay/extension-build-tools

Zettel: Extension build helper tools

Build and helper tools for extension development.

Installation

$ npm install --save-dev @zettelyay/extension-build-tools

Usage

This package provides shell command zettel-ebt executable binary. You can use it to speed up a couple of tasks while developing Zettel extensions.

See help:

$ zettel-ebt help   # / h

Upgrade Zettel's official dependencies:

$ zettel-ebt upgrade

Version extension's manifest:

$ zettel-ebt version patch   # / minor / major

Pack and zip extension's files:

$ zettel-ebt pack

See build tools version:

$ zettel-ebt version   # / v

Configuration

You may provide the following configuration parameters either as the CLI command flags or options in the config file; which is either .zettelebtrc, .zettelebtrc.json, .zettelebtrc.js, .zettelebtrc.yml, or .zettelebtrc.yaml.

RC file property path	Command-line flag	Default	Description
paths.root	-r, --root-path	"."	Project root relative path, contains package.json file
paths.public	-p, --public-path	"public"	Public folder relative path to root, contains manifest.jsonc file
paths.src	-s, --src-path	"src"	Source folder relative path to root, contains extension-function.js file
paths.out	-o, --out-path	"out"	Dist folder relative path to root, to place the packed content

Development

Clone the repository locally:

$ git clone https://github.com/zettelyay/extension-build-tools.git

Install the dependencies:

$ cd extension-build-tools
$ npm install

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

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

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