@zettelooo/extension-build-tools v2.0.1
Zettel: Extension build helper tools
Build and helper tools for extension development.
Installation
$ npm install --save-dev @zettelooo/extension-build-toolsUsage
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 # / -hVersion extension's manifest:
$ zettel-ebt version patch # / minor / majorPack and zip extension's files:
$ zettel-ebt packUpload the extension's zipped file:
$ ZETTEL_TARGET_ENVIRONMENT=live ZETTEL_DEVELOPER_ACCESS_KEY=??? zettel-ebt uploadConfiguration
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 index.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 git@github.com:zettelooo/extension-build-tools.gitInstall the dependencies:
$ cd extension-build-tools
$ npm installIt'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
masterbranch.
$ npm version patch # / minor / major / any other valid semantic versionMisc
You can use the following NPM script to access Zettel Build Tools:
$ npm run bt -- <command> # e.g.: npm run bt - updateCopyright: Zettel, 2020-23