@hyperse/hps-plugin-pack
v0.1.0
Published
Utilities for packaging and metadata in the HPS (Hyperse) ecosystem. This package currently exposes lightweight metadata that can be used by tooling and scripts, and provides a foundation for future packaging-related features.
Readme
HPS Pack Plugin
Utilities for packaging and metadata in the HPS (Hyperse) ecosystem. This package currently exposes lightweight metadata that can be used by tooling and scripts, and provides a foundation for future packaging-related features.
Features
- Lightweight Metadata: Exposes
HPSmetadata for tooling - TypeScript Types: Ships with TypeScript type definitions
- Zero-config: No setup required
Installation
# yarn
yarn add @hyperse/hps-plugin-pack
# npm
npm install @hyperse/hps-plugin-pack
# pnpm
pnpm add @hyperse/hps-plugin-packQuick Start
import { HPS } from '@hyperse/hps-plugin-pack';
console.log(HPS.name); // "HPS"
console.log(HPS.version); // e.g. "0.0.1"Usage
Use the exported metadata in your build or release scripts:
import { HPS } from '@hyperse/hps-plugin-pack';
function printBanner() {
return `Building ${HPS.name} v${HPS.version}`;
}
console.log(printBanner());API Reference
HPS
An object exposing basic metadata.
Properties:
name: The product name stringversion: The product version string
Roadmap
Planned capabilities include:
- Packaging helpers for release artifacts
- Version and changelog utilities
- Integration hooks for CI/CD pipelines
Contributing
- Fork the repository
- Create a feature branch
- Implement your changes
- Add tests
- Submit a pull request
License
This project is licensed under the GPLv3 LICENSE.
