Registry / testing / remark-preset-lint-origami-component

remark-preset-lint-origami-component

JSON →
library2.0.2jsnpmunverified

A remark lint preset that enforces the rules and suggestions from the Origami component specification for README.md files. Version 2.0.2 is the latest stable release, with no active development cadence. It is designed for use within Financial Times' Origami ecosystem, typically consumed via origami-build-tools. Differentiates by providing a strict linting profile specific to Origami component documentation standards.

testing
npm install remark-preset-lint-origami-component
package ↗
INSTALL
IMPORT
SIG · REMARK-PRESET-LINT
R
remark-preset-lint-origami-component
testingjavascriptv2.0.2
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 preset
✓ module.exports.plugins = [require('remark-preset-lint-origami-component')]
✗ import preset from 'remark-preset-lint-origami-component'
CJS-only; ESM not supported. Use require in .remarkrc.js.
CLI usage
✓ remark -u preset-lint-origami-component README.md
✗ remark -u remark-preset-lint-origami-component README.md
The -u flag expects the preset name without 'remark-' prefix.
with unified
✓ unified().use(require('remark-preset-lint-origami-component'))
✗ unified().use(remarkPresetLintOrigamiComponent)
Must require the preset; ES imports not available.

Configure remark-lint using the Origami component preset via .remarkrc.js or CLI.

// .remarkrc.js module.exports.plugins = [ require('remark-preset-lint-origami-component') ]; // Then run: npx remark README.md // Or via CLI: // remark -u preset-lint-origami-component README.md
Debug
Known issues
gotchaCLI requires 'preset-lint-origami-component' not the full package name
fix
Use `remark -u preset-lint-origami-component`
affects: all
gotchaCannot be imported as ES module; CommonJS only
fix
Use `require('remark-preset-lint-origami-component')`
affects: >=2.0.0
gotchaPreset may not cover all Origami spec versions
fix
Check the preset version aligns with your Origami component spec version
affects: all
Errors
Common errors & fixes
Error: Cannot find module 'remark-preset-lint-origami-component'
Package not installed or not in node_modules
fix
Run `npm install remark-preset-lint-origami-component --save-dev`
Error: preset-lint-origami-component is not a plugin
Using full package name in CLI instead of preset name
fix
Use `remark -u preset-lint-origami-component`
SyntaxError: Cannot use import statement outside a module
Using ES import syntax in .remarkrc.js which is CJS
fix
Use `require('remark-preset-lint-origami-component')` instead of `import`
Upgrade
Version history
2.0.2latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
packagehttps://www.npmjs.com/package/remark-preset-lint-origami-component ↗
remark-preset-lint-origami-component — npm install remark-preset-lint-origami-component · libregistry