mdrefine 0.2.0-rc.3 → 0.2.1

package/docs/design.md

@@ -63,6 +63,11 @@ The comparison is only as good as the parser's reading:
   and `style/block-spacing` leave text whose second line is a table delimiter
   row as written ([issue
   #283](https://github.com/viell-dev/slop-markdown-tools/issues/283)).
+- Front matter needs a closing line. A first line of `---` or `+++` that no
+  later line closes is read as renderers read it, as a thematic break or text,
+  with the lists and block quotes below it; the parser's front matter extension
+  reads them as paragraphs there, so the tool leaves it out for such a document
+  ([issue #278](https://github.com/viell-dev/slop-markdown-tools/issues/278)).
 - Front matter ends at the next `---` or `+++` line, also one inside a code
   block, for the parser, for site generators, and for GitHub's file view when
   the front matter is a YAML mapping. GitHub's comments, and renderers without

package/docs/dialects.md

@@ -20,7 +20,8 @@ what is text, and so what formatting has to leave alone. Choose it in the
 | Wikilinks, embeds, highlights (`==…==`), comments (`%%…%%`), `^block-ids` | No         | No     | No      | No    | Yes      |
 
 GitHub's syntax is the common base of the Forgejo, Gitea, and Obsidian dialects,
-and the rules for GitHub Markdown apply to all three. The syntax that only
+and the rules for GitHub Markdown apply to all three. Obsidian marks
+strikethrough with two tildes only, so `~a~` is text there. The syntax that only
 Forgejo and Gitea have is protected from formatting rather than parsed; see
 [Forgejo and Gitea](#forgejo-and-gitea). Syntax that no dialect knows, such as
 an Obsidian plugin's, is read as text: use a suppression comment or an `ignore`

package/docs/integrations.md

@@ -31,7 +31,10 @@ it runs, and adds what the commands changed to the commit, configure it in
 ```json
 {
   "lint-staged": {
-    "*.{md,markdown}": ["mdtools format --write", "mdtools lint --max-warnings 0"]
+    "*.{md,markdown}": [
+      "mdtools format --write --no-warn-ignored",
+      "mdtools lint --max-warnings 0 --no-warn-ignored"
+    ]
   }
 }
 ```
@@ -43,9 +46,12 @@ the commit adds or changes:
 ```sh
 #!/bin/sh
 git diff --cached --name-only -z --diff-filter=ACMR -- '*.md' '*.markdown' |
-  xargs -0 -r npx mdtools lint --max-warnings 0 --
+  xargs -0 -r npx mdtools lint --max-warnings 0 --no-warn-ignored --
 ```
 
+In both, `--no-warn-ignored` leaves out the
+[warning](cli.md#which-files-are-processed) for a changed file that the tool
+skips, such as one that the configuration's `ignore` patterns match.
 `--diff-filter=ACMR` leaves out deleted files, which would be an error as paths.
 `xargs -r` skips the command when no file changed. `--` keeps a file name that
 starts with `-` from being read as an option. This hook checks each file as it

package/docs/quick-start.md

@@ -6,7 +6,7 @@ mdrefine needs Node.js 22.12 or newer. Install the package in the project that
 holds your documents:
 
 ```sh
-npm install --save-dev --save-exact mdrefine@0.2.0-rc.3
+npm install --save-dev --save-exact mdrefine@0.2.1
 npx --no-install mdtools --help
 ```
 

package/docs/rules.md

@@ -761,6 +761,13 @@ so are the exceptions of [Forgejo and Gitea](dialects.md#forgejo-and-gitea):
   the dollar decides whether dollar math ends there.
 - Emphasis that begins on the line of an alert's or a callout's marker and ends
   below it.
+- Emphasis whose text holds a run of tildes that could mark strikethrough, one
+  or two tildes or in Obsidian two, while the paragraph holds another: GitHub
+  can read strikethrough there and the markers as text.
+- A `_`, old or new, that only tildes separate from a letter or digit, as in
+  `x~~_b_~~`, which GitHub reads as inside a word.
+- Text whose markers CommonMark pairs otherwise than the parser, as in
+  `xab***a* a*y`: GitHub follows CommonMark, so the parser misread the text.
 
 ## `style/final-newline`
 
@@ -825,7 +832,9 @@ because directly below text its line would continue the paragraph. It keeps its
 `#` when its text starts like another block, such as a list item, block quote,
 thematic break, fence, HTML, or link reference definition, when it contains `|`,
 which `---` below it could make a table, or when it ends with a backslash, and
-on Forgejo and Gitea when it contains `{`.
+on Forgejo and Gitea when it contains `{`. Below a first line of `---` that no
+line closes, a level-2 underline has at least four `-`, because `---` would
+close it as front matter.
 
 ## `style/inline-code`
 
@@ -1100,8 +1109,11 @@ means:
   `---` would underline as a heading.
 - On the line of a list item whose marker is the new marker's character, as in
   `- ***` with `---`: `- ---` is one thematic break, not a list item.
-- At the start of a document, where a break that is or would become `---` is
-  read as the start of front matter.
+- At the start of a document, with `---`, which would open front matter if a
+  later line of `---` closed it, and a `---` that site generators read as the
+  start of front matter.
+- With `---`, at the start of a line below a first line of `---` that no line
+  closes, which `---` would close as front matter.
 
 ## `style/trailing-space`
 
@@ -1149,7 +1161,9 @@ span, an image, math, a link's destination, a template tag on one line such as
 `{% data x %}` or `{{ title }}`, and a word longer than the line stay whole and
 can overflow; a code span or an image description written across lines is joined
 onto one, without the spaces and tabs that start its next line, as renderers
-read it. List markers, block quote markers, and indentation count toward the
+read it. In Obsidian, the text of a link stays whole and is joined onto one line
+too, because Live Preview shows a link whose text spans lines as its Markdown
+source. List markers, block quote markers, and indentation count toward the
 width, a tab up to the next multiple of four columns.
 
 A word that would start a block at the start of a line, such as a list marker,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdrefine",
-  "version": "0.2.0-rc.3",
+  "version": "0.2.1",
   "description": "Configurable Markdown linting and formatting for CommonMark, GitHub, Forgejo, Gitea, and Obsidian",
   "keywords": [
     "markdown",
@@ -37,7 +37,7 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/",
-    "tag": "rc"
+    "tag": "latest"
   },
   "exports": {
     ".": {