devobs 0.2.6__tar.gz → 0.2.7__tar.gz

{devobs-0.2.6 → devobs-0.2.7}/.config/nextest.toml

@@ -1,2 +1,5 @@
+[profile.default]
+fail-fast = false
+
 [profile.default.junit]
 path = "junit.xml"

devobs-0.2.7/.devcontainer.example/devcontainer-lock.json

@@ -0,0 +1,9 @@
+{
+  "features": {
+    "ghcr.io/devcontainers/features/nix:1": {
+      "version": "1.3.1",
+      "resolved": "ghcr.io/devcontainers/features/nix@sha256:8953a9da475055d140db0ede314e8e1b117d28c1eabf289c1b07c7619ce6c078",
+      "integrity": "sha256:8953a9da475055d140db0ede314e8e1b117d28c1eabf289c1b07c7619ce6c078"
+    }
+  }
+}

devobs-0.2.7/.devcontainer.example/devcontainer.json

@@ -0,0 +1,18 @@
+{
+  "name": "lasuillard-s/devobs",
+  "image": "mcr.microsoft.com/devcontainers/base:dev-trixie",
+  "features": {
+    "ghcr.io/devcontainers/features/nix:1": {
+      "extraNixConfig": "extra-experimental-features = nix-command flakes"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "EditorConfig.EditorConfig",
+        "vadimcn.vscode-lldb",
+        "rust-lang.rust-analyzer"
+      ]
+    }
+  }
+}

{devobs-0.2.6 → devobs-0.2.7}/.editorconfig

@@ -4,19 +4,16 @@ root = true
 
 [*]
 charset = utf-8
+end_of_line = lf
 indent_style = space
 indent_size = 2
-end_of_line = lf
-insert_final_newline = true
 trim_trailing_whitespace = true
+insert_final_newline = true
 
-[*.md]
-trim_trailing_whitespace = false
-indent_size = 4
-
-[Makefile]
-indent_style = tab
+[{justfile,Justfile}]
+indent_style = space
 indent_size = 4
 
 [*.rs]
+indent_style = space
 indent_size = 4

devobs-0.2.7/.github/workflows/ci.yaml

@@ -0,0 +1,101 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Set up Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
+
+      - name: Install nightly toolchain
+        run: rustup toolchain install nightly --profile minimal --component rustfmt
+
+      - name: Check code formatting
+        run: rustup run nightly cargo fmt --check
+
+      - name: Lint code
+        run: cargo clippy --all-targets --all-features -- --deny warnings
+
+  ub-check:
+    name: UB Check
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Set up Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
+
+      - name: Install nightly toolchain
+        run: rustup toolchain install nightly --profile minimal --component miri
+
+      - name: Install devtools
+        uses: taiki-e/install-action@4bc351f7f2614e48088386e2a0ad917ca3a7e4ba # v2.81.5
+        with:
+          tool: cargo-nextest
+
+      - name: Run tests with Miri
+        env:
+          MIRIFLAGS: '-Zmiri-disable-isolation'
+        run: |
+          rustup run nightly cargo miri \
+            nextest run --workspace --all-targets --all-features
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Set up Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
+
+      - name: Install devtools
+        uses: taiki-e/install-action@4bc351f7f2614e48088386e2a0ad917ca3a7e4ba # v2.81.5
+        with:
+          tool: cargo-llvm-cov,cargo-nextest
+
+      - name: Run tests
+        run: |
+          cargo llvm-cov nextest --workspace --all-targets --all-features --lcov --output-path lcov.info
+          cargo llvm-cov report --summary-only
+
+      - name: Upload test results to Codecov
+        uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1
+        with:
+          use_oidc: true
+          fail_ci_if_error: false
+          report_type: test_results
+          files: target/nextest/default/junit.xml
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1
+        with:
+          use_oidc: true
+          fail_ci_if_error: false
+          files: lcov.info

{devobs-0.2.6 → devobs-0.2.7}/.github/workflows/prepare-release.yaml

@@ -7,15 +7,19 @@ on:
         description: Semver-style tag for release (e.g., v1.0.0)
         required: true
 
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
 jobs:
   create-pr:
+    name: Create PR
     runs-on: ubuntu-latest
     timeout-minutes: 5
     permissions:
       contents: write
       pull-requests: write
     steps:
-      # TODO(lasuillard): Validate tag format more strictly (semver)
       - name: Check tag format
         run: |
           if [[ ! "${{ inputs.tag }}" =~ ^v ]]; then
@@ -23,7 +27,8 @@ jobs:
             exit 1
           fi
 
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
 
       # https://github.com/killercup/cargo-edit/issues/864
       - name: Set version
@@ -35,17 +40,28 @@ jobs:
           cargo set-version "$tag_no_v"
 
       - name: Generate GitHub App token
-        uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
         id: generate-token
         with:
-          app-id: ${{ vars.GH_APP_ID }}
+          client-id: ${{ vars.GH_APP_ID }}
           private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
 
       - name: Create pull request
-        uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
+        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
         with:
           token: ${{ steps.generate-token.outputs.token }}
           sign-commits: true
           title: Release ${{ inputs.tag }}
+          body: |
+            This pull request prepares the repository for the ${{ inputs.tag }} release.
+
+            ### Changes
+            - Bumps package version to `${{ inputs.tag }}` (without creating a git tag)
+            - Ready for review and merge
+
+            ### Next steps
+            1. Review and merge this PR
+            2. Create and publish a GitHub release with tag `${{ inputs.tag }}`
+            3. The release workflow will automatically build and publish the packages to PyPI via Maturin
           branch: release/${{ inputs.tag }}
           delete-branch: true

{devobs-0.2.6 → devobs-0.2.7}/.github/workflows/release.yaml

@@ -4,66 +4,71 @@ on:
   release:
     types: [published]
 
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
 jobs:
   build:
+    name: Build (${{ matrix.target }})
+    runs-on: ${{ matrix.platform }}
+    timeout-minutes: 15
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       matrix:
         include:
           - platform: ubuntu-latest
             target: x86_64
-
-    name: build (${{ matrix.target }})
-    runs-on: ${{ matrix.platform }}
-    timeout-minutes: 15
-    permissions:
-      contents: read
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
 
       - name: Build wheels
-        uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
         with:
           target: ${{ matrix.target }}
           args: --release --out dist
 
       - name: Upload wheels as artifact
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: dist-${{ matrix.target }}
           path: dist
 
   sdist:
+    name: Build sdist
     runs-on: ubuntu-latest
     timeout-minutes: 15
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
 
       - name: Build sdist
-        uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
         with:
           command: sdist
           args: --out dist
 
       - name: Upload sdist as artifact
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: sdist
           path: dist
 
   release:
-    needs:
-      - build
-      - sdist
+    name: Release
+    needs: [build, sdist]
     runs-on: ubuntu-latest
     timeout-minutes: 5
     permissions:
       contents: write
     steps:
       - name: Download binary artifacts
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           path: dist
 
@@ -71,15 +76,16 @@ jobs:
         run: ls -l --all --recursive dist
 
       - name: Create release
-        uses: softprops/action-gh-release@153bb8e04406b158c6c84fc1615b65b24149a1fe # v2.6.1
+        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda # v3
         with:
           tag_name: ${{ github.event.release.tag_name }}
-          generate_release_notes: true
+          generate_release_notes: false
           files: |
             dist/sdist/devobs-*.tar.gz
             dist/dist-*/devobs-*.whl
 
   publish-pypi:
+    name: Publish to PyPI
     needs: release
     runs-on: ubuntu-latest
     environment: pypi
@@ -88,7 +94,7 @@ jobs:
       id-token: write
     steps:
       - name: Download binary artifacts
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           path: dist
           merge-multiple: true
@@ -97,6 +103,6 @@ jobs:
         run: ls -l --all --recursive dist
 
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1
         with:
           skip-existing: true

{devobs-0.2.6 → devobs-0.2.7}/.gitignore

@@ -1,11 +1,17 @@
+.devcontainer
+.vscode
 lcov.info
 *.log
-.env
-.devcontainer/
-.vscode/
 
-# Created by https://www.toptal.com/developers/gitignore/api/osx,rust,linux,windows,visualstudiocode
-# Edit at https://www.toptal.com/developers/gitignore?templates=osx,rust,linux,windows,visualstudiocode
+# Created by https://www.toptal.com/developers/gitignore/api/osx,rust,linux,direnv,dotenv,windows,visualstudiocode,rust-analyzer
+# Edit at https://www.toptal.com/developers/gitignore?templates=osx,rust,linux,direnv,dotenv,windows,visualstudiocode,rust-analyzer
+
+### direnv ###
+.direnv
+.envrc
+
+### dotenv ###
+.env
 
 ### Linux ###
 *~
@@ -59,7 +65,7 @@ target/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-#Cargo.lock
+Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk
@@ -67,6 +73,11 @@ target/
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 
+### rust-analyzer ###
+# Can be generated by other build systems other than cargo (ex: bazelbuild/rust_rules)
+rust-project.json
+
+
 ### VisualStudioCode ###
 .vscode/*
 !.vscode/settings.json
@@ -112,4 +123,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/osx,rust,linux,windows,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/osx,rust,linux,direnv,dotenv,windows,visualstudiocode,rust-analyzer

{devobs-0.2.6 → devobs-0.2.7}/.pre-commit-config.yaml

@@ -1,4 +1,3 @@
-default_stages: [pre-commit]
 fail_fast: true
 exclude: |
   (?x)(
@@ -11,8 +10,9 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
 
+  # Dogfooding
   - repo: https://github.com/lasuillard-s/devobs
-    rev: main # Dogfooding; pin to a specific version when stable
+    rev: main
     hooks:
       # Ensure each command has its test file pair
       - id: check-file-pair
@@ -26,24 +26,24 @@ repos:
 
   - repo: local
     hooks:
-      - id: cargo-fmt
-        name: Format Rust codes
+      - id: cargo-clippy
+        name: cargo clippy
         language: system
         types: [rust]
         pass_filenames: false
-        entry: cargo fmt
+        entry: cargo clippy
+        args: [--fix, --allow-dirty, --, --deny, warnings]
 
-      - id: cargo-clippy
-        name: Lint Rust codes
+      - id: cargo-fmt
+        name: cargo fmt (nightly)
         language: system
         types: [rust]
         pass_filenames: false
-        entry: cargo clippy
+        entry: rustup run nightly cargo fmt
 
       - id: cargo-nextest
-        name: Test Rust codes
+        name: cargo nextest
         language: system
         types: [rust]
         pass_filenames: false
         entry: cargo nextest run
-        args: [--workspace]

devobs-0.2.7/.vscode.example/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "EditorConfig.EditorConfig",
+    "vadimcn.vscode-lldb",
+    "rust-lang.rust-analyzer"
+  ]
+}

devobs-0.2.7/.vscode.example/launch.json

@@ -0,0 +1,17 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "lldb",
+      "request": "launch",
+      "name": "Debug",
+      "program": "${workspaceRoot}/target/debug/devobs",
+      "env": {},
+      "args": [],
+      "cwd": "${workspaceRoot}",
+      "sourceLanguages": [
+        "rust"
+      ]
+    }
+  ]
+}

devobs-0.2.7/.vscode.example/settings.json

@@ -0,0 +1,12 @@
+{
+  "[rust]": {
+    "editor.defaultFormatter": "rust-lang.rust-analyzer"
+  },
+  "rust-analyzer.cargo.cfgs": [
+    "debug_assertions"
+    // "miri"
+  ],
+  "rust-analyzer.rustfmt.extraArgs": [
+    "+nightly"
+  ]
+}

devobs-0.2.7/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# ❤️‍🔥 Contributing to this project
+
+Thank you for your interest in contributing to **devobs**.
+
+## 🐛 Reporting issues
+
+Please report issues in our [GitHub repository](https://github.com/lasuillard-s/devobs/issues). Before submitting an issue, please search for existing issues to avoid duplicates.
+
+## 🏗️ Project overview
+
+This project is a CLI tool written in Rust for development workflow automation. It provides various commands to handle development tasks such as checking for matching file pairs or detecting changes in the target directory by comparing file hashes before and after running a command.
+
+### 🛠️ Tech stack
+
+This project uses the following tech stack:
+
+- [Rust](https://www.rust-lang.org)
+- [clap](https://docs.rs/clap/latest/clap/) for command-line parsing
+- [Clippy](https://doc.rust-lang.org/clippy/) for linting, and [rustfmt](https://github.com/rust-lang/rustfmt) for formatting
+- [Miri](https://github.com/rust-lang/miri) for undefined behavior checks
+- [cargo-nextest](https://nexte.st/) for test coverage and execution
+
+### 📂 Key directory structure
+
+- `src/`: Rust source code
+- `tests/`: Project integration tests
+- `Cargo.toml`: Rust package configuration
+- `flake.nix`: Nix Flakes development environment
+- `Justfile`: Local development commands
+- `pyproject.toml`: Python package configuration for [Maturin](https://www.maturin.rs/)
+- `rust-toolchain.toml`: Rust toolchain configuration
+
+## 🔧 Set up the development environment
+
+For development, the following tools are required:
+
+### ❄️ Tools managed via Nix Flakes
+
+This repository uses [Nix Flakes](https://nix.dev/concepts/flakes.html) to manage development tools. The following tools are installed automatically when `nix` is available:
+
+- `pre-commit`
+- `just`
+- `pipx`
+- `rustup`
+- `cargo`
+- `cargo-llvm-cov`
+- `cargo-nextest`
+- `cargo-watch`
+- `cargo-insta`
+- `maturin`
+
+Simply run `nix develop` to enter the development environment, then run `just install` to set up dependencies.
+
+If you prefer using a [Dev Container](https://containers.dev), an example configuration file ([`devcontainer.json`](./.devcontainer.example/devcontainer.json)) is provided.
+
+## ✅ Verifying changes
+
+Before pushing your code, run `just ci` to verify that your changes adhere to the project's coding standards and pass all linters, formatters, and tests.
+
+Alternatively, use the `pre-commit` hooks to handle formatting, linting, and quick test feedback automatically.
+
+## ✨ Submitting changes
+
+Please feel free to submit pull requests on GitHub. Before opening a PR, ensure your changes pass all checks by running `just ci`.
+
+## 🚀 Release process
+
+`devobs` is published to PyPI as a Python package via [Maturin](https://github.com/PyO3/maturin), to make it easy to install and use. To release a new version, follow these steps:
+
+1. Dispatch [Prepare Release](https://github.com/lasuillard-s/devobs/actions/workflows/prepare-release.yaml) workflow with the new version (e.g. `v0.1.0`)
+1. Review and merge the PR created by the workflow
+1. Create and publish a new release in GitHub Releases
+1. Application will be built with Maturin and published to PyPI automatically