New Rule: Suggest rules for working with natural language, similar to textlint.

[lumirlumir]

Rule details

Rules for use with natural language like textlint.

---

Hello,

In the JavaScript 'Lint' world, there's a linting tool for natural language called textlint.

textlint is similar to ESLint, but it's designed for natural language files such as .txt, .md and .mdx like eslint/markdown.

There are a variety of rules in textlint, maintained by individuals. Here are some examples:

• textlint-rule-allowed-uris

  Check allowed or disallowed URI(URL)s in links and images of Markdown(.md, .mdx).

• textlint-rule-no-dead-link

  Check if all links are available or not.

• textlint-rule-terminology

  Check and fix correct terms spelling.

• textlint-rule-period-in-list-item

  Check with or without period in list item.

• @textlint-rule/textlint-rule-require-header-id

  Check {#id} for each headers.

• @textlint-rule/textlint-rule-no-unmatched-pair

  Check unmatched pairs like "（" and ")".

And many more... You can find additional rules in here.

---

I believe many of the rules mentioned above are useful for users working with Markdown.

Furthermore, many of the rules in textlint focus on 'Linting', rather than 'Formatting', which I think aligns with the goals of ESLint.

If these rules are included, we would be able to lint various files with ESLint in one go.

---

In conclusion, I would like to see many of these textlint rules integrated into eslint/markdown.

Since these textlint rules use a similar mechanism to eslint/markdown (though with some differences in details), they can be easily adapted into the ESLint ecosystem. Additionally, I'm familiar with the Markdown AST, so I can personally contribute to creating many of these rules.

What type of rule is this?

Warns about a potential problem

Example code

Not yet implemented.

Participation

• I am willing to submit a pull request to implement this rule.

Additional comments

I have some concerns regarding the implementation of these rules.

1. First: Which repository should these rules be placed in?

   I would like to see many of these useful textlint rules included in eslint/markdown, but I believe not every rule would be a good fit for it.

   As an alternative, I can also consider maintaining this textlint-like rule set within the eslint-community repository.

2. Second: Priority.

   There are hundreds of rules in textlint. If this suggestion is accepted, which rule should be prioritized for implementation? Does it depend on my own judgment or the community's request?

Thank you for reading this long suggestion. I would be happy to answer any further questions or requests you may have.

[nzakas]

Thanks for the suggestions. As the rules in textlint are meant for natural language, it's not appropriate to include them in this plugin. I'd suggest you start your own plugin that can work with the Markdown language in this plugin.