mdrefcheck 0.1.5__tar.gz → 0.1.6__tar.gz

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/.github/workflows/ci.yml

@@ -178,7 +178,7 @@ jobs:
         with:
           name: Release ${{ github.ref_name }}
           tag_name: ${{ github.ref_name }}
-          body_path: CHANGELOG.md
+          generate_release_notes: true
           files: wheels-*/*
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

mdrefcheck-0.1.6/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: mdrefcheck
+  name: mdrefcheck
+  description: Validate references in Markdown files
+  entry: mdrefcheck
+  language: python
+  types: [markdown]
+  args: []

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/Cargo.lock

@@ -145,7 +145,7 @@ checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
 
 [[package]]
 name = "mdrefcheck"
-version = "0.1.5"
+version = "0.1.6"
 dependencies = [
  "clap",
  "colored",

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mdrefcheck"
-version = "0.1.5"
+version = "0.1.6"
 edition = "2024"
 readme = "README.md"
 description = "A CLI tool to validate references in markdown files."

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mdrefcheck
-Version: 0.1.5
+Version: 0.1.6
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -21,10 +21,8 @@ Project-URL: Repository, https://github.com/gospodima/mdrefcheck
 
 # mdrefcheck
 
-**mdrefcheck** is a CLI tool to validate references and links in Markdown files (CommonMark spec).  
-It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.
-
----
+A CLI tool to validate references and links in Markdown files (CommonMark spec).  
+It helps to ensure that your documentation is free from broken section links, missing images or files.
 
 ## Features
 
@@ -33,13 +31,42 @@ It helps ensure that your documentation is free from broken links, missing image
 - Identify broken reference-style links
 - Email validation
 
----
-
 ## Installation
 
-From PyPI:
+### Cargo
+
+`mdrefcheck` is also published on [crates.io](https://crates.io/) and can be installed 
+with cargo:
+
+```bash
+cargo install mdrefcheck
+```
+
+### PyPI
+
+`mdrefcheck` can be installed with
 
 ```bash
 pip install mdrefcheck
 ```
 
+It also can be used as a tool in an isolated environment, e.g., with `uvx`:
+
+```bash
+uvx mdrefcheck .
+```
+
+### Pre-commit integration
+
+You can use `mdrefcheck` as a pre-commit hook.
+
+Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/gospodima/mdrefcheck
+    rev: v0.1.6
+    hooks:
+      - id: mdrefcheck
+```
+

mdrefcheck-0.1.6/README.md

@@ -0,0 +1,50 @@
+# mdrefcheck
+
+A CLI tool to validate references and links in Markdown files (CommonMark spec).  
+It helps to ensure that your documentation is free from broken section links, missing images or files.
+
+## Features
+
+- Validate local file paths in image and section references
+- Check section links (`#heading-link`) match existing headings according to [GitHub Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links) rules
+- Identify broken reference-style links
+- Email validation
+
+## Installation
+
+### Cargo
+
+`mdrefcheck` is also published on [crates.io](https://crates.io/) and can be installed 
+with cargo:
+
+```bash
+cargo install mdrefcheck
+```
+
+### PyPI
+
+`mdrefcheck` can be installed with
+
+```bash
+pip install mdrefcheck
+```
+
+It also can be used as a tool in an isolated environment, e.g., with `uvx`:
+
+```bash
+uvx mdrefcheck .
+```
+
+### Pre-commit integration
+
+You can use `mdrefcheck` as a pre-commit hook.
+
+Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/gospodima/mdrefcheck
+    rev: v0.1.6
+    hooks:
+      - id: mdrefcheck
+```

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mdrefcheck"
-version = "0.1.5"
+version = "0.1.6"
 description = "A CLI tool to validate references in markdown files."
 readme = "README.md"
 authors = [

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/release.toml

@@ -1,4 +1,5 @@
 pre-release-replacements = [
-    {file="pyproject.toml", search='version = "[a-z0-9\\.-]+"', replace='version = "{{version}}"'}
+    {file="pyproject.toml", search='version = "[a-z0-9\\.-]+"', replace='version = "{{version}}"'},
+    {file="README.md", search='rev: v[a-z0-9\\.-]+', replace='rev: v{{version}}'}
 ]
 pre-release-commit-message = "chore(release): prepare for {{version}}"

{mdrefcheck-0.1.5 → mdrefcheck-0.1.6}/src/config.rs

@@ -3,11 +3,9 @@ use std::path::PathBuf;
 use clap::Parser;
 use regex::Regex;
 
-// TODO: add dir exclusion similar to files
-
 /// CLI configuration for mdrefcheck
 #[derive(Parser, Debug)]
-#[command(name = "mdrefcheck", about = "Check markdown references.")]
+#[command(name = "mdrefcheck", about = "Check markdown references.", version)]
 pub struct CliConfig {
     /// Paths to check
     #[arg(required = true, value_name = "PATH")]

mdrefcheck-0.1.5/CHANGELOG.md

@@ -1,54 +0,0 @@
-# Changelog
-
-## [0.1.4] - 2025-09-14
-
-### CI
-
-- Move cargo pyblish before artifacts staff
-
-## [0.1.3] - 2025-09-14
-
-### CI
-
-- Put artifacts outside of repo to prevent dirty issues
-
-## [0.1.3] - 2025-09-14
-
-### CI
-
-- Remove dist folder nesting on release
-
-## [0.1.2] - 2025-09-14
-
-### Documentation
-
-- Adjust repo and home links to github
-
-### CI
-
-- Fix release steps
-
-## [0.1.1] - 2025-09-14
-
-### Documentation
-
-- Define manual changelog file
-
-### Other
-
-- Upgrade deps
-
-### Miscellaneous Tasks
-
-- Adjust pre-release-commit-message
-
-## [0.1.0] - 2025-07-06
-
-### Features
-
-- Initial commit
-
-### Miscellaneous Tasks
-
-- Initial pipeline, release, LICENSE
-

mdrefcheck-0.1.5/README.md

@@ -1,23 +0,0 @@
-# mdrefcheck
-
-**mdrefcheck** is a CLI tool to validate references and links in Markdown files (CommonMark spec).  
-It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.
-
----
-
-## Features
-
-- Validate local file paths in image and section references
-- Check section links (`#heading-link`) match existing headings according to [GitHub Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links) rules
-- Identify broken reference-style links
-- Email validation
-
----
-
-## Installation
-
-From PyPI:
-
-```bash
-pip install mdrefcheck
-```