{"id":26299,"library":"remark-preset-lint-origami-component","title":"remark-preset-lint-origami-component","description":"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.","status":"active","version":"2.0.2","language":"javascript","source_language":"en","source_url":null,"tags":["javascript"],"install":[{"cmd":"npm install remark-preset-lint-origami-component","lang":"bash","label":"npm"},{"cmd":"yarn add remark-preset-lint-origami-component","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-preset-lint-origami-component","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"CJS-only; ESM not supported. Use require in .remarkrc.js.","wrong":"import preset from 'remark-preset-lint-origami-component'","symbol":"default preset","correct":"module.exports.plugins = [require('remark-preset-lint-origami-component')]"},{"note":"The -u flag expects the preset name without 'remark-' prefix.","wrong":"remark -u remark-preset-lint-origami-component README.md","symbol":"CLI usage","correct":"remark -u preset-lint-origami-component README.md"},{"note":"Must require the preset; ES imports not available.","wrong":"unified().use(remarkPresetLintOrigamiComponent)","symbol":"with unified","correct":"unified().use(require('remark-preset-lint-origami-component'))"}],"quickstart":{"code":"// .remarkrc.js\nmodule.exports.plugins = [\n  require('remark-preset-lint-origami-component')\n];\n\n// Then run: npx remark README.md\n// Or via CLI:\n// remark -u preset-lint-origami-component README.md","lang":"javascript","description":"Configure remark-lint using the Origami component preset via .remarkrc.js or CLI."},"warnings":[{"fix":"Use `remark -u preset-lint-origami-component`","message":"CLI requires 'preset-lint-origami-component' not the full package name","severity":"gotcha","affected_versions":"all"},{"fix":"Use `require('remark-preset-lint-origami-component')`","message":"Cannot be imported as ES module; CommonJS only","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Check the preset version aligns with your Origami component spec version","message":"Preset may not cover all Origami spec versions","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `npm install remark-preset-lint-origami-component --save-dev`","cause":"Package not installed or not in node_modules","error":"Error: Cannot find module 'remark-preset-lint-origami-component'"},{"fix":"Use `remark -u preset-lint-origami-component`","cause":"Using full package name in CLI instead of preset name","error":"Error: preset-lint-origami-component is not a plugin"},{"fix":"Use `require('remark-preset-lint-origami-component')` instead of `import`","cause":"Using ES import syntax in .remarkrc.js which is CJS","error":"SyntaxError: Cannot use import statement outside a module"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}