remark-preset-lint-origami-component

2.0.2 verified Fri May 01 auth: no javascript

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.

Common errors

error Error: Cannot find module 'remark-preset-lint-origami-component' ↓

cause Package not installed or not in node_modules

fix

Run npm install remark-preset-lint-origami-component --save-dev

error Error: preset-lint-origami-component is not a plugin ↓

cause Using full package name in CLI instead of preset name

fix

Use remark -u preset-lint-origami-component

error SyntaxError: Cannot use import statement outside a module ↓

cause Using ES import syntax in .remarkrc.js which is CJS

fix

Use require('remark-preset-lint-origami-component') instead of import

Warnings

gotcha CLI requires 'preset-lint-origami-component' not the full package name ↓

fix Use `remark -u preset-lint-origami-component`

gotcha Cannot be imported as ES module; CommonJS only ↓

fix Use `require('remark-preset-lint-origami-component')`

gotcha Preset may not cover all Origami spec versions ↓

fix Check the preset version aligns with your Origami component spec version

Install

npm install remark-preset-lint-origami-component

yarn add remark-preset-lint-origami-component

pnpm add remark-preset-lint-origami-component

Imports

default preset

wrong

import preset from 'remark-preset-lint-origami-component'

correct

module.exports.plugins = [require('remark-preset-lint-origami-component')]

CJS-only; ESM not supported. Use require in .remarkrc.js.

CLI usage

wrong

remark -u remark-preset-lint-origami-component README.md

correct

remark -u preset-lint-origami-component README.md

The -u flag expects the preset name without 'remark-' prefix.

with unified

wrong

unified().use(remarkPresetLintOrigamiComponent)

correct

unified().use(require('remark-preset-lint-origami-component'))

Must require the preset; ES imports not available.

Quickstart

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