Registry / testing / remark-lint-list-item-bullet-indent

remark-lint-list-item-bullet-indent

library5.0.1jsnpmunverified

remark-lint rule to warn when list item markers (bullets or numbers) are indented. The current stable version is 5.0.1, released as part of the remark-lint monorepo with regular updates. It enforces that list items start at column 1, preventing uncommon and hard-to-maintain indented list styles. Key differentiator: it only checks indentation of the marker itself, not content indentation, and is included in the `remark-preset-lint-recommended` preset. It is ESM-only, supports Node.js 16+, and ships TypeScript types.

testing

npm install remark-lint-list-item-bullet-indent

github ↗package ↗

INSTALL

IMPORT

SIG · REMARK-LINT-LIST-I

remark-lint-list-item-bullet-indent

testingjavascriptv5.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

remarkLintListItemBulletIndent

✓ import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'

✗ const { remarkLintListItemBulletIndent } = require('remark-lint-list-item-bullet-indent')

Package is ESM-only since v3. Use default import; the symbol is also the default export.

default export

✓ import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'

✗ import { default } from 'remark-lint-list-item-bullet-indent'

The package exports a single default function; no named exports exist.

esm.sh usage

✓ import remarkLintListItemBulletIndent from 'https://esm.sh/remark-lint-list-item-bullet-indent@5'

✗ import { remarkLintListItemBulletIndent } from 'https://esm.sh/remark-lint-list-item-bullet-indent@5'

In Deno or browsers via esm.sh, the default export is used directly, not as a named export.

TypeScript type imports

✓ import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'

✗ import type { remarkLintListItemBulletIndent } from 'remark-lint-list-item-bullet-indent'

Package ships types but exposes no named types; the default import includes types automatically.

Shows how to integrate remark-lint-list-item-bullet-indent into a unified pipeline to lint a Markdown file for indented list markers.

import { read } from 'to-vfile'; import { reporter } from 'vfile-reporter'; import { unified } from 'unified'; import remarkParse from 'remark-parse'; import remarkStringify from 'remark-stringify'; import remarkLint from 'remark-lint'; import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'; const file = await read('example.md'); await unified() .use(remarkParse) .use(remarkStringify) .use(remarkLint) .use(remarkLintListItemBulletIndent) .process(file); console.error(reporter(file));

remark --version

Debug

Known issues

breakingVersion 3.0.0 dropped support for Node.js < 12.

fix

Upgrade to Node.js 12+ and use remark-lint-list-item-bullet-indent@3+.

affects: <3.0.0

breakingVersion 5.0.0 became ESM-only; CJS require() no longer works.

fix

Switch to ESM imports: use `import` instead of `require()`. If using CommonJS, consider dynamic import or stick with version 4.

affects: >=5.0.0

deprecatedVersion 4.x was a transitional ESM/CJS hybrid; using require() with it triggered deprecation warnings.

fix

Use `import` or upgrade to 5.x pure ESM.

affects: >=4.0.0 <5.0.0

gotchaThe rule reports the number of spaces indented; it does not allow configuration of the expected indent count.

fix

If you need to allow a specific indent (e.g., 2 spaces for nested list), this rule is not suitable; consider a custom plugin.

affects: >=1.0.0

gotchaThe rule applies to both ordered and unordered list markers, including task list items (`- [ ]`).

fix

Ensure your task list items also start at column 0.

affects: >=1.0.0

gotchaThe plugin must be used after `remarkLint` in the unified pipeline; otherwise, messages may not be captured.

fix

Always place `.use(remarkLint)` before this rule.

affects: >=1.0.0

gotchaWhen using with remark-cli, the rule name in config must match the npm package name exactly.

fix

Add `'remark-lint-list-item-bullet-indent'` to the plugins array, not a shorthand.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'remark-lint-list-item-bullet-indent'

Package not installed or not accessible in node_modules.

fix

Run `npm install remark-lint-list-item-bullet-indent` (or equivalent for yarn/pnpm).

TypeError: remarkLintListItemBulletIndent is not a function

Using require() on an ESM-only version (>=5.0.0).

fix

Use `import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'` or downgrade to version 4.

Error: Cannot use import statement outside a module

Running ESM code in a CommonJS file or environment without type: module.

fix

Either rename file to .mjs, add `"type": "module"` to package.json, or use dynamic import().

Unexpected `2` spaces before list item, expected `0` spaces, remove them

A list item marker is indented by spaces where the rule expects zero indent.

fix

Remove leading spaces before the marker (e.g., `  * Item` → `* Item`).

SyntaxError: Unexpected token 'export'

Using older Node.js (e.g., Node 14) with ESM-only package.

fix

Upgrade Node.js to version 16+ or use the CJS-compatible version 4.x.

Upgrade

Version history

5.0.1latest on npm

Audit

Dependencies

unifiedrequiredPlugin system; remark-lint-list-item-bullet-indent is a unified plugin.

remark-lintrequiredProvides the lint framework and message formatting.

remark-parseoptionalRequired to parse Markdown before linting.

remark-stringifyoptionalOptional for fix or final output; included in many setups.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/remarkjs/remark-lint.git#main ↗

packagehttps://www.npmjs.com/package/remark-lint-list-item-bullet-indent ↗