feat(cli): add markdown target flag for scoped markdown linting

add markdown target option and selection parity with eslint and shell

pass markdown patterns through lint context to markdown detection

add tests and docs for markdown target workflows

Author: CMCDragonkai

README.md

@@ -42,6 +42,7 @@ matrixai-lint --fix
 | `--user-config`          | Uses detected `eslint.config.[js,mjs,cjs,ts]` from the project root if found |
 | `--eslint-config <path>` | Explicitly use a custom ESLint config file                                   |
 | `--eslint <targets>`     | ESLint targets (files, roots, or globs); implies ESLint domain selection     |
+| `--markdown <targets>`   | Markdown targets (files, roots, or globs); implies markdown domain selection |
 | `--shell <targets>`      | Shell targets (files, roots, or globs); implies shell domain selection       |
 | `--domain <id...>`       | Run only selected domains (`eslint`, `shell`, `markdown`)                    |
 | `--skip-domain <id...>`  | Skip selected domains (`eslint`, `shell`, `markdown`)                        |
@@ -58,13 +59,20 @@ Domain selection behavior:
   - `--eslint ...` runs ESLint only.
   - `--shell ...` runs shell only.
   - Passing both runs both.
+- Passing `--markdown` implies markdown domain selection.
+  - `--markdown ...` runs markdown only.
+  - Combined with other target flags, only those targeted domains run.
 - `shellcheck` is optional only for default auto-run shell execution.
   - If shell is explicitly requested (`--shell ...` or `--domain shell`),
     missing `shellcheck` is a failure.
 - `--shell` accepts target paths and glob patterns.
   - Directories are used as roots.
   - File paths and glob patterns are reduced to search roots, then `*.sh` files
     are discovered under those roots.
+- `--markdown` accepts target paths and glob patterns.
+  - Directories are used as roots.
+  - File paths and glob patterns are reduced to search roots, then `*.md` /
+    `*.mdx` files are discovered under those roots.
 
 #### Targeted workflows
 
@@ -86,6 +94,12 @@ Domain selection behavior:
   matrixai-lint --domain markdown
   ```
 
+- Markdown only under selected roots:
+
+  ```sh
+  matrixai-lint --markdown standards templates README.md
+  ```
+
 - Mixed scoped run (ESLint + shell only):
 
   ```sh
@@ -99,6 +113,7 @@ matrixai-lint --fix
 matrixai-lint --user-config
 matrixai-lint --eslint-config ./eslint.config.js --fix
 matrixai-lint --eslint "src/**/*.{ts,tsx}" --shell scripts
+matrixai-lint --markdown standards templates README.md
 matrixai-lint --domain eslint markdown
 matrixai-lint --skip-domain markdown
 matrixai-lint --list-domains

package.json

@@ -6,7 +6,7 @@
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/MatrixAI/js-eslint.git"
+    "url": "git+https://github.com/MatrixAI/js-eslint.git"
   },
   "type": "module",
   "exports": {
@@ -29,7 +29,7 @@
     "#*": "./dist/*"
   },
   "bin": {
-    "matrixai-lint": "./dist/bin/lint.js"
+    "matrixai-lint": "dist/bin/lint.js"
   },
   "scripts": {
     "prepare": "tsc -p ./tsconfig.build.json",

src/bin/lint.ts

@@ -44,6 +44,7 @@ program
   )
   .option('--eslint-config <path>', 'Path to explicit ESLint config file')
   .option('--eslint <target...>', 'ESLint targets (files, roots, or globs)')
+  .option('--markdown <target...>', 'Markdown targets (files, roots, or globs)')
   .option(
     '--shell <target...>',
     'Shell targets (files, roots, or globs) used to derive shellcheck search roots',
@@ -139,6 +140,7 @@ async function main(argv = process.argv) {
   const explain = Boolean(options.explain);
 
   const eslintPatterns: string[] | undefined = options.eslint;
+  const markdownPatterns: string[] | undefined = options.markdown;
   const shellPatterns: string[] | undefined = options.shell;
   const { selectedDomains, explicitlyRequestedDomains, selectionSources } =
     resolveDomainSelection(options);
@@ -197,6 +199,7 @@ async function main(argv = process.argv) {
       chosenConfig,
       isConfigValid,
       eslintPatterns,
+      markdownPatterns,
       shellPatterns,
     },
   });
@@ -214,6 +217,7 @@ async function main(argv = process.argv) {
       chosenConfig,
       isConfigValid,
       eslintPatterns,
+      markdownPatterns,
       shellPatterns,
     },
   });

src/domains/engine.ts

@@ -8,6 +8,7 @@ type LintDomainEngineContext = {
   isConfigValid: boolean;
   eslintPatterns?: string[];
   shellPatterns?: string[];
+  markdownPatterns?: string[];
 };
 
 type LintDomainAvailabilityKind = 'required' | 'optional';

src/domains/index.ts

@@ -29,6 +29,7 @@ function resolveDomainSelection(options: CLIOptions): {
   const hasDomainSelectors = domainFlags.length > 0 || skipDomains.size > 0;
   const hasExplicitESLintTargets = (options.eslint?.length ?? 0) > 0;
   const hasExplicitShellTargets = (options.shell?.length ?? 0) > 0;
+  const hasExplicitMarkdownTargets = (options.markdown?.length ?? 0) > 0;
   const explicitlyRequestedDomains = new Set<LintDomain>(domainFlags);
   const selectionSources = new Map<LintDomain, LintDomainSelectionSource>();
 
@@ -38,6 +39,9 @@ function resolveDomainSelection(options: CLIOptions): {
   if (hasExplicitShellTargets) {
     explicitlyRequestedDomains.add('shell');
   }
+  if (hasExplicitMarkdownTargets) {
+    explicitlyRequestedDomains.add('markdown');
+  }
 
   let selectedDomains: Set<LintDomain>;
 
@@ -48,7 +52,9 @@ function resolveDomainSelection(options: CLIOptions): {
     }
   } else if (
     !hasDomainSelectors &&
-    (hasExplicitESLintTargets || hasExplicitShellTargets)
+    (hasExplicitESLintTargets ||
+      hasExplicitShellTargets ||
+      hasExplicitMarkdownTargets)
   ) {
     selectedDomains = new Set<LintDomain>();
     if (hasExplicitESLintTargets) {
@@ -59,6 +65,10 @@ function resolveDomainSelection(options: CLIOptions): {
       selectedDomains.add('shell');
       selectionSources.set('shell', 'target-flag');
     }
+    if (hasExplicitMarkdownTargets) {
+      selectedDomains.add('markdown');
+      selectionSources.set('markdown', 'target-flag');
+    }
   } else {
     selectedDomains = new Set<LintDomain>(LINT_DOMAINS);
     for (const domain of LINT_DOMAINS) {

src/domains/markdown.ts

@@ -46,8 +46,11 @@ function createMarkdownDomainPlugin({
   return {
     domain: 'markdown',
     description: 'Format and check Markdown/MDX files with Prettier.',
-    detect: () => {
-      const searchPatterns = DEFAULT_MARKDOWN_SEARCH_ROOTS;
+    detect: ({ markdownPatterns }) => {
+      const searchPatterns =
+        markdownPatterns != null && markdownPatterns.length > 0
+          ? markdownPatterns
+          : DEFAULT_MARKDOWN_SEARCH_ROOTS;
       const searchRoots = resolveSearchRootsFromPatterns(searchPatterns);
       const matchedFiles = collectMarkdownFilesFromScope(searchRoots);
 

src/types.ts

@@ -35,6 +35,7 @@ type CLIOptions = {
   eslintConfig?: string;
   eslint?: string[];
   shell?: string[];
+  markdown?: string[];
   domain?: LintDomain[];
   skipDomain?: LintDomain[];
   listDomains?: boolean;

tests/bin/lint.test.ts

@@ -96,6 +96,31 @@ describe('matrixai-lint CLI domain semantics', () => {
     expect(prettierCalls).toHaveLength(0);
   });
 
+  test('--markdown no longer triggers eslint/shell domains', async () => {
+    await fs.promises.mkdir(path.join(dataDir, 'standards'), {
+      recursive: true,
+    });
+    await fs.promises.writeFile(
+      path.join(dataDir, 'standards', 'guide.md'),
+      '# guide\n',
+      'utf8',
+    );
+
+    await expect(
+      main(['node', 'matrixai-lint', '--markdown', 'standards']),
+    ).resolves.toBeUndefined();
+
+    const shellCalls = capturedExecCalls.filter((c) => c.file === 'shellcheck');
+    expect(shellCalls).toHaveLength(0);
+
+    const prettierCalls = capturedExecCalls.filter(
+      (c) =>
+        c.file === 'prettier' ||
+        c.args.some((arg) => /prettier\.cjs$/.test(arg)),
+    );
+    expect(prettierCalls.length).toBeGreaterThan(0);
+  });
+
   test('explicit shell request + missing shellcheck fails', async () => {
     jest
       .spyOn(childProcess, 'spawnSync')

tests/domains/index.test.ts

@@ -457,6 +457,34 @@ describe('domain selection', () => {
     expect(selectionSources.get('eslint')).toBe('target-flag');
   });
 
+  test('markdown target flag implies explicit markdown domain request', () => {
+    const { selectedDomains, explicitlyRequestedDomains, selectionSources } =
+      resolveDomainSelection({
+        fix: false,
+        userConfig: false,
+        markdown: ['standards', 'templates', 'README.md'],
+      });
+
+    expect([...selectedDomains]).toStrictEqual(['markdown']);
+    expect([...explicitlyRequestedDomains]).toStrictEqual(['markdown']);
+    expect(selectionSources.get('markdown')).toBe('target-flag');
+  });
+
+  test('domain flag remains authoritative over markdown target flag', () => {
+    const { selectedDomains, explicitlyRequestedDomains, selectionSources } =
+      resolveDomainSelection({
+        fix: false,
+        userConfig: false,
+        domain: ['eslint'],
+        markdown: ['standards'],
+      });
+
+    expect([...selectedDomains]).toStrictEqual(['eslint']);
+    expect([...explicitlyRequestedDomains]).toStrictEqual(['eslint']);
+    expect(selectionSources.get('eslint')).toBe('domain-flag');
+    expect(selectionSources.has('markdown')).toBe(false);
+  });
+
   test('--domain keeps explicit domains and --skip-domain removes them', () => {
     const { selectedDomains, explicitlyRequestedDomains, selectionSources } =
       resolveDomainSelection({