diff --git a/.github/workflows/tsdoc.yml b/.github/workflows/tsdoc.yml new file mode 100644 index 0000000..f1c175d --- /dev/null +++ b/.github/workflows/tsdoc.yml @@ -0,0 +1,25 @@ +name: tsdoc-markdown +on: [pull_request] +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true +jobs: + tsdoc: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + repository: ${{ github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event.pull_request.head.ref }} + - uses: pnpm/action-setup@v2 + - uses: actions/setup-node@v4 + with: + cache: pnpm + node-version-file: .nvmrc + - run: pnpm install --frozen-lockfile + - run: pnpm run tsdoc + - uses: EndBug/add-and-commit@v9 + with: + add: . + default_author: github_actions + message: '🤖 Documentation auto-update' diff --git a/README.md b/README.md new file mode 100644 index 0000000..6cef4f8 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# @faergeek/monads + +Easy to use monads for JavaScript and TypeScript + + + diff --git a/package.json b/package.json index 52166fa..ff02727 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,8 @@ "lint": "eslint --max-warnings 0 .", "typecheck": "tsc -p tsconfig.node.json --noEmit", "test": "vitest", - "build": "tsc" + "build": "tsc", + "tsdoc": "tsdoc --src='src/*'" }, "packageManager": "pnpm@8.15.1", "devDependencies": { @@ -39,6 +40,7 @@ "prettier": "^3.2.5", "rimraf": "^5.0.5", "semantic-release": "^23.0.2", + "tsdoc-markdown": "^0.1.0", "typescript": "^5.3.3", "vitest": "^1.2.2" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a7f0af9..9308be6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -29,6 +29,9 @@ devDependencies: semantic-release: specifier: ^23.0.2 version: 23.0.2(typescript@5.3.3) + tsdoc-markdown: + specifier: ^0.1.0 + version: 0.1.0(typescript@5.3.3) typescript: specifier: ^5.3.3 version: 5.3.3 @@ -4547,6 +4550,15 @@ packages: typescript: 5.3.3 dev: true + /tsdoc-markdown@0.1.0(typescript@5.3.3): + resolution: {integrity: sha512-V2zayxM+QPukAoTs0WZhkL2SxX2he9l0PXlmkkB5rQN7mpwuk02zTnOAtKOZiU069QzBK51Jy7lBwQPfZvwglw==} + hasBin: true + peerDependencies: + typescript: ^5 + dependencies: + typescript: 5.3.3 + dev: true + /tslib@1.14.1: resolution: {integrity: sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==} dev: true