👷 uv + taskfile

Author: juftin

.pre-commit-config.yaml

@@ -1,47 +1,48 @@
+# yaml-language-server: $schema=https://schemastore.org/pre-commit-config.json
 repos:
-    - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v6.0.0
-      hooks:
-          - id: trailing-whitespace
-            exclude: '\.ambr$'
-          - id: end-of-file-fixer
-          - id: check-yaml
-          - id: check-ast
-          - id: check-docstring-first
-          - id: check-merge-conflict
-          - id: mixed-line-ending
-
-    - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-      rev: v2.15.0
-      hooks:
-          - id: pretty-format-toml
-            args: [--autofix, --no-sort]
-
-    - repo: https://github.com/pre-commit/mirrors-prettier
-      rev: v4.0.0-alpha.8
-      hooks:
-          - id: prettier
-            args: [--print-width=88, --tab-width=4]
-            exclude: |
-                (?x)(
-                  docs/|
-                  PULL_REQUEST_TEMPLATE.md|
-                  .github/semantic_release/release_notes.hbs
-                )
-
-    - repo: local
-      hooks:
-          - id: ruff-format
-            name: format
-            description: Runs Code Auto-Formatters
-            entry: uv run ruff format
-            language: system
-            types:
-                - python
-          - id: ruff-check
-            name: lint
-            description: Runs Code Linters
-            entry: uv run ruff check --fix
-            language: system
-            types:
-                - python
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-ast
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+      - id: no-commit-to-branch
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.17.2
+    hooks:
+      - id: yamlfmt
+  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+    rev: v2.15.0
+    hooks:
+      - id: pretty-format-toml
+        args: [--autofix, --no-sort]
+  - repo: https://github.com/hukkin/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        args: ["--number"]
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+          - mdformat-ruff
+          - mdformat-config
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: format
+        description: Runs Code Auto-Formatters
+        entry: uv run ruff format
+        language: system
+        types:
+          - python
+      - id: ruff-check
+        name: lint
+        description: Runs Code Linters
+        entry: uv run ruff check --fix
+        language: system
+        types:
+          - python

docs/contributing.md

@@ -2,54 +2,54 @@
 
 ## Environment Setup
 
-This project requires two core dependencies: **[uv](https://docs.astral.sh/uv/)** (Python package
-manager) and **[Task](https://taskfile.dev/)** (task runner). Once both are installed, you can use
+This project requires two core dependencies: **[uv]** (Python package
+manager) and **[task]** (task runner). Once both are installed, you can use
 `task` to interact with the project for all development workflows.
 
 1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
 
-      ```shell
-      curl -LsSf https://astral.sh/uv/install.sh | sh
-      ```
+   ```shell
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   ```
 
-2. [Install Task](https://taskfile.dev/installation/)
+2. [Install task](https://taskfile.dev/installation/)
 
-      ```shell
-      sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d
-      ```
+   ```shell
+   sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d
+   ```
 
 3. Install project dependencies and list available tasks
 
-      ```shell
-      task install
-      ```
+   ```shell
+   task install
+   ```
 
 4. Optionally, activate the virtual environment created by `uv`:
 
-      ```shell
-      source .venv/bin/activate
-      ```
+   ```shell
+   source .venv/bin/activate
+   ```
 
 ## Using Task
 
 ### Task Cheat Sheet
 
-| Command Description        | Command           | Notes                                    |
-| -------------------------- | ----------------- | ---------------------------------------- |
-| Install Dependencies       | `task install`    | Installs project and dev dependencies |
-| Run Tests                  | `task test`       | Runs tests with `pytest`            |
-| Run Linting                | `task lint`       | Runs `ruff check`, formatting, and type checks |
-| Fix Code Issues            | `task fix`        | Auto-fixes issues with `ruff format` and `ruff check --fix` |
-| Run Formatting             | `task fmt`        | Runs `ruff format` code formatter       |
-| Run Type Checking          | `task check`      | Runs `mypy` static type checker          |
-| Build Project              | `task build`      | Builds project artifacts |
-| Update Dependencies        | `task lock`       | Regenerates `uv.lock` lockfile           |
-| Serve Documentation        | `task docs`       | Serves docs with `mkdocs`      |
-| Run Commands               | `task run -- <cmd>`| Runs arbitrary commands    |
+| Command Description | Command             | Notes                                   |
+| ------------------- | ------------------- | --------------------------------------- |
+| Install Project     | `task install`      | Installs project and dev dependencies   |
+| Run Tests           | `task test`         | Runs tests with `pytest`                |
+| Run Linting         | `task lint`         | Lints code with `ruff`                  |
+| Fix Code Issues     | `task fix`          | Formats and auto-fixes code with `ruff` |
+| Run Formatting      | `task fmt`          | Formats code with `ruff`                |
+| Run Type Checking   | `task check`        | Runs static analysis with `mypy`        |
+| Build Project       | `task build`        | Builds project artifacts                |
+| Update Dependencies | `task lock`         | Regenerates project lockfile            |
+| Serve Documentation | `task docs`         | Serves docs with `mkdocs`               |
+| Run Commands        | `task run -- <cmd>` | Runs arbitrary commands                 |
 
 ### Task Explanation
 
-Task is a task runner built in Go that aims to be simpler and easier to use than GNU Make.
+`task` is a task runner built in Go that aims to be simpler and easier to use than GNU Make.
 Task uses a `Taskfile.yaml` file to define tasks and their dependencies. This project
 uses Task to organize and run common development operations like testing, linting,
 building, and documentation generation.
@@ -86,7 +86,7 @@ task run -- python -m browsr --help
 ```
 
 You can also run tasks from subdirectories, and Task will automatically
-find and use the Taskfile.yaml from the project root.
+find and use the `Taskfile.yaml` from the project root.
 
 ## Committing Code
 
@@ -104,11 +104,11 @@ commit message emoji prefixes are the only ones to trigger new releases:
 
 | Emoji | Shortcode     | Description                 | Semver |
 | ----- | ------------- | --------------------------- | ------ |
-| 💥    | \:boom\:      | Introduce breaking changes. | Major  |
-| ✨    | \:sparkles\:  | Introduce new features.     | Minor  |
-| 🐛    | \:bug\:       | Fix a bug.                  | Patch  |
-| 🚑    | \:ambulance\: | Critical hotfix.            | Patch  |
-| 🔒    | \:lock\:      | Fix security issues.        | Patch  |
+| 💥    | `:boom:`      | Introduce breaking changes. | Major  |
+| ✨    | `:sparkles:`  | Introduce new features.     | Minor  |
+| 🐛    | `:bug:`       | Fix a bug.                  | Patch  |
+| 🚑    | `:ambulance:` | Critical hotfix.            | Patch  |
+| 🔒    | `:lock:`      | Fix security issues.        | Patch  |
 
 Most features can be squash merged into a single commit on a pull-request.
 When merging multiple commits, they will be summarized into a single release.
@@ -158,10 +158,11 @@ would create a branch named `1.2.x` and merge your changes into that branch.
 See the [semantic-release documentation] for more information about
 branch based releases and other advanced release cases.
 
-[pipx]: https://pypa.github.io/pipx/
-[pre-commit]: https://pre-commit.com/
-[gitmoji]: https://gitmoji.dev/
 [conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/
+[gitmoji]: https://gitmoji.dev/
+[pre-commit]: https://pre-commit.com/
 [semantic-release]: https://github.com/semantic-release/semantic-release
-[semantic-versioning]: https://semver.org/
 [semantic-release documentation]: https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches
+[semantic-versioning]: https://semver.org/
+[task]: https://github.com/go-task/task
+[uv]: https://github.com/astral-sh/uv

mkdocs.yaml

@@ -1,81 +1,81 @@
 # schema: https://squidfunk.github.io/mkdocs-material/schema.json
-
 site_name: browsr
 nav:
-    - browsr 🗂️: index.md
-    - Command Line Interface ⌨️: cli.md
-    - Contributing 🤝: contributing.md
-    - API Documentation 🤖: reference/
+  - browsr 🗂️: index.md
+  - Command Line Interface ⌨️: cli.md
+  - Contributing 🤝: contributing.md
+  - API Documentation 🤖: reference/
 theme:
-    favicon: https://raw.githubusercontent.com/juftin/browsr/main/docs/_static/browsr_no_label.png
-    logo: https://raw.githubusercontent.com/juftin/browsr/main/docs/_static/browsr_no_label.png
-    name: material
-    features:
-        - navigation.tracking
-        - content.code.annotate
-        - content.code.copy
-        - navigation.indexes
-    palette:
-        - media: "(prefers-color-scheme: light)"
-          scheme: default
-          accent: purple
-          toggle:
-              icon: material/weather-sunny
-              name: Switch to dark mode
-        - media: "(prefers-color-scheme: dark)"
-          scheme: slate
-          primary: black
-          toggle:
-              icon: material/weather-night
-              name: Switch to light mode
+  favicon: https://raw.githubusercontent.com/juftin/browsr/main/docs/_static/browsr_no_label.png
+  logo: https://raw.githubusercontent.com/juftin/browsr/main/docs/_static/browsr_no_label.png
+  name: material
+  features:
+    - navigation.tracking
+    - content.code.annotate
+    - content.code.copy
+    - navigation.indexes
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      accent: purple
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
 repo_url: https://github.com/juftin/browsr
 repo_name: browsr
 edit_uri: blob/main/docs/
 site_author: Justin Flannery
 remote_branch: gh-pages
 copyright: Copyright © 2023 Justin Flannery
 extra:
-    generator: false
+  generator: false
 exclude_docs: |
-    gen_pages.py
+  gen_pages.py
 markdown_extensions:
-    - toc:
-          permalink: "#"
-    - pymdownx.snippets
-    - pymdownx.magiclink
-    - attr_list
-    - md_in_html
-    - pymdownx.highlight:
-          anchor_linenums: true
-    - pymdownx.inlinehilite
-    - pymdownx.superfences
-    - markdown.extensions.attr_list
-    - pymdownx.keys
-    - pymdownx.tasklist
-    - pymdownx.tilde
-    - callouts
-    - pymdownx.details
-    - mkdocs-click
-    - pymdownx.emoji
-    - pymdownx.tabbed:
-          alternate_style: true
+  - toc:
+      permalink: "#"
+  - pymdownx.snippets
+  - pymdownx.magiclink
+  - sane_lists
+  - attr_list
+  - md_in_html
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - markdown.extensions.attr_list
+  - pymdownx.keys
+  - pymdownx.tasklist
+  - pymdownx.tilde
+  - callouts
+  - pymdownx.details
+  - mkdocs-click
+  - pymdownx.emoji
+  - pymdownx.tabbed:
+      alternate_style: true
 plugins:
-    - search
-    - markdown-exec
-    - autorefs
-    - gen-files:
-          scripts:
-              - docs/gen_ref_pages.py
-    - literate-nav:
-          nav_file: SUMMARY.md
-    - section-index:
-    - mkdocstrings:
-          handlers:
-              python:
-                  import:
-                      - https://docs.python.org/3/objects.inv
-                      - https://numpy.org/doc/stable/objects.inv
-                      - https://pandas.pydata.org/docs/objects.inv
-                  options:
-                      docstring_style: numpy
-                      filters: []
+  - search
+  - markdown-exec
+  - autorefs
+  - gen-files:
+      scripts:
+        - docs/gen_ref_pages.py
+  - literate-nav:
+      nav_file: SUMMARY.md
+  - section-index:
+  - mkdocstrings:
+      handlers:
+        python:
+          import:
+            - https://docs.python.org/3/objects.inv
+            - https://numpy.org/doc/stable/objects.inv
+            - https://pandas.pydata.org/docs/objects.inv
+          options:
+            docstring_style: numpy
+            filters: []