DavidAnson / DavidAnson/markdownlint-cli2

Consider supporting configuration file names of the form markdownlint-cli2.config.jsonc by default (follows ESLint)

Open
#751 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
JavaScript
Stars
922
Forks
83
Avg merge
5h 16m
Merged PRs (30d)
21

Description

As per the README, markdownlint-cli2 supports the following names for configuration files by default:

  • .markdownlint-cli2.jsonc
  • .markdownlint-cli2.yaml
  • .markdownlint-cli2.cjs or .markdownlint-cli2.mjs
  • .markdownlint.jsonc or .markdownlint.json
  • .markdownlint.yaml or .markdownlint.yml
  • .markdownlint.cjs or .markdownlint.mjs

However, over the past 10 years or so, there has been a movement in the ecosystem to have lint tools standardize on a naming convention of foo.config.js. The "big 4" are ESLint, Prettier, Jest, and CSpell.

Other popular tools like Knip also support "knip.config.ts" automatically.

Edit - After making this post, I found yet another example in this very repository. =p

Thus, in order to match the way that the ecosystem is going, I propose that markdownlint-cli2 also supports the following file names by default:

  • markdownlint-cli2.config.jsonc
  • markdownlint-cli2.config.yaml
  • markdownlint-cli2.config.js
  • markdownlint-cli2.config.cjs
  • markdownlint-cli2.config.mjs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README's current default configuration-file list and compare it with the repository's ava.config.mjs example. Trace where configuration filenames are discovered, then verify that the five proposed markdownlint-cli2.config.* names are supported by default and that the README reflects the completed set.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
cli, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.