fix(docs): refresh package documentation and align metadata with current project layout

This commit is contained in:
2026-05-09 12:33:38 +00:00
parent 5f87fd3eae
commit b31ea2ab4f
17 changed files with 2238 additions and 14458 deletions
+48 -38
View File
@@ -1,63 +1,73 @@
# @git.zone/tscoverage
A CLI tool for collecting and reporting test coverage information for TypeScript projects in the gitzone ecosystem.
`@git.zone/tscoverage` is the TypeScript package scaffold for the `tscoverage` command in the `@git.zone` toolchain. The current implementation is intentionally minimal: the package entrypoint prints `tscoverage`, and the CLI wrapper loads the compiled entrypoint.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## 📦 Install
## Current Behavior
Install globally for CLI usage:
The source entrypoint lives in `ts/index.ts` and currently performs one action when imported or executed:
```bash
pnpm install -g @git.zone/tscoverage
```
Or as a dev dependency in your project:
```bash
pnpm install --save-dev @git.zone/tscoverage
```
## 🚀 Usage
### CLI
Run `tscoverage` in your gitzone TypeScript project directory to execute tests and generate a coverage report:
```bash
```text
tscoverage
```
This will run your project's test suite and produce a coverage report, giving you visibility into which parts of your codebase are exercised by tests.
The production CLI entrypoint is `cli.js`. It imports `dist_ts/index.js` and calls an exported `runCli()` function if one is added in the future. Because no `runCli()` export exists today, the CLI currently relies on the entrypoint side effect.
### Programmatic
## Usage
You can also import `tscoverage` in your own scripts:
```typescript
import * as tscoverage from '@git.zone/tscoverage';
```
## 🛠️ Development
This project uses the standard `@git.zone` toolchain:
Build before using the production CLI wrapper:
```bash
# Install dependencies
pnpm install
# Build the project
pnpm run build
node cli.js
```
# Run tests
For development against the TypeScript source wrapper:
```bash
node cli.ts.js
```
## Development
Install dependencies with pnpm:
```bash
pnpm install
```
Build the package:
```bash
pnpm run build
```
Run the test suite:
```bash
pnpm test
```
The project uses the current `@git.zone` TypeScript toolchain:
- `@git.zone/tsbuild` compiles `ts/**/*.ts` to `dist_ts/`.
- `@git.zone/tstest` runs tests from `test/`.
- `@git.zone/tsrun`, `@git.zone/tsbundle`, and `@git.zone/tswatch` are available as development tooling dependencies.
## Project Layout
- `ts/` contains the TypeScript source.
- `dist_ts/` contains generated build output.
- `test/` contains the tstest-based test suite.
- `cli.js` is the production CLI wrapper.
- `cli.ts.js` is the TypeScript-source CLI wrapper for development.
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license.md](./license.md) file.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
@@ -69,7 +79,7 @@ Use of these trademarks must comply with Task Venture Capital GmbH's Trademark G
### Company Information
Task Venture Capital GmbH
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.