BREAKING CHANGE(package): migrate package to the @git.zone scope and ESM-based tooling
This commit is contained in:
96
readme.md
96
readme.md
@@ -1,39 +1,77 @@
|
||||
# @gitzone/tscoverage
|
||||
get coverage information for gitzone projects
|
||||
# @git.zone/tscoverage
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tscoverage)
|
||||
* [gitlab.com (source)](https://gitlab.com/gitzone/tscoverage)
|
||||
* [github.com (source mirror)](https://github.com/gitzone/tscoverage)
|
||||
* [docs (typedoc)](https://gitzone.gitlab.io/tscoverage/)
|
||||
A CLI tool for collecting and reporting test coverage information for TypeScript projects in the gitzone ecosystem.
|
||||
|
||||
## Status for master
|
||||
## Issue Reporting and Security
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
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.
|
||||
|
||||
## Usage
|
||||
## 📦 Install
|
||||
|
||||
tscoverage will run tests while computing coverage for your gitzone project.
|
||||
Install globally for CLI usage:
|
||||
|
||||
## Contribution
|
||||
```bash
|
||||
pnpm install -g @git.zone/tscoverage
|
||||
```
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
Or as a dev dependency in your project:
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```bash
|
||||
pnpm install --save-dev @git.zone/tscoverage
|
||||
```
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
## 🚀 Usage
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
### CLI
|
||||
|
||||
Run `tscoverage` in your gitzone TypeScript project directory to execute tests and generate a coverage report:
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
### Programmatic
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Build the project
|
||||
pnpm run build
|
||||
|
||||
# Run tests
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
**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.
|
||||
|
||||
Reference in New Issue
Block a user