npm install @publishfx/bi-utilFor functions used across projects, support them through an internal npm package. Since the number of custom functions is relatively small, a single index.mjs file is sufficient for now.
Build Tool: tsup@latest
Code Organization: Source code is located in the src directory, with unified output through index.ts
Use npm run docs to generate documentation for local viewing. Web pages will be generated later.
Publish to npmjs.org
1. Ensure you are logged into your npmjs account:
``shell`
npm login
If you don't have an account yet, please register at npmjs.com first
2. Ensure you have publishing permissions for the @publishfx organization (if it's an organization package, you need to create the organization or join it first)
1. Modify the version in package.json locallynpm run build
2. Run locally to buildnpm pack --dry-run
3. Check what will be published: (optional, to view the contents that will be published)npm publish
4. Publish:
- Package name has been changed to @publishfx/bi-util, published to npmjs official registrypublishConfig
- has been configured to publish to npmjs official registry
- Ensure version numbers follow semantic versioning (semver)
`shell``
pnpm add @publishfx/bi-util@latestor
npm install @publishfx/bi-util@latest
1. TODO: Use eslint for code formatting constraints
2. TODO: Add CHANGELOG support
3. TODO: Add local unit testing
4. TODO: Standardize CI/CD pipeline
5. TODO: Add standard local git hooks