0.0.3 • Published 1 year ago
@pedily/extension-scripts v0.0.3
Extension Scripts
This package contains scripts that aim to make the development of extensions easier.
Installation
Install the package as a "development dependency" using npm
npm i -D @pedily/extension-scripts
Usage
You can automate the generation of the "extension file" .tar.gz
file by calling extension-scripts bundle
in your npm scripts like this:
{
"scripts": {
"bundle": "extension-scripts package"
}
}
This will create a file called {{PACKAGE_NAME}}.tar.gz
in your project folder, where {{PACKAGE_NAME}}
is equal to the name
field in your package.json
.
Contents of the extension file (todo-list for implementation):
- your extension source code
- auto-detects TypeScript outputs by checking
outDir
intsconfig.json
- falls back to the
main
file's directory inpackage.json
- auto-detects TypeScript outputs by checking
- your
package.json
- it will nag about missing properties and add sane defaults if some are missing
- an
icon.png
- will add your
icon.png
from the project folder - will fall back to adding a dummy
icon.png
in case you don't provide one - will fall back to adding a dummy
icon.png
in case the one you provided is invalid
- will add your
- a
README.md
- will add your
README.md
from the project folder - will fall back to adding a dummy
README.md
in case you don't provide one
- will add your