hongdown 0.3.0-dev.88 → 0.3.0

package/README.md

@@ -161,9 +161,43 @@ These directives are merged with configuration file settings.
 
 ### Configuration file
 
-Hongdown looks for a *.hongdown.toml* file in the current directory and
-parent directories.  You can also specify a configuration file explicitly
-with the `--config` option.
+Hongdown supports cascading configuration files from multiple locations.
+Configuration files are loaded and merged in the following order (lowest to
+highest priority):
+
+1.  **System-wide**: */etc/hongdown/config.toml* (Linux/Unix only)
+2.  **User (legacy)**: *~/.hongdown.toml* (all platforms)
+3.  **User (platform-specific)**:
+     -  Linux: *$XDG\_CONFIG\_HOME/hongdown/config.toml* or
+        *~/.config/hongdown/config.toml*
+     -  macOS: *~/Library/Application Support/hongdown/config.toml*
+     -  Windows: *%APPDATA%\\hongdown\\config.toml*
+4.  **Project**: *.hongdown.toml* in the current directory or any parent
+    directory
+
+Settings from higher-priority configurations override those from lower-priority
+ones.  This allows you to set global defaults at the user or system level while
+overriding them for specific projects.
+
+You can also specify a configuration file explicitly with the `--config` option,
+which bypasses the cascading system and uses only that file.
+
+#### Disabling configuration inheritance
+
+To ignore all system and user configurations and use only your project config:
+
+~~~~ toml
+no_inherit = true
+
+# Your project-specific settings
+line_width = 100
+~~~~
+
+When `no_inherit = true`, only the project config and Hongdown's defaults are
+used.  This is useful for projects that need strict formatting control
+regardless of user preferences.
+
+#### Configuration options
 
 Below is an example configuration with all available options and their
 default values:
@@ -172,9 +206,10 @@ default values:
 # File patterns (glob syntax)
 include = []              # Files to format (default: none, specify on CLI)
 exclude = []              # Files to skip (default: none)
+git_aware = true          # Respect .gitignore and skip .git directory (default: true)
 
 # Formatting options
-line_width = 80           # Maximum line width (default: 80)
+line_width = 80           # Maximum line width (min: 8, default: 80)
 
 [heading]
 setext_h1 = true          # Use === underline for h1 (default: true)
@@ -183,21 +218,21 @@ sentence_case = false     # Convert headings to sentence case (default: false)
 proper_nouns = []         # Additional proper nouns to preserve (default: [])
 common_nouns = []         # Exclude built-in proper nouns (default: [])
 
-[list]
+[unordered_list]
 unordered_marker = "-"    # "-", "*", or "+" (default: "-")
-leading_spaces = 1        # Spaces before marker (default: 1)
-trailing_spaces = 2       # Spaces after marker (default: 2)
-indent_width = 4          # Indentation for nested items (default: 4)
+leading_spaces = 1        # Spaces before marker (0–3, default: 1)
+trailing_spaces = 2       # Spaces after marker (0–3, default: 2)
+indent_width = 4          # Indentation for nested items (min: 1, default: 4)
 
 [ordered_list]
 odd_level_marker = "."    # "." or ")" at odd nesting levels (default: ".")
 even_level_marker = ")"   # "." or ")" at even nesting levels (default: ")")
 pad = "start"             # "start" or "end" for number alignment (default: "start")
-indent_width = 4          # Indentation for nested items (default: 4)
+indent_width = 4          # Indentation for nested items (min: 1, default: 4)
 
 [code_block]
 fence_char = "~"          # "~" or "`" (default: "~")
-min_fence_length = 4      # Minimum fence length (default: 4)
+min_fence_length = 4      # Minimum fence length (min: 3, default: 4)
 space_after_fence = true  # Space between fence and language (default: true)
 default_language = ""     # Default language for code blocks (default: "")
 
@@ -206,8 +241,9 @@ default_language = ""     # Default language for code blocks (default: "")
 # javascript = ["deno", "fmt", "--ext=js", "-"]
 
 [thematic_break]
+# Must be valid CommonMark: at least 3 of *, -, or _ (with optional spaces)
 style = "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"
-leading_spaces = 3        # Leading spaces (0-3, default: 3)
+leading_spaces = 3        # Leading spaces (0–3, default: 3)
 
 [punctuation]
 curly_double_quotes = true   # "text" to "text" (default: true)
@@ -218,6 +254,14 @@ en_dash = false              # Disabled by default (use "--" to enable)
 em_dash = "--"               # -- to --- (default: "--", use false to disable)
 ~~~~
 
+Configuration values are validated at parse time.  Invalid values will produce
+descriptive error messages:
+
+~~~~ bash
+$ hongdown --config invalid.toml input.md
+Error: failed to parse configuration file: line_width must be at least 8, got 5.
+~~~~
+
 When `include` patterns are configured, you can run Hongdown without
 specifying files:
 
@@ -479,6 +523,21 @@ null_ls.register(hongdown)
 [none-ls.nvim]: https://github.com/nvimtools/none-ls.nvim
 [Vladimir Rubin]: https://github.com/dahlia/hongdown/issues/4
 
+### Helix
+
+If you use [Helix], you can register Hongdown as a formatter (contributed by
+[Jean Simard]):
+
+~~~~ toml
+[[language]]
+name = "markdown"
+auto-format = true
+formatter = { command = "hongdown", args = ["--stdin"] }
+~~~~
+
+[Helix]: https://helix-editor.com/
+[Jean Simard]: https://github.com/dahlia/hongdown/pull/12
+
 
 Library usage
 -------------

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hongdown",
-    "version": "0.3.0-dev.88+6570e7cb",
+    "version": "0.3.0",
     "type": "module",
     "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
     "license": "GPL-3.0-or-later",
@@ -27,11 +27,11 @@
         "node": "\u003e=18"
     },
     "optionalDependencies": {
-        "@hongdown/darwin-arm64": "0.3.0-dev.88+6570e7cb",
-        "@hongdown/darwin-x64": "0.3.0-dev.88+6570e7cb",
-        "@hongdown/linux-arm64": "0.3.0-dev.88+6570e7cb",
-        "@hongdown/linux-x64": "0.3.0-dev.88+6570e7cb",
-        "@hongdown/win32-arm64": "0.3.0-dev.88+6570e7cb",
-        "@hongdown/win32-x64": "0.3.0-dev.88+6570e7cb"
+        "@hongdown/darwin-arm64": "0.3.0",
+        "@hongdown/darwin-x64": "0.3.0",
+        "@hongdown/linux-arm64": "0.3.0",
+        "@hongdown/linux-x64": "0.3.0",
+        "@hongdown/win32-arm64": "0.3.0",
+        "@hongdown/win32-x64": "0.3.0"
     }
 }