tonybaloney/markdownlint-rule-titlecase

Custom title case rule for markdownlint headers

markdownlint-rule-titlecase

Custom title case rule for markdownlint headers

Usage

Once installed using npm install markdownlint-rule-titlecase, run markdownlint with --rules "markdownlint-rule-titlecase":

$ markdownlint . --rules "markdownlint-rule-titlecase"

chapters/00-introduction.md:60 titlecase-rule Titlecase rule [Title Case: 'Expected ### How Skilled Do I Need to Be in Python to Use This Book?, found ### How skilled do I need to be in Python to use this book?']
chapters/00-introduction.md:64 titlecase-rule Titlecase rule [Title Case: 'Expected ### Do I Need to Know C to Use This Book?, found ### Do I Need to Know C to Use This book?']
chapters/00-introduction.md:74 titlecase-rule Titlecase rule [Title Case: 'Expected ### Won't The Content in This Book Be Out of Date Really Quickly?, found ### Won't The Content in This Book be Out of Date Really Quickly?']

markdownlint-rule-titlecase's Issues

Fixing violations of this rule always deletes the first character of the line

Looks like the fixInfo object is hard-coded to delete the first character of the line:

markdownlint-rule-titlecase/rule.js

Lines 26 to 29 in 34d0264

	{
	"editColumn": column,
	"deleteCount": length
	}

If a rule isn't able to fix an issue, it can simply omit the fixInfo object.

Here's a demonstration of the problem:

C:\T\title-case-issue>npm ls --depth 0
C:\T\title-case-issue
+-- [email protected]
`-- [email protected]

C:\T\title-case-issue>type demo.md
# heading

Text

C:\T\title-case-issue>type .markdownlint-cli2.jsonc
{
  "customRules": [
    "markdownlint-rule-titlecase"
  ]
}

C:\T\title-case-issue>node_modules\.bin\markdownlint-cli2 demo.md
demo.md:1:1 titlecase-rule Titlecase rule [Title Case: 'Expected # Heading, found # heading']

C:\T\title-case-issue>notepad .markdownlint-cli2.jsonc

C:\T\title-case-issue>type .markdownlint-cli2.jsonc
{
  "customRules": [
    "markdownlint-rule-titlecase"
  ],
  "fix": true
}

C:\T\title-case-issue>node_modules\.bin\markdownlint-cli2 demo.md
demo.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: " heading"]

C:\T\title-case-issue>type demo.md
 heading

Text

C:\T\title-case-issue>

Compatibility with config files?

Thanks for this!

I saw that we can run the rule explicitly, e.g.:

markdownlint "docs/**/*.md" --rules "markdownlint-rule-titlecase"

However, is there a way to incorporate it into the .markdownlintrc or markdownlint.json files such as those used by the CLI?

I'd love to be able to not have to explicitly specify it and instead rely on the config file itself.

Let me know if this is an issue best taken up with the CLI project itself.

Thanks again!