Skip to content

Commit 6f70abf

Browse files
committed
docs: remove Deno references from user-facing documentation
Deno is an internal implementation detail that end-users don't need to know about. Users only interact with the probitas CLI, not the runtime. Kept Deno requirement only for shell installer where it's a practical prerequisite. API names like "Deno KV" and code examples remain unchanged as they're part of the functionality users directly use.
1 parent 1b78e07 commit 6f70abf

2 files changed

Lines changed: 14 additions & 22 deletions

File tree

docs/installation.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
This guide covers all methods to install Probitas CLI.
44

5-
## Requirements
6-
7-
- [Deno](https://deno.land/) v2.x or later
8-
95
## Shell Installer
106

7+
Requires [Deno](https://deno.land/) v2.x or later.
8+
119
Install the CLI using the shell installer:
1210

1311
```bash
@@ -39,8 +37,6 @@ brew install probitas
3937
brew install jsr-probitas/tap/probitas
4038
```
4139

42-
Deno is installed automatically as a dependency.
43-
4440
## Nix
4541

4642
The Probitas CLI provides a Nix flake with multiple usage patterns.
@@ -85,7 +81,6 @@ Add Probitas to your project's development environment using the overlay:
8581
in {
8682
devShells.default = pkgs.mkShell {
8783
packages = with pkgs; [
88-
deno
8984
probitas
9085
];
9186
};
@@ -107,14 +102,13 @@ cleaner configuration:
107102
```nix
108103
overlays = [ probitas.overlays.default ];
109104
# ...
110-
packages = with pkgs; [ deno probitas ]; # probitas is now part of pkgs
105+
packages = with pkgs; [ probitas ]; # probitas is now part of pkgs
111106
```
112107

113108
Benefits:
114109

115110
- **Unified namespace**: Access `probitas` like any nixpkgs package
116111
- **Composable**: Combine with other overlays seamlessly
117-
- **Consistent Deno**: Uses your project's nixpkgs Deno version automatically
118112

119113
### Why Use inputs.follows?
120114

@@ -130,7 +124,6 @@ Benefits:
130124

131125
- **Single nixpkgs version**: All dependencies share one nixpkgs, reducing
132126
closure size
133-
- **Consistent tooling**: Deno version matches across your project
134127
- **Faster evaluation**: Fewer inputs to fetch and evaluate
135128

136129
### Pin a Specific Version
@@ -157,7 +150,7 @@ The Probitas CLI flake provides:
157150
| `packages.${system}.default` | The `probitas` CLI package |
158151
| `packages.${system}.probitas` | Alias for the CLI package |
159152
| `apps.${system}.default` | App for `nix run` |
160-
| `devShells.${system}.default` | Development shell with Deno |
153+
| `devShells.${system}.default` | Development shell |
161154

162155
## Verify Installation
163156

docs/overview.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Probitas
22

3-
Probitas is a scenario-based testing framework for Deno. It provides intuitive
4-
APIs for writing integration tests for APIs, databases, message queues, and
5-
other backend services.
3+
Probitas is a scenario-based testing framework. It provides intuitive APIs for
4+
writing integration tests for APIs, databases, message queues, and other backend
5+
services.
66

77
## Features
88

@@ -19,7 +19,7 @@ other backend services.
1919
Install the CLI to run scenarios. Choose your preferred method:
2020

2121
```bash
22-
# Shell installer (requires Deno)
22+
# Shell installer (requires Deno v2.x+)
2323
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | bash
2424

2525
# Homebrew (macOS/Linux)
@@ -116,13 +116,12 @@ probitas lint
116116
probitas check
117117
```
118118

119-
These commands run Deno's built-in tools on discovered scenario files. They use
120-
the same file discovery mechanism as `probitas run`, respecting your `includes`
121-
and `excludes` configuration.
119+
These commands use the same file discovery mechanism as `probitas run`,
120+
respecting your `includes` and `excludes` configuration.
122121

123122
### fmt
124123

125-
Formats scenario files using `deno fmt`:
124+
Formats scenario files:
126125

127126
```bash
128127
probitas fmt # Format all discovered scenarios
@@ -131,8 +130,8 @@ probitas fmt probitas/auth/ # Format specific directory
131130

132131
### lint
133132

134-
Lints scenario files using `deno lint`. Automatically excludes rules that
135-
conflict with scenario imports (`no-import-prefix`, `no-unversioned-import`):
133+
Lints scenario files. Automatically excludes rules that conflict with scenario
134+
imports (`no-import-prefix`, `no-unversioned-import`):
136135

137136
```bash
138137
probitas lint # Lint all discovered scenarios
@@ -141,7 +140,7 @@ probitas lint probitas/auth/ # Lint specific directory
141140

142141
### check
143142

144-
Type-checks scenario files using `deno check`:
143+
Type-checks scenario files:
145144

146145
```bash
147146
probitas check # Type-check all discovered scenarios

0 commit comments

Comments
 (0)