remark-lint | plugins to check markdown code style | Code Analyzer library

by remarkjs JavaScript Version: 9.1.2 License: MIT

X-Ray Key Features Code Snippets Community Discussions(2)Vulnerabilities Install Support

kandi X-RAY | remark-lint Summary

remark-lint is a JavaScript library typically used in Code Quality, Code Analyzer applications. remark-lint has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can install using 'npm i remark-lint-table-pipes' or download it from GitHub, npm.

remark plugins to lint Markdown. Ensuring the Markdown you (and contributors) write is of great quality will provide better rendering in all the different markdown parsers, and makes sure less refactoring is needed afterwards. What is quality? That’s up to you, but there are sensible presets. remark-lint is built on remark, a powerful Markdown processor powered by plugins (such as these).

Support

Quality

Security

License

Reuse

Support

remark-lint has a medium active ecosystem.

It has 848 star(s) with 136 fork(s). There are 15 watchers for this library.

It had no major release in the last 12 months.

There are 10 open issues and 193 have been closed. On average issues are closed in 26 days. There are 6 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of remark-lint is 9.1.2

Quality

remark-lint has no bugs reported.

Security

remark-lint has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

License

remark-lint is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

remark-lint releases are available to install and integrate.

Deployable package is available in npm.

Installation instructions, examples and code snippets are available.

Top functions reviewed by kandi - BETA

kandi has reviewed remark-lint and discovered the below as its top functions. This is intended to give you an instant insight into remark-lint implemented functionality, and help decide if they suit your requirements.

Find range in parentheses .
Parse a rule .
Load preset files .
Check the side of the side of a cell .
Lint plugin .
Add plugin error handler .
Coerce an error .
handle range
Returns the repository URL for the given path .
Compare the difference between two nodes .

Get all kandi verified functions for this library.

remark-lint Key Features

No Key Features are available at this moment for remark-lint.

remark-lint Examples and Code Snippets

No Code Snippets are available at this moment for remark-lint.

Community Discussions

Trending Discussions on remark-lint

Configure remark-lint-no-undefined-references plugin/rule 'Allow' option for remark-cli?

How to ignore files for remark-lint?

QUESTION

Configure remark-lint-no-undefined-references plugin/rule 'Allow' option for remark-cli?

Asked 2022-Mar-30 at 18:16

Original Question

How do I correctly "configure" the (unified, remark, remark-lint) remark-lint-no-undefined-references plugin/rule "allow" option for use with the remark-cli?

My goal is to configure the rule to ignore the Azure DevOps Wiki's non-standard table of contents tag, [[_TOC_]]. My simplified setup entails:

All packages globally installed. Probably not relevant.
A parent folder in which I have:
- A package.json file.
- A Test folder containing just the one Test.md file whose only content is this one line [[_TOC_]].
From a command prompt whose working folder is the aforementioned parent folder, I execute:
- remark Test

Default Operation

The default operation, i.e. just the plugin/rule specified in the package.json file, returns the expected warning. This is, presumably, due to the non-standard tag, [[_TOC_]]. This is the warning I wish to turn off.

package.json (default) ...

ANSWER

Answered 2022-Mar-30 at 18:16

The package.json below correctly "configures" the remark-lint-no-undefined-references plugin/rule "allow" option for use with remark-cli.

Note: I also transitioned away from globally installed packages out of an unsubstantiated concern that they might have contributed to my problem. See Multiple globally installed presets and plugins don’t work #165. This transition accounts for the added package.json "dependencies". See following.

package.json

I arrived at this by working from my 03/30/2022 update and futzing with varying syntax illustrated in the Unified Engine, Configuration, Schema section.

Again, my goal is to configure the rule to ignore the Azure DevOps Wiki's non-standard table of contents tag, [[_TOC_]].

Source https://stackoverflow.com/questions/71417416

QUESTION

How to ignore files for remark-lint?

Asked 2020-Sep-05 at 10:48

remark-lint is a Markdown linter written in JS. If offers a nice set of rules. This tool is also used by Codacy to check uploaded repositories for warnings and errors.

My repository contains an Apache License in Markdown, but unfortunately, the writers of the license didn't consult and editor to check for typographic mistakes like "no dot after a headline" (because it's not a sentence!). Anyhow, remark-lint is now complaining, but if I change the document, it's not the Apache license anymore. (See discussions with licence detecting tools e.g. used by GitHub. They refuse the Markdown file to be identical.)

My question is: how to configure remark-lint to ignore files or better to ignore rules per file/directory.

I read about:

But it doesn't state how to disable rules either inline or per configuration per file as user linters can do.

...

ANSWER

Answered 2020-Sep-05 at 10:48

Since remark-lint is a remark plugin it uses the same configuration files:

remark-lint is a remark plugin and when used on the CLI supports configuration through its configuration files

One of remark's configuration files is .remarkignore. I think a .remarkignore file containing something like

Source https://stackoverflow.com/questions/63752550

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install remark-lint

You can install using 'npm i remark-lint-table-pipes' or download it from GitHub, npm.

Support

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help. This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Find more information at: