Alexandro.Net

Version 1.0.0

@stackline/remark-lint

remark plugin to lint Markdown code style

Independent maintenance of remark-lint 9.1.2. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install remark-lint@npm:@stackline/remark-lint@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/remark-lint@1.0.0

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

The reference below may retain upstream package names. Use the alias installation above to run those imports with this Stackline release.

@stackline/remark-lint

Independent maintenance fork of remark-lint@9.1.2, preserving its API and published type declarations.

npm install @stackline/remark-lint
# Keep existing imports:
npm install remark-lint@npm:@stackline/remark-lint@1.0.0

Stackline · Issues · Community

See UPSTREAM.md for source identity and issue review, and CHANGELOG.md for maintenance changes. Functional tests also run against the final npm tarball; releases are published from GitHub Actions with provenance.

Upstream documentation

remark-lint

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to support configuration comments for remark lint rules.

See the monorepo readme for more info on remark lint.

Contents

What is this?

This package is a unified (remark) plugin to add support for configuration comments to control remark lint rule messages.

When should I use this?

This project is useful when you’re using remark lint rules and want to let authors ignore messages in certain cases. This package is already included in all our presets. If you’re building a preset yourself, you should include this package.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint

In Deno with esm.sh:

import remarkLint from 'https://esm.sh/remark-lint@9'

In browsers with esm.sh:

<script type="module">
  import remarkLint from 'https://esm.sh/remark-lint@9?build'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint example.md

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
+    "remark-lint",
     …
   ]
 }
 …

API

This package exports no identifiers. The default export is remarkLint.

unified().use(remarkLint)

Add support for configuration comments. There are no options.

See Ignore warnings in the monorepo readme for how to use it.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

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.

License

MIT © Titus Wormer

Upstream issues and maintenance review

Upstream and maintenance review

Independent maintenance of remark-lint@9.1.2 as @stackline/remark-lint.

This maintenance branch selects the npm package from the upstream monorepo into the repository root and retains the upstream Git history. Shared tests are narrowed to this package and wired to its local implementation. Other monorepo products are not published by this repository.

Issue triage

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. This is a bounded review, not a claim of exhaustive issue history or resolution of every issue.

Release verification

GitHub Actions publishes the reviewed passing-CI tarball. Release completion requires exact source identity, zero open CodeQL alerts, npm provenance and tarball identity, normal and aliased installs, and matching immutable GitHub release assets. Existing versions are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.