Skip to content

Commit

Permalink
feat: readme validator
Browse files Browse the repository at this point in the history
  • Loading branch information
coltenkrauter committed Oct 11, 2024
1 parent 673906e commit 92a776b
Show file tree
Hide file tree
Showing 19 changed files with 1,469 additions and 540 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Tests
run-name: Tests [${{ github.ref_name }}] triggered by [${{ github.event_name }}/${{ github.actor }}]

on:
push:
branches: '*'
workflow_dispatch:

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 22

- name: Install Dependencies
run: npm ci

- name: Run Tests and Generate Coverage
run: npm test

- name: Upload Test and Coverage Reports
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: ./coverage
134 changes: 131 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,134 @@
# Utils
<div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">

![Code Size](https://img.shields.io/github/languages/code-size/krauters/utils)
![Commits per Month](https://img.shields.io/github/commit-activity/m/krauters/utils)
![Contributors](https://img.shields.io/github/contributors/krauters/utils)
![Forks](https://img.shields.io/github/forks/krauters/utils)
![GitHub Stars](https://img.shields.io/github/stars/krauters/utils)
![Install Size](https://img.shields.io/npm/npm/dw/@krauters%2Futils)
![GitHub Issues](https://img.shields.io/github/issues/krauters/utils)
![Last Commit](https://img.shields.io/github/last-commit/krauters/utils)
![License](https://img.shields.io/github/license/krauters/utils)
<a href="https://www.linkedin.com/in/coltenkrauter" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-%230077B5.svg?&style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn"></a>
[![npm version](https://img.shields.io/npm/v/@krauters%2Futils.svg?style=flat-square)](https://www.npmjs.org/package/@krauters/utils)
![Open PRs](https://img.shields.io/github/issues-pr/krauters/utils)
![Repo Size](https://img.shields.io/github/repo-size/krauters/utils)
![Version](https://img.shields.io/github/v/release/krauters/utils)
![visitors](https://visitor-badge.laobi.icu/badge?page_id=krauters/utils)

</div><div align="center">


</div># @krauters/utils

A versatile TypeScript utility package packed with reusable, type-safe functions, scripts useful for all kinds of TypeScript projects, and precommit scripts to streamline your development workflow.

## Husky
Expand All @@ -17,8 +147,6 @@ This project uses a custom pre-commit hook to run `npm run bundle`. This ensures
# ./husky/pre-commit
#!/bin/sh

#!/bin/sh

MAIN_DIR=./node_modules/@krauters/utils/scripts/pre-commit
. $MAIN_DIR/index.sh

Expand Down
34 changes: 19 additions & 15 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
/* eslint-disable @typescript-eslint/naming-convention */

module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
testMatch: ['**/test/**/*.test.{ts,tsx}'],
collectCoverage: true,
coverageDirectory: 'coverage',
coverageThreshold: {
global: {
lines: 60,
statements: 60,
functions: 60,
branches: 60,
},
},
}

collectCoverage: true,
coverageDirectory: 'coverage',
coverageThreshold: {
global: {
branches: 60,
functions: 60,
lines: 60,
statements: 60,
},
},
preset: 'ts-jest',
testEnvironment: 'node',
testMatch: ['**/test/**/*.test.{ts,tsx}'],
transform: {
'^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tsconfig.jest.json' }],
},
}
Loading

0 comments on commit 92a776b

Please sign in to comment.