bibsync 0.4.2__tar.gz → 0.4.3__tar.gz

{bibsync-0.4.2 → bibsync-0.4.3}/.pre-commit-config.yaml

@@ -38,7 +38,7 @@ repos:
           - id: ruff-format
 
     - repo: https://github.com/astral-sh/uv-pre-commit
-      rev: 0.11.26
+      rev: 0.11.27
       hooks:
           - id: uv-lock
 

bibsync-0.4.3/.pre-commit-hooks.yaml

@@ -0,0 +1,12 @@
+- id: bibsync
+  name: bibsync
+  description: Synchronize BibTeX entries from TeX and Markdown citation keys
+  entry: bibsync
+  language: rust
+  types_or: [tex, bib, markdown]
+- id: bibsync-bin
+  name: bibsync
+  description: Synchronize BibTeX entries from TeX and Markdown citation keys using a pre-built release binary
+  entry: scripts/pre-commit-bibsync
+  language: script
+  types_or: [tex, bib, markdown]

{bibsync-0.4.2 → bibsync-0.4.3}/CITATION.cff

@@ -1,6 +1,6 @@
 cff-version: 1.2.0
 title: "bibsync: A Rust package to automatically resolve, synchronize, and validate LaTeX citations across BibTeX databases"
-version: "0.4.2"
+version: "0.4.3"
 date-released: "2026-07-07"
 license: "BSD-3-Clause"
 type: software

{bibsync-0.4.2 → bibsync-0.4.3}/Cargo.lock

@@ -119,7 +119,7 @@ checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
 
 [[package]]
 name = "bibsync"
-version = "0.4.2"
+version = "0.4.3"
 dependencies = [
  "assert_cmd",
  "clap",
@@ -1259,9 +1259,9 @@ dependencies = [
 
 [[package]]
 name = "rustversion"
-version = "1.0.22"
+version = "1.0.23"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f"
 
 [[package]]
 name = "ryu"

{bibsync-0.4.2 → bibsync-0.4.3}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bibsync"
-version = "0.4.2"
+version = "0.4.3"
 edition = "2024"
 rust-version = "1.85"
 authors = ["Isaac C. F. Wong"]

{bibsync-0.4.2 → bibsync-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bibsync
-Version: 0.4.2
+Version: 0.4.3
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Science/Research
@@ -134,7 +134,7 @@ For convenience, you can also use:
 @software{wong2026bibsync,
   author  = {Wong, Isaac C. F.},
   title   = {bibsync: A Rust package to automatically resolve, synchronize, and validate LaTeX citations across BibTeX databases},
-  version = {v0.4.2},
+  version = {v0.4.3},
   year    = {2026},
   month   = jul,
   doi     = {10.5281/zenodo.20422622},
@@ -281,12 +281,36 @@ provider and citekey or batch being resolved.
 The repository includes `.pre-commit-hooks.yaml`, so other projects can use
 `bibsync` as a pre-commit hook.
 
+Both hooks run on TeX (`.tex`), BibTeX (`.bib`), and Markdown (`.md`) files.
+Every `@key` in a scanned file is treated as a citation, so scanning unrelated
+Markdown can raise false positives — for example a `README.md` that uses GitHub
+`@mentions`. **The recommended setup is to scope the hook to your citation
+sources with `files:`** rather than relying on the default file matching.
+
+For a JOSS paper (`paper.md` + `paper.bib`):
+
+```yaml
+repos:
+    - repo: https://github.com/isaac-cf-wong/bibsync
+      rev: v0.4.3
+      hooks:
+          - id: bibsync-bin
+            files: ^paper\.md$
+            args: [--fix, --cache, --provider, inspire, --output, paper.bib]
+```
+
+The `--output` bibliography is read and written even when it is not itself
+matched by `files:`, so scoping to `paper.md` still keeps `paper.bib` in sync.
+
+The remaining examples below omit `files:` for brevity; add it to match your
+project layout.
+
 Use the pre-built binary hook for faster installs:
 
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args: [--cache, --provider, inspire, --output, references.bib]
@@ -301,7 +325,7 @@ installation:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync
             args: [--provider, inspire, --output, references.bib]
@@ -313,7 +337,7 @@ writing changes. To let the hook update files, add `--fix` to the hook args:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args: [--fix, --cache, --provider, inspire, --output, references.bib]
@@ -324,7 +348,7 @@ To skip manually curated entries, add `--ignore-file`:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args:

{bibsync-0.4.2 → bibsync-0.4.3}/README.md

@@ -107,7 +107,7 @@ For convenience, you can also use:
 @software{wong2026bibsync,
   author  = {Wong, Isaac C. F.},
   title   = {bibsync: A Rust package to automatically resolve, synchronize, and validate LaTeX citations across BibTeX databases},
-  version = {v0.4.2},
+  version = {v0.4.3},
   year    = {2026},
   month   = jul,
   doi     = {10.5281/zenodo.20422622},
@@ -254,12 +254,36 @@ provider and citekey or batch being resolved.
 The repository includes `.pre-commit-hooks.yaml`, so other projects can use
 `bibsync` as a pre-commit hook.
 
+Both hooks run on TeX (`.tex`), BibTeX (`.bib`), and Markdown (`.md`) files.
+Every `@key` in a scanned file is treated as a citation, so scanning unrelated
+Markdown can raise false positives — for example a `README.md` that uses GitHub
+`@mentions`. **The recommended setup is to scope the hook to your citation
+sources with `files:`** rather than relying on the default file matching.
+
+For a JOSS paper (`paper.md` + `paper.bib`):
+
+```yaml
+repos:
+    - repo: https://github.com/isaac-cf-wong/bibsync
+      rev: v0.4.3
+      hooks:
+          - id: bibsync-bin
+            files: ^paper\.md$
+            args: [--fix, --cache, --provider, inspire, --output, paper.bib]
+```
+
+The `--output` bibliography is read and written even when it is not itself
+matched by `files:`, so scoping to `paper.md` still keeps `paper.bib` in sync.
+
+The remaining examples below omit `files:` for brevity; add it to match your
+project layout.
+
 Use the pre-built binary hook for faster installs:
 
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args: [--cache, --provider, inspire, --output, references.bib]
@@ -274,7 +298,7 @@ installation:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync
             args: [--provider, inspire, --output, references.bib]
@@ -286,7 +310,7 @@ writing changes. To let the hook update files, add `--fix` to the hook args:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args: [--fix, --cache, --provider, inspire, --output, references.bib]
@@ -297,7 +321,7 @@ To skip manually curated entries, add `--ignore-file`:
 ```yaml
 repos:
     - repo: https://github.com/isaac-cf-wong/bibsync
-      rev: v0.4.2
+      rev: v0.4.3
       hooks:
           - id: bibsync-bin
             args:

{bibsync-0.4.2 → bibsync-0.4.3}/pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 dynamic = ["version"]
 
 [dependency-groups]
-dev = ["pytest>=9.1.1", "ruff>=0.15.20", "prek>=0.4.6"]
+dev = ["pytest>=9.1.1", "ruff>=0.15.20", "prek>=0.4.8"]
 build = ["maturin>=1.14.1,<2"]
 
 [project.urls]

{bibsync-0.4.2 → bibsync-0.4.3}/uv.lock

@@ -21,7 +21,7 @@ dev = [
 [package.metadata.requires-dev]
 build = [{ name = "maturin", specifier = ">=1.14.1,<2" }]
 dev = [
-    { name = "prek", specifier = ">=0.4.6" },
+    { name = "prek", specifier = ">=0.4.8" },
     { name = "pytest", specifier = ">=9.1.1" },
     { name = "ruff", specifier = ">=0.15.20" },
 ]

bibsync-0.4.2/.pre-commit-hooks.yaml

@@ -1,12 +0,0 @@
-- id: bibsync
-  name: bibsync
-  description: Synchronize BibTeX entries from TeX citation keys
-  entry: bibsync
-  language: rust
-  types_or: [tex, bib]
-- id: bibsync-bin
-  name: bibsync
-  description: Synchronize BibTeX entries using a pre-built release binary
-  entry: scripts/pre-commit-bibsync
-  language: script
-  types_or: [tex, bib]