88 lines
3.5 KiB
Markdown
88 lines
3.5 KiB
Markdown
# @git.zone/tscoverage
|
|
|
|
`@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.
|
|
|
|
## Current Behavior
|
|
|
|
The source entrypoint lives in `ts/index.ts` and currently performs one action when imported or executed:
|
|
|
|
```text
|
|
tscoverage
|
|
```
|
|
|
|
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.
|
|
|
|
## Usage
|
|
|
|
Build before using the production CLI wrapper:
|
|
|
|
```bash
|
|
pnpm run build
|
|
node cli.js
|
|
```
|
|
|
|
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](./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.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
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.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|