flash-watcher 0.1.2

A blazingly fast file watcher that executes commands when files change
Documentation 
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

name: CI

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

env:
  CARGO_TERM_COLOR: always

jobs:
  test:
    name: Test
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        rust: [stable, beta]
        exclude:
          - os: windows-latest
            rust: beta
          - os: macos-latest
            rust: beta

    steps:
    - uses: actions/checkout@v4

    - name: Install Rust
      uses: dtolnay/rust-toolchain@master
      with:
        toolchain: ${{ matrix.rust }}
        components: rustfmt, clippy

    - name: Cache cargo registry
      uses: actions/cache@v3
      with:
        path: ~/.cargo/registry
        key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}

    - name: Cache cargo index
      uses: actions/cache@v3
      with:
        path: ~/.cargo/git
        key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}

    - name: Cache cargo build
      uses: actions/cache@v3
      with:
        path: target
        key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}

    - name: Check formatting
      run: cargo fmt --all -- --check
      if: matrix.rust == 'stable'

    - name: Run clippy
      run: cargo clippy --all-targets --all-features -- -D warnings
      if: matrix.rust == 'stable'

    - name: Build
      run: cargo build --verbose

    - name: Run tests
      run: cargo test --verbose

    # Benchmarks are excluded from regular CI to save workflow minutes
    # They can be run manually or in dedicated benchmark workflows

  security:
    name: Security audit
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: rustsec/audit-check@v1.4.1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

  coverage:
    name: Code coverage
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
    - uses: actions/checkout@v4

    - name: Install Rust
      uses: dtolnay/rust-toolchain@stable
      with:
        components: llvm-tools-preview

    - name: Install cargo-llvm-cov
      uses: taiki-e/install-action@cargo-llvm-cov

    - name: Generate code coverage
      run: |
        # Temporarily disable benchmarks in Cargo.toml to avoid long-running benchmark execution
        sed -i 's/^\[\[bench\]\]/# [[bench]]/' Cargo.toml
        sed -i 's/^name = "file_watcher"/# name = "file_watcher"/' Cargo.toml
        sed -i 's/^harness = false/# harness = false/' Cargo.toml
        sed -i 's/^required-features = \["benchmarks"\]/# required-features = ["benchmarks"]/' Cargo.toml

        # Generate coverage reports
        cargo llvm-cov --all-features --workspace --tests --lcov --output-path lcov.info
        cargo llvm-cov --all-features --workspace --tests --html --output-dir coverage-html
        cargo llvm-cov --all-features --workspace --tests --summary-only

        # Restore benchmarks in Cargo.toml
        sed -i 's/^# \[\[bench\]\]/[[bench]]/' Cargo.toml
        sed -i 's/^# name = "file_watcher"/name = "file_watcher"/' Cargo.toml
        sed -i 's/^# harness = false/harness = false/' Cargo.toml
        sed -i 's/^# required-features = \["benchmarks"\]/required-features = ["benchmarks"]/' Cargo.toml

    - name: Upload coverage reports as artifacts
      uses: actions/upload-artifact@v4
      with:
        name: coverage-reports
        path: |
          lcov.info
          coverage-html/
        retention-days: 30