remark-preset-lint-crowdstrike

4.0.0 verified Fri May 01 auth: no javascript

remark-preset-lint-crowdstrike v4.0.0 is a preset configuration for remark-lint enforcing CrowdStrike's documentation style. It integrates seamlessly with remark-cli v12 and is intended for use in Node.js >=16.13. Unlike generic presets like remark-preset-lint-consistent or remark-preset-lint-recommended, this package is opinionated with CrowdStrike-specific rules. It ships as ESM-only and provides a single default export. Active development by CrowdStrike.

Common errors

error Cannot find module 'remark-preset-lint-crowdstrike' ↓

cause Package not installed or missing as dependency.

fix

Run: npm install remark-preset-lint-crowdstrike

error Error [ERR_REQUIRE_ESM]: require() of ES Module not supported ↓

cause Using CommonJS require() on ESM-only package.

fix

Switch to import statement or use dynamic import.

Warnings

breaking Version 4.0.0 drops CJS support; ESM-only. ↓

fix Use ESM (import) instead of require().

breaking Requires Node.js >=16.13. ↓

fix Update Node.js to version 16.13 or later.

deprecated Older version used --preset flag; now must use --use. ↓

fix Replace --preset with --use in CLI commands.

Install

npm install remark-preset-lint-crowdstrike

yarn add remark-preset-lint-crowdstrike

pnpm add remark-preset-lint-crowdstrike

Imports

default

wrong

const preset = require('remark-preset-lint-crowdstrike')

correct

import preset from 'remark-preset-lint-crowdstrike'

Package is ESM-only; CommonJS require will fail.

default

wrong

import { preset } from 'remark-preset-lint-crowdstrike'

correct

import preset from 'remark-preset-lint-crowdstrike'

Export is default, not named.

remark-cli

wrong

npx remark --preset remark-preset-lint-crowdstrike file.md

correct

npx remark --use remark-preset-lint-crowdstrike file.md

Use --use, not --preset, to load the preset.

Quickstart

Shows how to install and configure the preset in .remarkrc.mjs, then run remark on a Markdown file.

// Ensure Node.js >=16.13
// Install: npm install remark-cli remark-preset-lint-crowdstrike

// .remarkrc.mjs
import preset from 'remark-preset-lint-crowdstrike';

export default {
  plugins: [preset]
};
// Then run: npx remark README.md