ts-helpers Monorepo

Monorepo root for the ts-helpers suite of TypeScript helper libraries and documentation.

This repository uses Lerna and pnpm workspaces to manage multiple publishable and buildable packages.

---

Table of Contents

• Prerequisites
• Installation
• Workspaces
• Available Scripts
• Packages Structure
• Publishing & Registry
• Documentation
• Contributing
• License

---

Prerequisites

• Node.js v18.x or higher
• pnpm v8 or higher
• Git for version control

---

Installation

Clone the repository and install dependencies:

git clone <repository-url>
cd ts-helpers-monorepo
pnpm install --frozen-lockfile

After install, Husky hooks are set up automatically (prepare & postinstall scripts).

---

Workspaces

This monorepo uses pnpm workspaces defined under:

{
  "workspaces": [
    "packages/*"
  ]
}

Each package is located in packages/<package-name> and is managed by Lerna.

---

Available Scripts

All commands are run from the root using pnpm run <script>.

Script	Description
pnpm run lint	Run ESLint on all packages
pnpm run test	Run unit tests in all packages
pnpm run test:coverage	Run tests with coverage reports
pnpm run build	Build all packages using Lerna
pnpm run commit	Launch Commitizen for conventional commits
pnpm run version	Generate changelog and commit it (CHANGELOG.md)
pnpm run version:prerelease	Bump pre-release version, e.g., beta tag
pnpm run version:ci	Bump version in CI mode with conventional commits
pnpm run bootstrap:ci	Install dependencies in CI (pnpm install --immutable)
pnpm run ci	Run lint, test, and build in parallel
pnpm run publish:ci	Publish all packages from local versions to registry
pnpm run deploy:docs	Build and deploy documentation package to GitHub Pages
pnpm run prepare	Initialize Husky Git hooks
pnpm run postinstall	Trigger prepare after install

---

Packages Structure

packages/
├── ts-utils           # `@xrdev_38/ts-utils`: Utility helper functions
├── ts-functions       # `@xrdev_38/ts-functions`: General-purpose TypeScript functions
└── ts-service-docs    # `@xrdev_38/ts-service-docs`: Documentation site built with Docusaurus

• ts-utils (@xrdev_38/ts-utils): Reusable helper functions (deepClone, debounce, throttle, type guards, etc.).
• ts-functions (@xrdev_38/ts-functions): Common functions and business logic utilities for modern applications.
• ts-service-docs (@xrdev_38/ts-service-docs): Docusaurus-based documentation for all packages.

Each package is buildable and publishable independently via Lerna.

---

Ensure you have an environment variable NPM_TOKEN set in CI/CD for authentication:

export NPM_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

In GitHub Actions, this token is saved as a secret and consumed to create a .npmrc file.

---

Documentation

The documentation site lives in the ts-service-docs package and is deployed to the gh-pages branch.

• Development: Run locally:

  pnpm exec lerna run --scope=@xrdev_38/ts-service-docs start
  # or if configured, `pnpm nx serve @xrdev38-docs`

  Then open http://localhost:3000/.

• Build: Generate static assets:

  pnpm exec lerna run --scope=@xrdev_38/ts-service-docs build

• Deploy: In CI/CD, the workflow pushes ts-service-docs/build to the gh-pages branch via peaceiris/actions-gh-pages.

The site is then accessible at https://<username>.github.io/<repo-name>/.

---

Contributing

1. Fork the repository.
2. Create your feature branch: git checkout -b feature/awesome.
3. Commit your changes: pnpm run commit.
4. Push to the branch: git push origin feature/awesome.
5. Open a Pull Request.

Please follow the conventional commit guidelines and check that lint, tests, and build pass before merging.

---

License

This project does not specify a license in package.json. Please add a LICENSE file or update the root package.json accordingly.