Add hook, badge and license info

.pre-commit-hook.yaml

@@ -0,0 +1,10 @@
+- id: mdformat-hallmark
+  name: mdformat-hallmark
+  description: "CommonMark compliant Markdown formatter"
+  entry: mdformat
+  language: python
+  types: [markdown]
+  minimum_pre_commit_version: '1.0.0'
+  additional_dependencies:
+  - [email protected]
+  - mdformat-hallmark

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2025 Executable Books
+Copyright (c) 2020 Executable Books
+Copyright (c) 2025 Callan Gray
 
 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

@@ -1,10 +1,34 @@
 # mdformat-hallmark
 
 [![Build Status](https://github.com/calgray/mdformat-hallmark/actions/workflows/tests.yml/badge.svg?branch=master)](<https://github.com/calgray/mdformat-hallmark/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush>)
-[![codecov.io](https://codecov.io/gh/calgray/mdformat-hallmark/branch/main/graph/badge.svg)](https://codecov.io/gh/xarray-contrib/astropy-xarray)
+[![codecov.io](https://codecov.io/gh/calgray/mdformat-hallmark/branch/master/graph/badge.svg)](https://codecov.io/gh/calgray/mdformat-hallmark)
 [![PyPI version](https://badge.fury.io/py/mdformat-hallmark.svg)](<https://badge.fury.io/py/mdformat-hallmark>)
 
-An [mdformat](https://github.com/executablebooks/mdformat) plugin for compatibility with [hallmark](https://github.com/vweevers/hallmark) formatted Markdown and [Common Changelog](https://common-changelog.org/).
+An [mdformat](https://github.com/executablebooks/mdformat) plugin for compatibility with [hallmark](https://github.com/vweevers/hallmark) formatted Markdown and [Common Changelog](https://common-changelog.org/) that allows both formatters and linters to simultaneously pass for quality assurance.
+
+## Features
+
+- `hallmark` style reference formatting for changelogs with blank lines and sort by semantic version.
+
+## Install
+
+Install with:
+
+```sh
+pip install mdformat-hallmark
+```
+
+## CLI Usage
+
+After installing the plugin, run `mdformat` for Markdown files including Common Changelog files.
+
+```sh
+# with extension detected automatically
+mdformat README.md CHANGELOG.md
+
+# with extension explicitly required
+mdformat --extensions hallmark README.md CHANGELOG.md
+```
 
 ## Development
 

mdformat_hallmark/hallmark_links_extension.py

@@ -20,12 +20,6 @@ class SemverReference:
     href: str
     title: str | None
 
-    def __str__(self):
-        line = f"[{self.label}]: {self.href}"
-        if self.title:
-            line += f' "{self.title}"'
-        return line
-
 
 def _extract_semver_references(src: str) -> tuple[list[SemverReference], str]:
     refs: list[SemverReference] = []

tests/fixtures.md

@@ -159,3 +159,48 @@ unsorted changelog test
 
 [0.0.1]: https://example.com
 .
+
+
+extra links changelog test
+.
+# Changelog
+
+## [1.0.0] - 2025-01-01
+
+### Added
+
+- Commit [JIRA-2]
+
+## [1.1.0] - 2025-01-01
+
+### Added
+
+- Commit [JIRA-1]
+
+[JIRA-2]: https://example.com
+[JIRA-1]: https://example.com
+
+[2.10.0]: https://example.com
+[10.1.0]: https://example.com
+.
+# Changelog
+
+## [1.0.0] - 2025-01-01
+
+### Added
+
+- Commit [JIRA-2]
+
+## [1.1.0] - 2025-01-01
+
+### Added
+
+- Commit [JIRA-1]
+
+[10.1.0]: https://example.com
+
+[2.10.0]: https://example.com
+
+[jira-1]: https://example.com
+[jira-2]: https://example.com
+.

tests/test_fixtures.py

@@ -13,5 +13,4 @@
 )
 def test_fixtures(line, title, text, expected):
     output = mdformat.text(text, extensions={"hallmark"})
-    # output = mdformat.text(text, codeformatters={"python"})
     assert output.rstrip() == expected.rstrip(), output