{"library":"remark-lint-no-file-name-articles","title":"remark-lint-no-file-name-articles","description":"A remark-lint rule that warns when Markdown file names start with articles such as \"a\", \"an\", or \"the\". Current stable version is 3.0.1, released as part of the remark-lint monorepo. It is ESM-only (Node.js 16+), ships TypeScript types, and has no configurable options. Unlike generic lint rules, this is specifically tailored for documentation sites and publishing workflows where article-prefixed filenames are considered poor practice.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-no-file-name-articles"],"cli":null},"imports":["import remarkLintNoFileNameArticles from 'remark-lint-no-file-name-articles'","remark --use remark-lint --use remark-lint-no-file-name-articles .","import type * as unified from 'unified'; import type { Plugin } from 'remark-lint';"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import { unified } from 'unified'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport remarkLint from 'remark-lint'\nimport remarkLintNoFileNameArticles from 'remark-lint-no-file-name-articles'\nimport { read } from 'to-vfile'\nimport { reporter } from 'vfile-reporter'\n\nconst file = await read('the-title.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintNoFileNameArticles)\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))\n// => '1:1: Unexpected file name starting with `the`, remove it'","lang":"typescript","description":"Shows how to use the rule programmatically via unified pipeline, reading a file and reporting lint warnings.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}