Initial commit

Author: marschattha

.github/workflows/main.yml

@@ -0,0 +1,39 @@
+name: Main
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  actions: write
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ 18 ]
+    name: Node ${{ matrix.node }} sample
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm test
+
+      - uses: qltyai/qlty-action/coverage@main
+        with:
+          coverage-token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          file: coverage/lcov.info

.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+/coverage
+/.nyc_output
+/dist

.nycrc

@@ -0,0 +1,15 @@
+{
+  "reporter": [
+    "lcov"
+  ],
+  "all": true,
+  "exclude": [
+    "node_modules",
+    "coverage",
+    "test"
+  ],
+  "extension": [
+    ".ts",
+    ".tsx"
+  ]
+}

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Code Climate, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# Qlty Typescript Coverage Example
+
+[Qlty](https://example.com) is a Code Health Platform with support for code coverage.
+
+This repository is an example using Qlty to track code coverage for a Typescript project. Coverage data is generated during test suite run and then uploaded to Qlty.
+
+This repository uses [Mocha](https://github.com/mochajs/mocha) for testing, [mocha lcov reporter](https://github.com/StevenLooman/mocha-lcov-reporter) and [nyc](https://github.com/istanbuljs/nyc) generating and outputing coverage report.
+
+## Requirements
+
+- Node 18 or above
+- [Mocha](https://github.com/mochajs/mocha)
+- [Mocha lcov reporter](https://github.com/StevenLooman/mocha-lcov-reporter)
+- [Nyc](https://github.com/istanbuljs/nyc)
+- Run tests with `npm test`
+- An account on Qlty (free for open source)
+- `QLTY_COVERAGE_TOKEN` is set as a GitHub Actions [repository secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)
+
+## Set up
+
+See [`.github/workflows/main.yml`](./.github/workflows/main.yml) in this repository for a basic configuration.
+
+## Documentation
+
+- [Advanced code coverage configuration](https://example.com)
+- [Alternative supported CI providers](https://example.com)
+
+## Help and feedback
+
+Join the our [Slack Community](https://example.com) for help and to provide feedback that we'll use to improve Qlty.
+
+## License
+
+[MIT License](./LICENSE.md)