Registry / testing / standard-readme-preset

standard-readme-preset

library1.0.9jsnpmunverified

A remark preset to configure remark-lint with rules that enforce the standard-readme specification. Version 1.0.9 is the current stable release, with low release cadence. It includes custom rules for file extensions, required sections, section ordering, and heading validation. Differentiator: integrates directly with remark-lint to automatically check README compliance, reducing manual review effort. Dependencies: Node.js >=10. Install via npm and use CLI or API.

testing devops

npm install standard-readme-preset

github ↗package ↗

INSTALL

IMPORT

SIG · STANDARD-README-PR

standard-readme-preset

testingjavascriptv1.0.9

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.

default

✓ import preset from 'standard-readme-preset'

✗ const { preset } = require('standard-readme-preset')

Default export. CommonJS: require('standard-readme-preset').

remark-lint rules

✓ import { remark, lint } from 'remark'

Preset configures remark-lint under the hood; no direct rule imports needed.

remarkConfig

✓ { "plugins": ["standard-readme-preset"] }

Configuration for package.json or .remarkrc.

Shows how to lint a README using the preset via CLI and API with CommonJS.

// Install: npm install standard-readme-preset remark-cli // CLI usage with default rules remark -u standard-readme-preset README.md // API usage const remark = require('remark'); const preset = require('standard-readme-preset'); const vfile = require('to-vfile'); remark() .use(preset) .process(vfile.readSync('README.md'), (err, file) => { if (err) throw err; console.log(String(file)); });

Debug

Known issues

gotchaPreset requires remark-lint to be installed; not a standalone plugin.

fix

Ensure remark and remark-lint are in your dependencies.

affects: >=1.0.0

breakingDeprecated support for Node <10.

fix

Upgrade Node to version 10 or later.

affects: >=1.0.0

deprecatedGreenkeeper badge is obsolete; CI integration may be outdated.

fix

Switch to Renovate or manually update dependencies.

affects: >=1.0.0

gotchaCustom rules like file-extension and require-sections are not part of core remark-lint.

fix

Refer to https://github.com/RichardLitt/standard-readme-preset for rule specifics.

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module 'remark-lint'

remark-lint is missing from node_modules.

fix

npm install remark-lint

Error: Cannot find preset 'standard-readme-preset'

Preset not installed or incorrectly referenced.

fix

npm install standard-readme-preset

TypeError: preset is not a function

Using an ESM import without default export handling in older remark versions.

fix

Use default import: import preset from 'standard-readme-preset' or CommonJS require.

Upgrade

Version history

1.0.9latest on npm

Audit

Dependencies

remarkrequiredcore linting engine

remark-lintrequiredlinting rules framework

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/RichardLitt/standard-readme-preset ↗

packagehttps://www.npmjs.com/package/standard-readme-preset ↗