prek 0.3.11

A fast Git hook manager written in Rust, designed as a drop-in alternative to pre-commit, reimagined.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
use assert_fs::assert::PathAssert;
use assert_fs::fixture::{FileWriteStr, PathChild};
use prek_consts::env_vars::EnvVars;

use crate::common::{TestContext, cmd_snapshot, remove_bin_from_path};

/// Test basic Deno hook execution with an inline script.
#[test]
fn basic_deno() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: local
            hooks:
              - id: deno-check
                name: deno check
                language: deno
                entry: deno eval 'console.log("Hello from Deno!")'
                always_run: true
                verbose: true
                pass_filenames: false
    "#});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno check...............................................................Passed
    - hook id: deno-check
    - duration: [TIME]

      Hello from Deno!

    ----- stderr -----
    ");
}

/// Test running a TypeScript script file with an explicit `deno run` entry.
#[test]
fn script_file() {
    let context = TestContext::new();
    context.init_project();

    // Create a TypeScript script
    context
        .work_dir()
        .child("check.ts")
        .write_str(indoc::indoc! {r#"
            console.log("Script executed successfully!");
        "#})
        .expect("Failed to write check.ts");

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: local
            hooks:
              - id: ts-script
                name: ts script
                language: deno
                entry: deno run ./check.ts
                always_run: true
                verbose: true
                pass_filenames: false
    "});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    ts script................................................................Passed
    - hook id: ts-script
    - duration: [TIME]

      Script executed successfully!

    ----- stderr -----
    ");
}

/// Test running Deno built-in subcommands with an explicit `deno` prefix.
#[test]
fn builtin_commands() {
    let context = TestContext::new();
    context.init_project();

    // Create a TypeScript file for formatting check
    context
        .work_dir()
        .child("example.ts")
        .write_str(indoc::indoc! {r"
        const x = 1;
        console.log(x);
    "})
        .expect("Failed to write example.ts");

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: local
            hooks:
              - id: deno-fmt-check
                name: deno fmt check
                language: deno
                entry: deno fmt --check
                types: [ts]
                verbose: true
    "});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno fmt check...........................................................Passed
    - hook id: deno-fmt-check
    - duration: [TIME]

      Checked 1 file

    ----- stderr -----
    ");
}

/// Test a remote Deno hook whose manifest installs its own executable.
#[test]
fn remote_hook() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: https://github.com/prek-test-repos/deno-hooks
            rev: v3.1.0
            hooks:
              - id: deno-eval
                always_run: true
                verbose: true
    "});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno-eval................................................................Passed
    - hook id: deno-eval
    - duration: [TIME]

      This is a remote deno hook

    ----- stderr -----
    ");
}

/// Test a remote Deno hook whose configured additional dependency installs the executable it runs.
#[test]
fn remote_hook_with_additional_dependencies() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: https://github.com/prek-test-repos/deno-hooks
            rev: v3.1.0
            hooks:
              - id: deno-semver
                additional_dependencies: ["npm:semver@7:semver-tool"]
                always_run: true
                verbose: true
    "#});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno-semver..............................................................Passed
    - hook id: deno-semver
    - duration: [TIME]

      1.2.3

    ----- stderr -----
    ");
}

/// Test a remote Deno hook whose manifest installs a local file as an executable dependency.
#[test]
fn remote_hook_with_local_file_additional_dependency() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: https://github.com/prek-test-repos/deno-hooks
            rev: v3.1.0
            hooks:
              - id: deno-local-dep
                always_run: true
                verbose: true
    "});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno-local-dep...........................................................Passed
    - hook id: deno-local-dep
    - duration: [TIME]

      Hello from remote local additional dependency!

    ----- stderr -----
    ");
}

/// Test that `additional_dependencies` are installed as CLI executables.
#[test]
fn additional_dependencies() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: local
            hooks:
              - id: semver-version
                name: semver version
                language: deno
                entry: semver-tool 1.2.3
                additional_dependencies: ["npm:semver@7:semver-tool"]
                always_run: true
                verbose: true
                pass_filenames: false
    "#});

    context.git_add(".");

    let filters = context.filters().into_iter().collect::<Vec<_>>();

    cmd_snapshot!(filters.clone(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    semver version...........................................................Passed
    - hook id: semver-version
    - duration: [TIME]

      1.2.3

    ----- stderr -----
    ");

    // Run again to ensure the existing environment is reused cleanly.
    cmd_snapshot!(filters, context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    semver version...........................................................Passed
    - hook id: semver-version
    - duration: [TIME]

      1.2.3

    ----- stderr -----
    ");
}

/// Test that a local file can be installed as an executable additional dependency.
#[test]
fn additional_dependencies_local_file() {
    let context = TestContext::new();
    context.init_project();

    context
        .work_dir()
        .child("tool.ts")
        .write_str(indoc::indoc! {r#"
            console.log("Hello from local additional dependency!");
        "#})
        .expect("Failed to write tool.ts");

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: local
            hooks:
              - id: local-tool
                name: local tool
                language: deno
                entry: echo-tool
                additional_dependencies: ["./tool.ts:echo-tool"]
                always_run: true
                verbose: true
                pass_filenames: false
    "#});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    local tool...............................................................Passed
    - hook id: local-tool
    - duration: [TIME]

      Hello from local additional dependency!

    ----- stderr -----
    ");
}

/// Test `language_version` specification and deno installation.
/// In CI, we ensure deno 2.x is installed via setup-deno action.
#[test]
fn language_version() {
    if !EnvVars::is_set(EnvVars::CI) {
        // Skip when not running in CI, as we may have other deno versions installed locally.
        return;
    }

    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: local
            hooks:
              - id: deno-version
                name: deno version check (system)
                language: deno
                language_version: '2'
                entry: deno eval 'console.log(`Deno ${Deno.version.deno}`)'
                always_run: true
                verbose: true
                pass_filenames: false
              - id: deno-version
                name: deno version check (deno@2)
                language: deno
                language_version: deno@2
                entry: deno eval 'console.log(`Deno ${Deno.version.deno}`)'
                always_run: true
                verbose: true
                pass_filenames: false
              - id: deno-version
                name: deno version check (1.46 - will auto download)
                language: deno
                language_version: '1.46'
                entry: deno eval 'console.log(`Deno ${Deno.version.deno}`)'
                always_run: true
                verbose: true
                pass_filenames: false
              - id: deno-version
                name: deno version check (deno@1.46)
                language: deno
                language_version: deno@1.46
                entry: deno eval 'console.log(`Deno ${Deno.version.deno}`)'
                always_run: true
                verbose: true
                pass_filenames: false
    "});

    context.git_add(".");

    let deno_dir = context.home_dir().child("tools").child("deno");
    deno_dir.assert(predicates::path::missing());

    // Use two filters: first masks minor+patch for Deno 2.x (major-only request),
    // then masks only patch for specific minor versions like 1.46.x
    let filters = context
        .filters()
        .into_iter()
        .chain([
            (r"Deno 2\.\d+\.\d+", "Deno 2.X.X"),
            (r"Deno (\d+\.\d+)\.\d+", "Deno $1.X"),
        ])
        .collect::<Vec<_>>();

    cmd_snapshot!(filters, context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno version check (system)..............................................Passed
    - hook id: deno-version
    - duration: [TIME]

      Deno 2.X.X
    deno version check (deno@2)..............................................Passed
    - hook id: deno-version
    - duration: [TIME]

      Deno 2.X.X
    deno version check (1.46 - will auto download)...........................Passed
    - hook id: deno-version
    - duration: [TIME]

      Deno 1.46.X
    deno version check (deno@1.46)...........................................Passed
    - hook id: deno-version
    - duration: [TIME]

      Deno 1.46.X

    ----- stderr -----
    ");

    // Check that only deno 1.46 is installed (2.x uses system).
    let installed_versions = deno_dir
        .read_dir()
        .expect("Failed to read deno tools directory")
        .flatten()
        .filter_map(|d| {
            let filename = d.file_name().to_string_lossy().to_string();
            if filename.starts_with('.') {
                None
            } else {
                Some(filename)
            }
        })
        .collect::<Vec<_>>();

    assert_eq!(
        installed_versions.len(),
        1,
        "Expected only one Deno version to be installed, but found: {installed_versions:?}"
    );
    assert!(
        installed_versions.iter().any(|v| v.contains("1.46")),
        "Expected Deno 1.46 to be installed, but found: {installed_versions:?}"
    );
}

/// Test that deno hooks work without system deno in PATH.
/// Regression test ensuring run-time resolution still finds the managed toolchain.
#[test]
fn without_system_deno() {
    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: local
            hooks:
              - id: deno-check
                name: deno check
                language: deno
                entry: deno eval 'console.log("Hello")'
                always_run: true
                pass_filenames: false
    "#});

    context.git_add(".");

    let new_path = remove_bin_from_path("deno", None).expect("Failed to remove deno from PATH");

    cmd_snapshot!(context.filters(), context.run().env("PATH", new_path), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno check...............................................................Passed

    ----- stderr -----
    ");
}

/// Test semver range version specification.
#[test]
fn version_range() {
    if !EnvVars::is_set(EnvVars::CI) {
        // Skip when not running in CI.
        return;
    }

    let context = TestContext::new();
    context.init_project();

    context.write_pre_commit_config(indoc::indoc! {r#"
        repos:
          - repo: local
            hooks:
              - id: deno-version
                name: deno version range
                language: deno
                language_version: ">=2.0"
                entry: deno eval 'console.log(`Deno ${Deno.version.deno}`)'
                always_run: true
                verbose: true
                pass_filenames: false
    "#});

    context.git_add(".");

    let filters = context
        .filters()
        .into_iter()
        .chain([(r"Deno \d+\.\d+\.\d+", "Deno [VERSION]")])
        .collect::<Vec<_>>();

    cmd_snapshot!(filters, context.run(), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno version range.......................................................Passed
    - hook id: deno-version
    - duration: [TIME]

      Deno [VERSION]

    ----- stderr -----
    ");
}

/// Test that hook failure is properly reported.
#[test]
fn hook_failure() {
    let context = TestContext::new();
    context.init_project();

    // Create a TypeScript file with a lint error
    context
        .work_dir()
        .child("bad.ts")
        .write_str(indoc::indoc! {r"
        // This has a lint error: no-explicit-any
        let x: any = 1;
        console.log(x);
    "})
        .expect("Failed to write bad.ts");

    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: local
            hooks:
              - id: deno-lint
                name: deno lint
                language: deno
                entry: deno lint
                types: [ts]
                verbose: true
    "});

    context.git_add(".");

    // The lint should fail due to no-explicit-any
    let output = context.run().output().expect("Failed to run hook");
    assert!(!output.status.success(), "Expected lint to fail");
}

/// Test script with Deno permissions.
/// Note: Permissions must come before the script in the entry, so use explicit `deno run`.
#[test]
fn script_with_permissions() {
    let context = TestContext::new();
    context.init_project();

    // Create a script that reads an environment variable
    context
        .work_dir()
        .child("read_env.ts")
        .write_str(indoc::indoc! {r#"
        console.log(Deno.env.get("TEST_VAR") ?? "not set");
    "#})
        .expect("Failed to write read_env.ts");

    // Permissions must be specified before the script path when using deno run
    context.write_pre_commit_config(indoc::indoc! {r"
        repos:
          - repo: local
            hooks:
              - id: deno-env
                name: deno env
                language: deno
                entry: deno run --allow-env ./read_env.ts
                always_run: true
                verbose: true
                pass_filenames: false
    "});

    context.git_add(".");

    cmd_snapshot!(context.filters(), context.run().env("TEST_VAR", "hello"), @r"
    success: true
    exit_code: 0
    ----- stdout -----
    deno env.................................................................Passed
    - hook id: deno-env
    - duration: [TIME]

      hello

    ----- stderr -----
    ");
}