rumdl 0.0.147__tar.gz → 0.0.151__tar.gz

{rumdl-0.0.147 → rumdl-0.0.151}/Cargo.lock

@@ -1644,7 +1644,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rumdl"
-version = "0.0.147"
+version = "0.0.151"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -1675,6 +1675,7 @@ dependencies = [
  "rand",
  "rayon",
  "regex",
+ "schemars",
  "seahash",
  "serde",
  "serde_json",
@@ -1750,6 +1751,30 @@ dependencies = [
  "winapi-util",
 ]
 
+[[package]]
+name = "schemars"
+version = "0.8.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3fbf2ae1b8bc8e02df939598064d22402220cd5bbcca1c76f7d6a310974d5615"
+dependencies = [
+ "dyn-clone",
+ "schemars_derive",
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "schemars_derive"
+version = "0.8.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32e265784ad618884abaea0600a9adf15393368d840e0222d101a072f3f7534d"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "serde_derive_internals",
+ "syn",
+]
+
 [[package]]
 name = "scopeguard"
 version = "1.2.0"
@@ -1792,6 +1817,17 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "serde_derive_internals"
+version = "0.29.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "serde_json"
 version = "1.0.145"

{rumdl-0.0.147 → rumdl-0.0.151}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.147"
+version = "0.0.151"
 edition = "2024"
 rust-version = "1.89.0"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"
@@ -106,6 +106,7 @@ url = { version = "2", features = ["serde"] }
 unicode-normalization = "0.1"
 memmap2 = "0.9"
 seahash = "4.1"
+schemars = "0.8"
 
 # LSP dependencies
 tower-lsp = "0.20"

{rumdl-0.0.147 → rumdl-0.0.151}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.147
+Version: 0.0.151
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -619,6 +619,27 @@ rumdl check .
 rumdl check --isolated .
 ```
 
+### Editor Support (JSON Schema)
+
+rumdl provides a JSON Schema for `.rumdl.toml` configuration files, enabling autocomplete, validation, and inline documentation in supported editors like VS Code, IntelliJ IDEA, and others.
+
+The schema is available at `https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json`.
+
+**VS Code Setup:**
+
+1. Install the "Even Better TOML" extension
+2. The schema will be automatically associated with `.rumdl.toml` and `rumdl.toml` files once submitted to SchemaStore
+
+**Manual Schema Association:**
+
+Add this to your `.rumdl.toml` file (in a comment, as TOML doesn't support `$schema`):
+
+```toml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json
+```
+
+This enables IntelliSense, validation, and hover documentation for all configuration options.
+
 ### Global Configuration
 
 When no project configuration is found, rumdl will check for a user-level configuration file in your platform's standard config directory:

{rumdl-0.0.147 → rumdl-0.0.151}/README.md

@@ -590,6 +590,27 @@ rumdl check .
 rumdl check --isolated .
 ```
 
+### Editor Support (JSON Schema)
+
+rumdl provides a JSON Schema for `.rumdl.toml` configuration files, enabling autocomplete, validation, and inline documentation in supported editors like VS Code, IntelliJ IDEA, and others.
+
+The schema is available at `https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json`.
+
+**VS Code Setup:**
+
+1. Install the "Even Better TOML" extension
+2. The schema will be automatically associated with `.rumdl.toml` and `rumdl.toml` files once submitted to SchemaStore
+
+**Manual Schema Association:**
+
+Add this to your `.rumdl.toml` file (in a comment, as TOML doesn't support `$schema`):
+
+```toml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json
+```
+
+This enables IntelliSense, validation, and hover documentation for all configuration options.
+
 ### Global Configuration
 
 When no project configuration is found, rumdl will check for a user-level configuration file in your platform's standard config directory:

{rumdl-0.0.147 → rumdl-0.0.151}/docs/md026.md

@@ -2,7 +2,7 @@
 
 ## What this rule does
 
-Removes unnecessary punctuation from the end of headings, while intelligently allowing question marks, exclamation points, and colons when they make sense.
+Removes trailing punctuation from the end of headings to maintain a clean, professional appearance. Question marks are allowed by default for FAQ-style headings.
 
 ## Why this matters
 
@@ -18,13 +18,13 @@ Removes unnecessary punctuation from the end of headings, while intelligently al
 ```markdown
 # Introduction
 
-## FAQ: Frequently Asked Questions
+## What is Markdown?
 
-### What is Markdown?
+### FAQ: Frequently Asked Questions
 
-#### Important!
+#### Step 1: Getting Started
 
-##### Step 1: Setup
+##### Chapter 2: Configuration
 ```
 
 ### ❌ Incorrect
@@ -37,6 +37,10 @@ Removes unnecessary punctuation from the end of headings, while intelligently al
 ## Random heading;
 
 ### This seems wrong,
+
+#### Important!
+
+##### Ending with colon:
 ```
 
 <!-- rumdl-enable MD026 -->
@@ -49,23 +53,30 @@ Removes unnecessary punctuation from the end of headings, while intelligently al
 ## Random heading
 
 ### This seems wrong
+
+#### Important
+
+##### Ending with colon
 ```
 
 ## Configuration
 
 ```yaml
 MD026:
-  punctuation: ".,;" # Characters to remove from heading endings (default: ".,;")
+  punctuation: ".,;:!" # Characters to remove from heading endings (default: ".,;:!")
+
+# To allow exclamation marks in headings, remove ! from the list:
+# MD026:
+#   punctuation: ".,;:"
 ```
 
 ## Automatic fixes
 
 This rule will:
 
-- Remove periods, commas, and semicolons from heading endings
-- Preserve question marks for questions ("What is Markdown?")
-- Keep exclamation points for emphasis ("Important!")
-- Allow colons in categorical headings ("Step 1: Setup", "FAQ: Common Questions")
+- Remove periods, commas, semicolons, colons, and exclamation marks from heading endings (default: `.,;:!`)
+- Preserve question marks for FAQ-style headings ("What is Markdown?")
+- You can customize the punctuation list if you want to allow certain characters
 
 ## Learn more
 

{rumdl-0.0.147 → rumdl-0.0.151}/docs/md041.md

@@ -74,10 +74,11 @@ MD041:
 
 ## Automatic fixes
 
-When enabled, this rule will:
+This rule does not provide automatic fixes. Adding a document title is a content decision that should be made by the author because:
 
-- Add a generic `# Title` heading at the beginning of documents that lack one
-- You should replace this with a meaningful title for your document
+- Generic placeholders like `# Title` provide no value and require manual replacement anyway
+- Some files intentionally don't have titles (includes, SUMMARY.md for MkDocs, partial content files, etc.)
+- The tool cannot determine an appropriate title from the document content
 
 ## Special cases
 

rumdl-0.0.151/rumdl.schema.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Config",
+  "description": "rumdl configuration for linting Markdown files. Rules can be configured individually using [MD###] sections with rule-specific options.",
+  "type": "object",
+  "properties": {
+    "global": {
+      "description": "Global configuration options",
+      "default": {
+        "disable": [],
+        "enable": [],
+        "exclude": [],
+        "fixable": [],
+        "flavor": "standard",
+        "force_exclude": false,
+        "include": [],
+        "line_length": 80,
+        "respect_gitignore": true,
+        "unfixable": []
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/GlobalConfig"
+        }
+      ]
+    },
+    "per-file-ignores": {
+      "description": "Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { \"README.md\": [\"MD033\"], \"docs/**/*.md\": [\"MD013\"] }",
+      "default": {},
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "definitions": {
+    "GlobalConfig": {
+      "description": "Global configuration options",
+      "type": "object",
+      "properties": {
+        "disable": {
+          "description": "Disabled rules",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "enable": {
+          "description": "Enabled rules",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "exclude": {
+          "description": "Files to exclude",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "fixable": {
+          "description": "Rules that are allowed to be fixed when --fix is used If specified, only these rules will be fixed",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "flavor": {
+          "description": "Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.) When set, adjusts parsing and validation rules for that specific Markdown variant",
+          "default": "standard",
+          "allOf": [
+            {
+              "$ref": "#/definitions/MarkdownFlavor"
+            }
+          ]
+        },
+        "force_exclude": {
+          "description": "Whether to enforce exclude and extend-exclude patterns even for paths that are passed explicitly. By default (false), rumdl will lint any paths passed in directly, even if they would typically be excluded. Setting this to true will cause rumdl to respect exclusions unequivocally. This is useful for pre-commit, which explicitly passes all changed files.",
+          "default": false,
+          "type": "boolean"
+        },
+        "include": {
+          "description": "Files to include",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "line_length": {
+          "description": "Global line length setting (used by MD013 and other rules if not overridden)",
+          "default": 80,
+          "type": "integer",
+          "format": "uint64",
+          "minimum": 0.0
+        },
+        "output_format": {
+          "description": "Output format for linting results (e.g., \"text\", \"json\", \"pylint\", etc.)",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "respect_gitignore": {
+          "description": "Respect .gitignore files when scanning directories",
+          "default": true,
+          "type": "boolean"
+        },
+        "unfixable": {
+          "description": "Rules that should never be fixed, even when --fix is used Takes precedence over fixable",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "MarkdownFlavor": {
+      "description": "Markdown flavor/dialect enumeration",
+      "oneOf": [
+        {
+          "description": "Standard Markdown without flavor-specific adjustments",
+          "type": "string",
+          "enum": [
+            "standard"
+          ]
+        },
+        {
+          "description": "MkDocs flavor with auto-reference support",
+          "type": "string",
+          "enum": [
+            "mkdocs"
+          ]
+        }
+      ]
+    },
+    "RuleConfig": {
+      "description": "Represents a rule-specific configuration",
+      "type": "object",
+      "additionalProperties": true
+    }
+  }
+}

{rumdl-0.0.147 → rumdl-0.0.151}/rumdl.toml.example

@@ -28,6 +28,18 @@ exclude = [
 # Respect .gitignore files when scanning directories
 respect_gitignore = true
 
+# Per-file rule ignores - disable specific rules for specific files or file patterns
+# Useful when certain files (like README.md) need different rules than the rest
+[per-file-ignores]
+# Disable inline HTML check for GitHub README (GitHub doesn't support all MkDocs extensions)
+"README.md" = ["MD033"]
+
+# Disable line length check for documentation with long code examples
+"docs/api/**/*.md" = ["MD013"]
+
+# Disable first line heading check for generated files
+"generated/**/*.md" = ["MD041"]
+
 # Rule-specific configurations
 [MD002]
 level = 1  # Expected level for first heading