hongdown 0.1.0-dev.8 → 0.1.0

package/README.md

@@ -5,11 +5,11 @@ Hongdown
 [![npm][npm badge]][npm]
 [![GitHub Actions][GitHub Actions badge]][GitHub Actions]
 
-Hongdown is a Markdown formatter that enforces [Hong Minhee's Markdown style]
-conventions.  The formatter is implemented in Rust using the [Comrak] library
-for parsing.  It produces consistently formatted Markdown output following
-a distinctive style used across multiple projects including [Fedify], [LogTape],
-and [Optique].
+Hongdown is a Markdown formatter that enforces [Hong Minhee's Markdown
+style](./STYLE.md) conventions.  The formatter is implemented in Rust using
+the [Comrak] library for parsing.  It produces consistently formatted Markdown
+output following a distinctive style used across multiple projects including
+[Fedify], [LogTape], and [Optique].
 
 [crates.io badge]: https://img.shields.io/crates/v/hongdown?logo=rust
 [crates.io]: https://crates.io/crates/hongdown
@@ -17,7 +17,6 @@ and [Optique].
 [npm]: https://www.npmjs.com/package/hongdown
 [GitHub Actions badge]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml/badge.svg
 [GitHub Actions]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml
-[Hong Minhee's Markdown style]: ./AGENTS.md#markdown-style-guide
 [Comrak]: https://comrak.ee/
 [Fedify]: https://fedify.dev/
 [LogTape]: https://logtape.org/
@@ -36,7 +35,7 @@ npm install -g hongdown
 ### mise
 
 ~~~~ bash
-mise use github:dahlia/hongdown
+mise use -g github:dahlia/hongdown
 ~~~~
 
 ### Cargo
@@ -77,9 +76,11 @@ hongdown -c input.md
 hongdown --diff input.md
 hongdown -d input.md
 
-# Read from stdin
-echo "# Hello" | hongdown
+# Read from stdin (use --stdin flag or - as filename)
+echo "# Hello" | hongdown --stdin
+echo "# Hello" | hongdown -
 hongdown --stdin < input.md
+hongdown - < input.md
 
 # Custom line width
 hongdown --line-width 100 input.md
@@ -122,38 +123,46 @@ This section is formatted again.
 
 ### Configuration file
 
-Hongdown looks for a `.hongdown.toml` file in the current directory and
+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.
 
+Below is an example configuration with all available options and their
+default values:
+
 ~~~~ toml
 # File patterns (glob syntax)
-include = ["*.md", "docs/**/*.md"]  # Files to format
-exclude = ["node_modules/**"]        # Files to skip
+include = []              # Files to format (default: none, specify on CLI)
+exclude = []              # Files to skip (default: none)
 
 # Formatting options
-line_width = 80
+line_width = 80           # Maximum line width (default: 80)
 
 [heading]
-setext_h1 = true          # Use === underline for h1
-setext_h2 = true          # Use --- underline for h2
+setext_h1 = true          # Use === underline for h1 (default: true)
+setext_h2 = true          # Use --- underline for h2 (default: true)
 
 [list]
-unordered_marker = "-"    # "-", "*", or "+"
-leading_spaces = 1        # Spaces before marker
-trailing_spaces = 2       # Spaces after marker
-indent_width = 4          # Indentation for nested items
+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)
 
 [ordered_list]
-odd_level_marker = "."    # "1." at odd nesting levels
-even_level_marker = ")"   # "1)" at even nesting levels
-pad = "start"             # "start" or "end" for number alignment
-indent_width = 4          # Indentation for nested items
+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)
 
 [code_block]
-fence_char = "~"          # "~" or "`"
-min_fence_length = 4      # Minimum fence length
-space_after_fence = true  # Space between fence and language
+fence_char = "~"          # "~" or "`" (default: "~")
+min_fence_length = 4      # Minimum fence length (default: 4)
+space_after_fence = true  # Space between fence and language (default: true)
+default_language = ""     # Default language for code blocks (default: "")
+
+[thematic_break]
+style = "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"
+leading_spaces = 3        # Leading spaces (0-3, default: 3)
 ~~~~
 
 When `include` patterns are configured, you can run Hongdown without
@@ -207,7 +216,7 @@ Section
 ~~~~ markdown
  -  First item
  -  Second item
-    -  Nested item
+     -  Nested item
 ~~~~
 
 ### Code blocks
@@ -246,9 +255,8 @@ See the [documentation] for more details.
  -  Pipes are aligned accounting for East Asian wide characters
  -  Minimum column width is maintained
 
-See [SPEC.md] for the complete style specification.
-
-[SPEC.md]: SPEC.md
+See *[STYLE.md](./STYLE.md)* for the complete style specification, including
+the philosophy behind these conventions and detailed formatting rules.
 
 
 Library usage
@@ -266,6 +274,43 @@ println!("{}", output);
 ~~~~
 
 
+Development
+-----------
+
+This project uses [mise] for task management.
+
+[mise]: https://mise.jdx.dev/
+
+### Initial setup
+
+After cloning the repository, set up the Git pre-commit hook to automatically
+run quality checks before each commit:
+
+~~~~ bash
+mise generate git-pre-commit --task=check --write
+~~~~
+
+### Quality checks
+
+The following tasks are available:
+
+~~~~ bash
+# Run all quality checks
+mise run check
+
+# Individual checks
+mise run check:clippy     # Run clippy linter
+mise run check:fmt        # Check code formatting
+mise run check:type       # Run Rust type checking
+mise run check:markdown   # Check Markdown formatting
+~~~~
+
+See *[AGENTS.md]* for detailed development guidelines including TDD
+practices, code style conventions, and commit message guidelines.
+
+[AGENTS.md]: ./AGENTS.md
+
+
 Etymology
 ---------
 

package/package.json

@@ -1,37 +1,37 @@
 {
-  "name": "hongdown",
-  "version": "0.1.0-dev.8+4f6b2b27",
-  "type": "module",
-  "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
-  "license": "GPL-3.0-or-later",
-  "author": "Hong Minhee <hong@minhee.org>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dahlia/hongdown.git"
-  },
-  "homepage": "https://github.com/dahlia/hongdown",
-  "keywords": [
-    "markdown",
-    "formatter",
-    "linter",
-    "style"
-  ],
-  "bin": {
-    "hongdown": "bin/hongdown.js"
-  },
-  "files": [
-    "bin/",
-    "README.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "optionalDependencies": {
-    "@hongdown/darwin-arm64": "0.1.0-dev.8+4f6b2b27",
-    "@hongdown/darwin-x64": "0.1.0-dev.8+4f6b2b27",
-    "@hongdown/linux-arm64": "0.1.0-dev.8+4f6b2b27",
-    "@hongdown/linux-x64": "0.1.0-dev.8+4f6b2b27",
-    "@hongdown/win32-arm64": "0.1.0-dev.8+4f6b2b27",
-    "@hongdown/win32-x64": "0.1.0-dev.8+4f6b2b27"
-  }
+    "name": "hongdown",
+    "version": "0.1.0",
+    "type": "module",
+    "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
+    "license": "GPL-3.0-or-later",
+    "author": "Hong Minhee \u003chong@minhee.org\u003e",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dahlia/hongdown.git"
+    },
+    "homepage": "https://github.com/dahlia/hongdown",
+    "keywords": [
+        "markdown",
+        "formatter",
+        "linter",
+        "style"
+    ],
+    "bin": {
+        "hongdown": "bin/hongdown.js"
+    },
+    "files": [
+        "bin/",
+        "README.md"
+    ],
+    "engines": {
+        "node": "\u003e=18"
+    },
+    "optionalDependencies": {
+        "@hongdown/darwin-arm64": "0.1.0",
+        "@hongdown/darwin-x64": "0.1.0",
+        "@hongdown/linux-arm64": "0.1.0",
+        "@hongdown/linux-x64": "0.1.0",
+        "@hongdown/win32-arm64": "0.1.0",
+        "@hongdown/win32-x64": "0.1.0"
+    }
 }