ci fixes - formatting, pre-commit, license (#26)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: nyurik

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "weekly"
+- package-ecosystem: cargo
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "02:00"
+  open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -2,13 +2,17 @@ name: Build
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ main ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ main ]
   release:
     types: [ published ]
   workflow_dispatch:
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -42,10 +46,10 @@ jobs:
         if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
       - name: Read crate metadata
         id: metadata
-        run: echo "rust-version=$(sed -ne 's/rust-version *= *\"\(.*\)\"/\1/p' Cargo.toml)" >> $GITHUB_OUTPUT
+        run: echo "value=$(sed -ne 's/rust-version *= *\"\(.*\)\"/\1/p' Cargo.toml)" >> $GITHUB_OUTPUT
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: ${{ steps.metadata.outputs.rust-version }}
+          toolchain: ${{ steps.metadata.outputs.value }}
           components: rustfmt
       - run: just -v ci-test-msrv

.github/workflows/dependabot.yml

@@ -0,0 +1,27 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions: write-all
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/[email protected]
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Approve Dependabot PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Enable auto-merge for Dependabot PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -1,12 +1,5 @@
-# will have compiled files and executables
-**/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
+.ccache
 Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
-
-# coverage reports
-**/*.profraw
+cache.sqlite
+out.png
+target/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-shebang-scripts-are-executable
+        exclude: '.+\.rs' # would be triggered by #![some_attribute]
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-yaml
+        args: [ --allow-multiple-documents ]
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ --fix=lf ]
+      - id: trailing-whitespace
+
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: Rust Format
+        description: "Automatically format Rust code with cargo fmt"
+        entry: sh -c "cargo fmt --all"
+        language: rust
+        pass_filenames: false

LICENSE-APACHE

@@ -198,4 +198,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

LICENSE-MIT

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2024 Francisco Jimenez <[email protected]>
+Copyright (c) 2024-2025 Francisco Jimenez <[email protected]>
+Copyright (c) 2025 Yuri Astrakhan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,7 +9,7 @@
 This is a Rust wrapper for the [C++ FastPFor library](https://github.com/fast-pack/FastPFor), as well as a pure Rust re-implementation (work in progress).  Supports 32-bit and 64-bit integers, and SIMD-optimized codecs for 128-bit and 256-bit vectors. Based on the [Decoding billions of integers per second through vectorization, 2012](https://arxiv.org/abs/1209.2137) paper.
 
 ### Supported algorithms
-Unless otherwise specified, all codecs support `&[u32]` only. 
+Unless otherwise specified, all codecs support `&[u32]` only.
 * BP32
 * Copy
 * FastBinaryPacking8

justfile

@@ -8,34 +8,42 @@ clean:
     cargo clean
     rm -f Cargo.lock
 
-# Update dependencies, including breaking changes
+# Update all dependencies, including the breaking changes. Requires nightly toolchain (install with `rustup install nightly`)
 update:
     cargo +nightly -Z unstable-options update --breaking
     cargo update
 
-# Run cargo clippy
+# Run cargo clippy to lint the code
 clippy:
     cargo clippy --all-targets --workspace --all-features -- -D warnings
 
 # Test code formatting
 test-fmt:
     cargo fmt --all -- --check
 
-# Run cargo fmt
+# Reformat all code `cargo fmt`. If nightly is available, use it for better results
 fmt:
-    cargo +nightly fmt -- --config imports_granularity=Module,group_imports=StdExternalCrate
+    #!/usr/bin/env bash
+    set -euo pipefail
+    if command -v cargo +nightly &> /dev/null; then
+        echo 'Reformatting Rust code using nightly Rust fmt to sort imports'
+        cargo +nightly fmt --all -- --config imports_granularity=Module,group_imports=StdExternalCrate
+    else
+        echo 'Reformatting Rust with the stable cargo fmt.  Install nightly with `rustup install nightly` for better results'
+        cargo fmt --all
+    fi
 
 # Build and open code documentation
 docs:
     cargo doc --no-deps --all-features --open
 
-# Quick compile
+# Quick compile without building a binary
 check:
-    cargo check --all-targets --workspace --all-features
+    RUSTFLAGS='-D warnings' cargo check cargo check --workspace --all-targets --all-features
 
 # Default build
 build *ARGS:
-    cargo build --all-targets --workspace --all-features {{ARGS}}
+    RUSTFLAGS='-D warnings' cargo build --all-targets --workspace --all-features {{ARGS}}
 
 # Run all tests
 test *ARGS: build
@@ -90,7 +98,7 @@ ci-test: rust-info test-fmt clippy test test-doc
 ci-test-msrv: rust-info test
 
 # Verify that the current version of the crate is not the same as the one published on crates.io
-check-if-published:
+check-if-published: (assert "jq")
     #!/usr/bin/env bash
     set -euo pipefail
     LOCAL_VERSION="$(grep '^version =' Cargo.toml | sed -E 's/version = "([^"]*)".*/\1/')"
@@ -105,3 +113,11 @@ check-if-published:
     else
         echo "The current crate version has not yet been published."
     fi
+
+# Ensure that a certain command is available
+[private]
+assert $COMMAND:
+    @if ! type "{{COMMAND}}" > /dev/null; then \
+        echo "Command '{{COMMAND}}' could not be found. Please make sure it has been installed on your computer." ;\
+        exit 1 ;\
+    fi