feat!: move "tsd-lite" to peer dependency

Author: andreidmt

README.md

@@ -6,13 +6,14 @@
 
 # tsd-lite-cli
 
-Test runner for testing TypeScript typings (CLI over
-[tsd-lite][intro_tsd-lite], a "per file" version of [tsd][intro_tsd]).
+Test runner for testing TypeScript typings. CLI over
+[`tsd-lite`][intro_tsd-lite], a per-file version of [`tsd`][intro_tsd].
 
 - :mag: [Glob][intro_fast-glob] pattern matching
 - :white_check_mark: [TAP][intro_tap] compatible output
 
-![tsd-lite-cli default colored tap output](docs/output-default.png "tsd-lite-cli default colored tap output")
+![tsd-lite-cli default colored tap output](docs/output-default.png
+"tsd-lite-cli default colored tap output")
 
 [intro_tsd]: https://github.com/SamVerschueren/tsd
 [intro_tsd-lite]: https://github.com/mrazauskas/tsd-lite
@@ -24,35 +25,31 @@ Test runner for testing TypeScript typings (CLI over
 <!-- vim-markdown-toc GFM -->
 
 - [Install](#install)
+  - [`tsd-lite`](#tsd-lite)
+  - [`@tsd/typescript`](#tsdtypescript)
 - [Usage](#usage)
-  - [Example typing test file](#example-typing-test-file)
-- [CLI interface](#cli-interface)
-  - [`--color` and `--no-color`](#--color-and---no-color)
+  - [CLI interface](#cli-interface)
 - [Similar projects](#similar-projects)
 - [Changelog](#changelog)
 
 <!-- vim-markdown-toc -->
 
 ## Install
 
-```shell-session
-npm install --save-dev @tsd/typescript tsd-lite-cli
+```console
+npm install --save-dev @tsd/typescript tsd-lite tsd-lite-cli
 ```
 
-## Usage
-
-Run `tsd-lite` with a glob pattern for matching test files (uses
-[fast-glob][usage_fast-glob] internally):
-
-```shell-session
-npx tsd-lite 'src/**/*.test-d.ts'
-```
+Besides `tsd-lite-cli`, you also need `tsd-lite` and `@tsd/typescript` which
+are listed as peer dependencies.
 
-[usage_fast-glob]: https://github.com/mrmlnc/fast-glob
+### `tsd-lite`
 
-### Example typing test file
+Contains the actual assertion functions. For more information, see
+[tsd-lite][install_tsd-lite].
 
 ```typescript
+// src/concat.test-d.ts
 import { expectType, expectError } from "tsd-lite"
 import concat from "./concat.js"
 
@@ -61,13 +58,32 @@ expectType<string>(await concat("foo", "bar"))
 expectError(await concat(true, false))
 ```
 
-For more information, see [tsd-lite][example_tsd-lite] for assertion syntax.
+[install_tsd-lite]: https://github.com/mrazauskas/tsd-lite
+
+### `@tsd/typescript`
+
+Compiles the TypeScript test files. It's version should be synced with the
+`typescript` version in your project. For more information, see
+[`@tsd/typescript`][install_tsd-typescript].
+
+[install_tsd-typescript]: https://github.com/SamVerschueren/tsd-typescript
+
+## Usage
+
+Run `tsd-lite` with a glob pattern for matching test files - uses
+[`fast-glob`][usage_fast-glob] internally:
+
+```console
+npx tsd-lite 'src/**/*.test-d.ts'
+```
+
+[usage_fast-glob]: https://github.com/mrmlnc/fast-glob
 
-[example_tsd-lite]: https://github.com/mrazauskas/tsd-lite
+### CLI interface
 
-## CLI interface
+```console
+$ npx tsd-lite --help
 
-```shell-session
 Usage: tsd-lite [options] <patterns...>
 
 Test runner for testing TypeScript typings (CLI over tsd-lite, a "per file"
@@ -84,23 +100,33 @@ Options:
   -h, --help     Print this help guide
 ```
 
-### `--color` and `--no-color`
+#### `--color` and `--no-color`
 
 By default, `tsd-lite-cli` outputs a colored version of [Test Anything
-Protocol][cli_tap] for better readability. This can be disabled by setting
-`--no-color` when piping to other tools like `tap-spec`:
+Protocol][cli_tap] for better readability. Can be disabled by setting
+`--no-color` when piping to other tools, e.g. [`tap-spec`][cli_tap-spec].
+
+```console
+npx tsd-lite 'src/**/*.test-d.ts' --no-color
+```
+
+![tsd-lite-cli --no-color output](docs/output-no-color.png "tsd-lite-cli
+--no-color output")
 
-```shell-session
+```console
 npx tsd-lite 'src/**/*.test-d.ts' --no-color | npx tap-spec
 ```
 
-![tsd-lite-cli --no-color output piped to tap-spec](docs/output-no-color_tap-spec.png "tsd-lite-cli --no-color output piped to tap-spec")
+![tsd-lite-cli --no-color output piped to
+tap-spec](docs/output-no-color_tap-spec.png "tsd-lite-cli --no-color output
+piped to tap-spec")
 
 [cli_tap]: https://testanything.org
+[cli_tap-spec]: https://github.com/scottcorgan/tap-spec
 
 ## Similar projects
 
-- [jest-runner-tsd][similar_jest-runner-tsd] - Jest runner to test TypeScript
+- [`jest-runner-tsd`][similar_jest-runner-tsd] - Jest runner to test TypeScript
   typings
 
 [similar_jest-runner-tsd]: https://github.com/jest-community/jest-runner-tsd

docs/output-default.png

@@ -1,7 +1,7 @@
 {
   "name": "tsd-lite-cli",
   "version": "2.1.0",
-  "description": "Test runner for testing TypeScript typings (CLI over tsd-lite, a \"per file\" version of tsd)",
+  "description": "Test runner for testing TypeScript typings. CLI over tsd-lite, a per-file version of tsd",
   "license": "MIT",
   "homepage": "https://github.com/asd-xiv/tsd-lite-cli/#readme",
   "bugs": {
@@ -16,13 +16,14 @@
     "url": "https://github.com/andreidmt"
   },
   "keywords": [
+    "cli",
     "typescript",
-    "test",
-    "tsd",
-    "tsd-lite",
     "types",
+    "test",
     "typings",
-    "cli"
+    "typing-test",
+    "tsd",
+    "tsd-lite"
   ],
   "sideEffects": false,
   "type": "module",
@@ -60,11 +61,11 @@
   },
   "dependencies": {
     "commander": "^10.0.0",
-    "fast-glob": "^3.2.12",
-    "tsd-lite": "^0.6.0"
+    "fast-glob": "^3.2.12"
   },
   "peerDependencies": {
-    "@tsd/typescript": "^4.9.5"
+    "@tsd/typescript": "^4.9.5",
+    "tsd-lite": "^0.6.0"
   },
   "devDependencies": {
     "@asd14/eslint-config": "^9.2.0",