Add precious config and run on files

Author: oschwald

.githooks/pre-commit

@@ -0,0 +1,20 @@
+#!/bin/bash
+#
+# Git pre-commit hook that runs precious lint on staged files
+#
+
+set -e
+
+echo "Running precious lint on staged files..."
+
+# Run precious lint on staged files
+if ! precious lint --staged; then
+    echo ""
+    echo "Linting failed. Please fix the issues above before committing."
+    echo ""
+    echo "To fix formatting issues automatically, run:"
+    echo "  precious tidy --staged"
+    exit 1
+fi
+
+echo "All linters passed!"

.github/workflows/rust.yml

@@ -3,7 +3,7 @@ name: Rust
 on:
   push:
     branches-ignore:
-      - 'dependabot/**'
+      - "dependabot/**"
   pull_request:
 
 env:

.precious.toml

@@ -0,0 +1,37 @@
+exclude = [
+  "target/**/*",
+  "test-data/**/*",
+  "supply-chain/**/*",
+]
+
+[commands.clippy]
+type = "lint"
+include = "**/*.rs"
+invoke = "once"
+path-args = "none"
+cmd = ["cargo", "clippy", "--all-features", "--", "-D", "warnings"]
+ok-exit-codes = [0]
+lint-failure-exit-codes = [101]
+expect-stderr = true
+
+[commands.rustfmt]
+type = "both"
+include = "**/*.rs"
+invoke = "once"
+path-args = "none"
+cmd = ["cargo", "fmt"]
+lint-flags = "--check"
+ok-exit-codes = [0]
+lint-failure-exit-codes = [1]
+
+[commands.prettier]
+type = "both"
+include = ["**/*.md", "**/*.yml", "**/*.yaml"]
+invoke = "once"
+path-args = "file"
+cmd = ["prettier"]
+lint-flags = "--check"
+tidy-flags = "--write"
+ok-exit-codes = [0]
+lint-failure-exit-codes = [1]
+expect-stderr = true

README.md

@@ -1,19 +1,19 @@
-# Rust MaxMind DB Reader #
+# Rust MaxMind DB Reader
 
-[![crates.io](	https://img.shields.io/crates/v/maxminddb.svg)](https://crates.io/crates/maxminddb) [![Released API docs](https://docs.rs/maxminddb/badge.svg)](http://docs.rs/maxminddb)
+[![crates.io](https://img.shields.io/crates/v/maxminddb.svg)](https://crates.io/crates/maxminddb) [![Released API docs](https://docs.rs/maxminddb/badge.svg)](http://docs.rs/maxminddb)
 
 This library reads the MaxMind DB format, including the GeoIP2 and GeoLite2
 databases.
 
-## Building ##
+## Building
 
 To build everything:
 
 ```
 cargo build
 ```
 
-## Testing ##
+## Testing
 
 This crate manages its test data within a git submodule.
 To run the tests, you will first need to run the following command.
@@ -22,7 +22,7 @@ To run the tests, you will first need to run the following command.
 git submodule update --init
 ```
 
-## Usage ##
+## Usage
 
 Add this to your `Cargo.toml`:
 
@@ -37,15 +37,15 @@ and this to your crate root:
 extern crate maxminddb;
 ```
 
-## API Documentation ##
+## API Documentation
 
 The API docs are on [Docs.rs](https://docs.rs/maxminddb/latest/maxminddb/struct.Reader.html).
 
-## Example ##
+## Example
 
 See [`examples/lookup.rs`](https://github.com/oschwald/maxminddb-rust/blob/main/examples/lookup.rs) for a basic example.
 
-## Benchmarks ##
+## Benchmarks
 
 The projects include benchmarks using [Criterion.rs](https://github.com/bheisler/criterion.rs).
 
@@ -68,12 +68,11 @@ Result of doing 100 random IP lookups:
 
 ![](/assets/pdf_small.svg)
 
-## Contributing ##
+## Contributing
 
 Contributions welcome! Please fork the repository and open a pull request
 with your changes.
 
-## License ##
+## License
 
 This is free software, licensed under the ISC license.
-