@tesd-tech/ps-package
v24.11.9
Published
Create and manage PowerSchool plugin archives
Downloads
603
Readme
ps-package
This package automates the process of building and packaging a PowerSchool plugin. It handles tasks such as:
- Updating the plugin version number in plugin.xml, all pagecataloging JSON files, and package.json
- Merging PowerSchool-specific folders into the build directory
- Removing junk files from the build directory
- Creating ZIP files for the plugin and its schema
- Pruning the archive directory to keep only the most recent ZIP files
Installation
To install the package, run the following command from the root directory of your plugin project:
pnpm i -D @tesd-tech/ps-package
Usage
npx ps-package
Options
The package accepts two optional command-line arguments:
source
: The source directory for the plugin files. This defaults tosrc
.type
: The plugin type. This can bevue
orsvelte
. This defaults tovue
.
Additional Notes
- The package expects the plugin's source files to be located in a directory named
src
in the project's root directory. - Additionally, PowerSchool-specific files and directories should be located in a subdirectory named "powerschool" within the
src
directory.- See the src directory within this project for an example of this structure.
- The package expects the plugin's XML manifest file to be named
plugin.xml
and located in the project's root directory. - The package creates the following directories:
dist
: The directory where the plugin's built files are placed.plugin_archive
: The directory where ZIP files of the plugin and its schema are created.
- The package will overwrite any existing files in the
dist
andplugin_archive
directories.
Credits
This package was developed by Benjamin Kemp and is based on the work of others who have contributed to the open-source community.
License
This package is available under the MIT License.