Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
remark-lint-no-heading-punctuation
Advanced tools
remark-lint rule to warn when headings end in illegal characters
remark-lint
rule to warn when headings end in irregular characters.
This package checks heading text.
You can use this package to check that heading text is consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide | ':.' |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-heading-punctuation
In Deno with esm.sh
:
import remarkLintNoHeadingPunctuation from 'https://esm.sh/remark-lint-no-heading-punctuation@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoHeadingPunctuation from 'https://esm.sh/remark-lint-no-heading-punctuation@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoHeadingPunctuation from 'remark-lint-no-heading-punctuation'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoHeadingPunctuation)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-heading-punctuation .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-heading-punctuation",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoHeadingPunctuation
.
unified().use(remarkLintNoHeadingPunctuation[, options])
Warn when headings end in irregular characters.
options
(RegExp
or string
, default: /[!,.:;?]/u
)
— configuration,
when string wrapped in new RegExp('[' + x + ']', 'u')
so make sure to
escape regexp charactersTransform (Transformer
from unified
).
ok.md
# Mercury
No messages.
not-ok.md
# Mercury:
# Venus?
# Earth!
# Mars,
# Jupiter;
1:1-1:11: Unexpected character `:` at end of heading, remove it
3:1-3:9: Unexpected character `?` at end of heading, remove it
5:1-5:9: Unexpected character `!` at end of heading, remove it
7:1-7:8: Unexpected character `,` at end of heading, remove it
9:1-9:11: Unexpected character `;` at end of heading, remove it
ok.md
When configured with ',;:!?'
.
# Mercury…
No messages.
regex.md
When configured with { source: '[^A-Za-z0-9]' }
.
# Mercury!
1:1-1:11: Unexpected character `!` at end of heading, remove it
example.mdx
👉 Note: this example uses MDX (
remark-mdx
).
<h1>Mercury?</h1>
1:1-1:18: Unexpected character `?` at end of heading, remove it
not-ok-options.md
When configured with 1
.
1:1: Unexpected value `1` for `options`, expected `RegExp` or `string`
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-no-heading-punctuation@4
,
compatible with Node.js 16.
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.
FAQs
remark-lint rule to warn when headings end in illegal characters
We found that remark-lint-no-heading-punctuation demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.