Update links in package, add more explanation

This commit is contained in:
Pieter Vander Vennet 2025-02-08 21:51:17 +01:00
parent b790b06e0f
commit 89c6c8103b
2 changed files with 8 additions and 5 deletions

View file

@ -25,6 +25,9 @@ export default class SomeClass {
} }
``` ```
Running `doctest-ts-improved <directory>` will create a copy of all `.ts`-files, containing the runner code. The new files will be named `<original-filename>.doctest.ts`.
To ignore a (group of) files, add `--ignore filename.ts` or `--ignore <directory>/*.ts`. Multiple `--ignore`-flags can be given.
# License # License
MIT MIT

View file

@ -1,7 +1,7 @@
{ {
"$schema": "http://json.schemastore.org/package", "$schema": "http://json.schemastore.org/package",
"name": "doctest-ts-improved", "name": "doctest-ts-improved",
"version": "0.8.6", "version": "0.9.0",
"description": "doctest support for typescript with Mocha", "description": "doctest support for typescript with Mocha",
"main": "src/main.ts", "main": "src/main.ts",
"bin": { "bin": {
@ -16,19 +16,19 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/pietervdvn/doctest-ts.git" "url": "forgejo@source.mapcomplete.org:MapComplete/doctest-ts.git"
}, },
"keywords": [ "keywords": [
"doctest", "doctest",
"typescript", "typescript",
"testing" "testing"
], ],
"author": "Dan Rosén", "author": "Dan Rosén, Pieter Vander Vennet",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/pietervdvn/doctest-ts/issues" "url": "https://source.mapcomplete.org/MapComplete/doctest-ts/issues"
}, },
"homepage": "https://github.com/pietervdvn/doctest-ts#readme", "homepage": "https://source.mapcomplete.org/MapComplete/doctest-ts",
"dependencies": { "dependencies": {
"@types/chai": "^4.3.0", "@types/chai": "^4.3.0",
"chai": "^4.3.6", "chai": "^4.3.6",