@matrixai/lint 0.2.12 → 0.4.1

package/AGENTS.md

@@ -0,0 +1,23 @@
+# AGENTS
+- Read the repo profile selector at [`.matrixai/repo-profile.yml`](.matrixai/repo-profile.yml).
+- Enforce the universal hotset [`.matrixai/matrixai-standards/standards/HOTSET.md`](.matrixai/matrixai-standards/standards/HOTSET.md).
+- Enforce the profile doc under [`.matrixai/matrixai-standards/standards/profiles/`](.matrixai/matrixai-standards/standards/profiles) matching `profile:` in `.matrixai/repo-profile.yml` (e.g., `library-js`, `application-js`, `worker-js-cloudflare`, `docusaurus-js-cloudflare`).
+- Profile index (for discovery): [`.matrixai/matrixai-standards/standards/profiles/README.md`](.matrixai/matrixai-standards/standards/profiles/README.md)
+- Tooling contract reference: [`.matrixai/matrixai-standards/standards/coding/tooling/tooling-contract.md`](.matrixai/matrixai-standards/standards/coding/tooling/tooling-contract.md) (commands, artifacts, expectations per profile).
+- Prefer ASCII punctuation/symbols when an equivalent exists (see [`.matrixai/matrixai-standards/standards/HOTSET.md`](.matrixai/matrixai-standards/standards/HOTSET.md) [MXS-GEN-006]).
+- Ensure edits comply with [`.editorconfig`](.editorconfig) (LF line endings, 2-space indent, final newline, trim trailing whitespace).
+- Line-reference policy (applies to all agent-generated repository content: Markdown, docs, templates, and code comments):
+  - Never emit `path:line` (e.g. `foo.ts:1`, `README.md:126`) into repository files.
+  - Do NOT put `:number` inside Markdown link destinations: `[x](path:123)` is banned.
+  - If a line reference is needed, use either:
+    - `[x](path#heading-anchor)` (if possible), or
+    - `[x](path) (line 123)` (preferred, portable), or
+    - `[x](path#L123)` only when explicitly targeting a renderer that supports `#L` anchors.
+  - If you would have emitted `:1`, drop it entirely: use `path` with no line info.
+- Apply repo-local golden commands and overrides here (use `npm run lintfix` during active development; use `npm run lint` for non-mutating CI checks):
+  - build: npm run build
+  - test: npm test
+  - lintfix: npm run lintfix
+  - lint: npm run lint
+  - docs: npm run docs
+  - bench: (not defined in this repo)

package/README.md

@@ -21,11 +21,13 @@ npm install --save-dev @matrixai/lint
 
 ## Usage
 
+### CLI
+
 ```sh
 matrixai-lint
 ```
 
-To run with autofix:
+With autofix:
 
 ```sh
 matrixai-lint --fix
@@ -33,120 +35,186 @@ matrixai-lint --fix
 
 ### CLI Options
 
-| Flag              | Description                                                                  |
-| ----------------- | ---------------------------------------------------------------------------- |
-| _(no flag)_       | Uses built-in Matrix AI ESLint config                                        |
-| `--fix`           | Enables auto-fixing via ESLint and Prettier                                  |
-| `--user-config`   | Uses detected \`eslint.config.[js,mjs,cjs,ts] from the project root if found |
-| `--config <path>` | Explicitly use a custom ESLint config file                                   |
-
-### Examples
+| Flag                     | Description                                                                  |
+| ------------------------ | ---------------------------------------------------------------------------- |
+| _(no flag)_              | Uses built-in Matrix AI ESLint config                                        |
+| `--fix`                  | Enables auto-fixing via ESLint and Prettier                                  |
+| `--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`)                        |
+| `--list-domains`         | Print available domains and short descriptions, then exit 0                  |
+| `--explain`              | Print per-domain decision details before execution                           |
+| `-v, --verbose`          | Increase log verbosity (repeat for more detail)                              |
+
+Domain selection behavior:
+
+- With no selectors and no domain-specific target flags, all built-in domains
+  run by default.
+- Passing `--eslint` and/or `--shell` implies explicit domain selection from
+  those flags.
+  - `--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
+
+- Only ESLint on a subset of files:
+
+  ```sh
+  matrixai-lint --eslint "src/**/*.{ts,tsx}" --domain eslint
+  ```
+
+- Only shell scripts under specific roots:
+
+  ```sh
+  matrixai-lint --shell scripts packages/*/scripts
+  ```
+
+- Markdown only:
+
+  ```sh
+  matrixai-lint --domain markdown
+  ```
+
+- Markdown only under selected roots:
+
+  ```sh
+  matrixai-lint --markdown standards templates README.md
+  ```
+
+- Mixed scoped run (ESLint + shell only):
+
+  ```sh
+  matrixai-lint --eslint "src/**/*.{ts,tsx}" --shell scripts
+  ```
+
+#### Examples
 
 ```sh
 matrixai-lint --fix
 matrixai-lint --user-config
-matrixai-lint --config ./eslint.config.js --fix
+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
+matrixai-lint --explain --domain eslint
+matrixai-lint -v -v --domain markdown
 ```
 
-### TypeScript Support
+### ESLint config (ESM / NodeNext)
 
-The linter is TypeScript-aware and requires a `tsconfig.json` to determine which
-files to lint and how to parse them.
+`matrixai-lint` ships an ESLint Flat Config array and types for TypeScript
+projects configured as NodeNext.
 
-By default:
+#### Default import
 
-- It looks for `tsconfig.json` in the project root
-- Files are selected based on the `include` and `exclude` fields in the tsconfig
+```js
+// eslint.config.js
+import { config } from '@matrixai/lint';
 
-### Working with multiple tsconfigs
+export default config;
+```
 
-If your project uses more than one `tsconfig.json` or doesn't have one at the
-root, you can configure the linter using a `matrixai-lint-config.json` file at
-the root:
+#### Explicit subpath import
 
-```json
-{
-  "tsconfigPaths": ["./tsconfig.base.json", "./packages/core/tsconfig.json"],
-  "forceInclude": ["scripts", "src/overrides"]
-}
-```
+```js
+// eslint.config.js
+import matrixai from '@matrixai/lint/configs/eslint.js';
 
-| Field           | Type       | Description                                                                              |
-| --------------- | ---------- | ---------------------------------------------------------------------------------------- |
-| `tsconfigPaths` | `string[]` | One or more paths to `tsconfig.json` files                                               |
-| `forceInclude`  | `string[]` | Paths to always include, even if excluded by tsconfig (must be included by at least one) |
+export default matrixai;
+```
 
-> ⚠ If a path in `forceInclude` is not included in any of the `tsconfigPaths`,
-> TypeScript will throw a parsing error.
+### Lint configuration file
 
-### ESLint Config Override
+The linter is TypeScript-aware and requires a `tsconfig.json` to determine which
+files to lint and how to parse them. By default it looks for `tsconfig.json` in
+the project root and uses the `include`/`exclude` entries.
 
-You can use your own ESLint config by one of the following methods:
+If your project uses more than one `tsconfig.json` or does not have one at the
+root, configure the linter using a `matrixai-lint-config.json` file at the root.
 
-#### 1. Inline Custom Config
+This config uses a versioned schema and must explicitly declare `"version": 2`:
 
-```sh
-matrixai-lint --config ./eslint.config.js
+```json
+{
+  "version": 2,
+  "root": ".",
+  "domains": {
+    "eslint": {
+      "tsconfigPaths": [
+        "./tsconfig.base.json",
+        "./packages/core/tsconfig.json"
+      ],
+      "forceInclude": ["scripts", "src/overrides"]
+    }
+  }
+}
 ```
 
-#### 2. Auto-detect with `--user-config`
+| Field                          | Type       | Description                                                                               |
+| ------------------------------ | ---------- | ----------------------------------------------------------------------------------------- |
+| `version`                      | `2`        | Required schema version marker                                                            |
+| `root`                         | `string`   | Optional lint root (defaults to `.`). `tsconfigPaths` are resolved relative to this root. |
+| `domains.eslint.tsconfigPaths` | `string[]` | One or more paths to `tsconfig.json` files                                                |
+| `domains.eslint.forceInclude`  | `string[]` | Paths to always include, even if excluded by tsconfig (must be included by at least one)  |
 
-```sh
-matrixai-lint --user-config
-```
+Note: If a path in `forceInclude` is not included in any of the `tsconfigPaths`,
+TypeScript will throw a parsing error.
 
-This will look for a valid eslint.config file in the project root.
+### Public API
 
-Valid config filenames:
+Supported imports:
 
-- `eslint.config.js`
-- `eslint.config.cjs`
-- `eslint.config.mjs`
-- `eslint.config.ts`
+- `@matrixai/lint`: named export `config`; types `MatrixAILintCfg`,
+  `RawMatrixCfg`, `CLIOptions`.
+- `@matrixai/lint/configs/eslint.js`: default export of the ESLint Flat Config
+  array (same shape as `config`).
+- `@matrixai/lint/configs/prettier.config.js`: reusable Prettier options object.
 
-#### 3. Extend the base config
+The exported `config` is intended as a composable base preset for downstream
+`eslint.config.js` files, not as an internal-only implementation detail.
 
-```ts
-// eslint.config.js
-import matrixai from '@matrixai/lint/config';
-
-export default [
-  ...matrixai,
-  {
-    rules: {
-      '@typescript-eslint/no-explicit-any': 'error',
-      'no-console': 'off',
-    },
-  },
-];
-```
+Any package import path not listed above is internal and not a stable public
+API.
 
-## Development
+## Contributing
 
-Run `nix develop`, and once you're inside, you can use:
+Golden commands:
 
-```sh
-# install (or reinstall packages from package.json)
-npm install
-# build the dist
-npm run build
-# run the repl (this allows you to import from ./src)
-npm run tsx
-# run the tests
-npm run test
-# lint the source code
-npm run lint
-# automatically fix the source
-npm run lintfix
-```
+- `npm run build`
+- `npm run lint`
+- `npm run lintfix`
+- `npm run docs`
 
-### Docs Generation
+Notes:
 
-```sh
-npm run docs
-```
+- `npm run lint` and `npm run lintfix` invoke `npm run prepare` first so the
+  compiled CLI in `dist/bin/matrixai-lint.js` stays up to date while keeping
+  TypeScript incremental rebuilds fast.
+
+For the authoritative contributor guidance see [AGENTS.md](AGENTS.md).
 
-See the docs at: https://matrixai.github.io/js-lint/
+Docs: https://matrixai.github.io/js-lint/
 
 ### Publishing
 

package/dist/bin/matrixai-lint.js

@@ -0,0 +1,174 @@
+#!/usr/bin/env node
+import path from 'node:path';
+import process from 'node:process';
+import fs from 'node:fs';
+import url from 'node:url';
+import { Command, Option } from 'commander';
+import Logger, { StreamHandler } from '@matrixai/logger';
+import { LINT_DOMAINS, resolveDomainSelection, createBuiltInDomainRegistry, listLintDomains, evaluateLintDomains, runLintDomainDecisions, } from '../domains/index.js';
+import * as utils from '../utils.js';
+const program = new Command();
+const dirname = path.dirname(url.fileURLToPath(import.meta.url));
+const builtinPrettierCfg = path.resolve(dirname, '../configs/prettier.config.js');
+program
+    .name('matrixai-lint')
+    .description('Lint source files, scripts, and markdown with configured rules.')
+    .addOption(new Option('-v, --verbose', 'Increase log verbosity')
+    .argParser((_, previous = 0) => previous + 1)
+    .default(0))
+    .option('-f, --fix', 'Automatically fix problems')
+    .option('--list-domains', 'List available lint domains and exit')
+    .option('--explain', 'Print per-domain selection and execution decisions')
+    .option('--user-config', 'Use user-provided ESLint config instead of built-in one')
+    .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')
+    .addOption(new Option('--domain <id...>', `Run only selected domains (${LINT_DOMAINS.join(', ')})`).choices(LINT_DOMAINS))
+    .addOption(new Option('--skip-domain <id...>', `Skip selected domains (${LINT_DOMAINS.join(', ')})`).choices(LINT_DOMAINS));
+function describeAvailability(decision) {
+    if (decision.detection == null) {
+        return 'not-evaluated';
+    }
+    const detection = decision.detection;
+    const status = detection.available ? 'available' : 'unavailable';
+    const reason = detection.unavailableReason;
+    return reason != null && reason.length > 0
+        ? `${status} (${detection.availabilityKind}; ${reason})`
+        : `${status} (${detection.availabilityKind})`;
+}
+function describeRelevance(decision) {
+    if (decision.detection == null) {
+        return decision.plannedAction === 'skip-unselected'
+            ? 'not-evaluated (domain not selected)'
+            : 'not-evaluated';
+    }
+    const detection = decision.detection;
+    const status = detection.relevant ? 'relevant' : 'not-relevant';
+    const reason = detection.relevanceReason;
+    return reason != null && reason.length > 0 ? `${status} (${reason})` : status;
+}
+function printDomainList(logger, domains) {
+    logger.info('Available lint domains:');
+    for (const domainInfo of domains) {
+        logger.info(`- ${domainInfo.domain}: ${domainInfo.description}`);
+    }
+}
+function printExplain(logger, decisions) {
+    logger.info('[matrixai-lint] Domain execution plan:');
+    for (const decision of decisions) {
+        logger.info(`[matrixai-lint]  -  domain: ${decision.domain}`);
+        logger.info(`[matrixai-lint]     selection: ${decision.selectionSource}${decision.explicitlyRequested ? ' (explicit)' : ''}`);
+        logger.info(`[matrixai-lint]     relevance: ${describeRelevance(decision)}`);
+        logger.info(`[matrixai-lint]     availability: ${describeAvailability(decision)}`);
+        if (decision.detectionError != null) {
+            logger.error(`[matrixai-lint]     detection-error: ${decision.detectionError}`);
+        }
+        logger.info(`[matrixai-lint]     planned-action: ${decision.plannedAction}`);
+    }
+}
+async function main(argv = process.argv) {
+    await program.parseAsync(argv);
+    const options = program.opts();
+    const logger = new Logger('matrixai-lint', undefined, [new StreamHandler()]);
+    logger.setLevel(utils.verboseToLogLevel(options.verbose));
+    const fix = Boolean(options.fix);
+    const useUserConfig = Boolean(options.userConfig);
+    const explicitConfigPath = options.eslintConfig;
+    const listDomainsOnly = Boolean(options.listDomains);
+    const explain = Boolean(options.explain);
+    const eslintPatterns = options.eslint;
+    const markdownPatterns = options.markdown;
+    const shellPatterns = options.shell;
+    const { selectedDomains, explicitlyRequestedDomains, selectionSources } = resolveDomainSelection(options);
+    const domainRegistry = createBuiltInDomainRegistry({
+        prettierConfigPath: builtinPrettierCfg,
+    });
+    if (listDomainsOnly) {
+        printDomainList(logger, listLintDomains({
+            registry: domainRegistry,
+            executionOrder: LINT_DOMAINS,
+        }));
+        return;
+    }
+    let hadFailure = false;
+    // Resolve which config file to use
+    let chosenConfig;
+    let isConfigValid = true;
+    if (explicitConfigPath !== undefined) {
+        const absolutePath = path.resolve(explicitConfigPath);
+        if (!fs.existsSync(absolutePath)) {
+            logger.error(`--eslint-config points to "${explicitConfigPath}", but that file does not exist.`);
+            hadFailure = true;
+            isConfigValid = false;
+        }
+        else {
+            chosenConfig = absolutePath;
+        }
+    }
+    else if (useUserConfig) {
+        chosenConfig = utils.findUserESLintConfig();
+        if (chosenConfig === undefined) {
+            logger.warn('--user-config given but no local ESLint config was found. Falling back to built-in config.');
+        }
+    }
+    const decisions = await evaluateLintDomains({
+        registry: domainRegistry,
+        selectedDomains,
+        explicitlyRequestedDomains,
+        selectionSources,
+        executionOrder: LINT_DOMAINS,
+        context: {
+            fix,
+            logger,
+            chosenConfig,
+            isConfigValid,
+            eslintPatterns,
+            markdownPatterns,
+            shellPatterns,
+        },
+    });
+    if (explain) {
+        printExplain(logger, decisions);
+    }
+    const hadDomainFailure = await runLintDomainDecisions({
+        registry: domainRegistry,
+        decisions,
+        context: {
+            fix,
+            logger,
+            chosenConfig,
+            isConfigValid,
+            eslintPatterns,
+            markdownPatterns,
+            shellPatterns,
+        },
+    });
+    if (hadDomainFailure) {
+        hadFailure = true;
+    }
+    if (hadFailure) {
+        logger.error('[matrixai-lint]  ✖  Linting failed.');
+        process.exit(1);
+    }
+    else {
+        logger.info('[matrixai-lint]  ✔  Linting passed.');
+    }
+}
+if (import.meta.url.startsWith('file:') && process.argv[1] != null) {
+    const entryPath = process.argv[1];
+    let entryUrl;
+    try {
+        entryUrl = entryPath.startsWith('file:')
+            ? new URL(entryPath).href
+            : url.pathToFileURL(fs.realpathSync.native(entryPath)).href;
+    }
+    catch {
+        entryUrl = url.pathToFileURL(path.resolve(entryPath)).href;
+    }
+    if (entryUrl === new URL(import.meta.url).href) {
+        void main();
+    }
+}
+export default main;
+//# sourceMappingURL=matrixai-lint.js.map

package/dist/bin/matrixai-lint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matrixai-lint.js","sourceRoot":"","sources":["../../src/bin/matrixai-lint.ts"],"names":[],"mappings":";AAEA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,2BAA2B,EAC3B,eAAe,EACf,mBAAmB,EACnB,sBAAsB,GAEvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AAErC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACjE,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CACrC,OAAO,EACP,+BAA+B,CAChC,CAAC;AAEF,OAAO;KACJ,IAAI,CAAC,eAAe,CAAC;KACrB,WAAW,CACV,iEAAiE,CAClE;KACA,SAAS,CACR,IAAI,MAAM,CAAC,eAAe,EAAE,wBAAwB,CAAC;KAClD,SAAS,CAAC,CAAC,CAAS,EAAE,WAAmB,CAAC,EAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC;KAC5D,OAAO,CAAC,CAAC,CAAC,CACd;KACA,MAAM,CAAC,WAAW,EAAE,4BAA4B,CAAC;KACjD,MAAM,CAAC,gBAAgB,EAAE,sCAAsC,CAAC;KAChE,MAAM,CAAC,WAAW,EAAE,oDAAoD,CAAC;KACzE,MAAM,CACL,eAAe,EACf,yDAAyD,CAC1D;KACA,MAAM,CAAC,wBAAwB,EAAE,qCAAqC,CAAC;KACvE,MAAM,CAAC,sBAAsB,EAAE,yCAAyC,CAAC;KACzE,MAAM,CAAC,wBAAwB,EAAE,2CAA2C,CAAC;KAC7E,MAAM,CACL,qBAAqB,EACrB,+EAA+E,CAChF;KACA,SAAS,CACR,IAAI,MAAM,CACR,kBAAkB,EAClB,8BAA8B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACzD,CAAC,OAAO,CAAC,YAAY,CAAC,CACxB;KACA,SAAS,CACR,IAAI,MAAM,CACR,uBAAuB,EACvB,0BAA0B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrD,CAAC,OAAO,CAAC,YAAY,CAAC,CACxB,CAAC;AAEJ,SAAS,oBAAoB,CAAC,QAA4B;IACxD,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE;QAC9B,OAAO,eAAe,CAAC;KACxB;IAED,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;IACrC,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC;IACjE,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC;IAE3C,OAAO,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QACxC,CAAC,CAAC,GAAG,MAAM,KAAK,SAAS,CAAC,gBAAgB,KAAK,MAAM,GAAG;QACxD,CAAC,CAAC,GAAG,MAAM,KAAK,SAAS,CAAC,gBAAgB,GAAG,CAAC;AAClD,CAAC;AAED,SAAS,iBAAiB,CAAC,QAA4B;IACrD,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE;QAC9B,OAAO,QAAQ,CAAC,aAAa,KAAK,iBAAiB;YACjD,CAAC,CAAC,qCAAqC;YACvC,CAAC,CAAC,eAAe,CAAC;KACrB;IAED,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;IACrC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC;IAChE,MAAM,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC;IAEzC,OAAO,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;AAChF,CAAC;AAED,SAAS,eAAe,CACtB,MAAc,EACd,OAAuD;IAEvD,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACvC,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;KAClE;AACH,CAAC;AAED,SAAS,YAAY,CACnB,MAAc,EACd,SAAwC;IAExC,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACtD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC,+BAA+B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,IAAI,CACT,kCAAkC,QAAQ,CAAC,eAAe,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,CACjH,CAAC;QACF,MAAM,CAAC,IAAI,CACT,kCAAkC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAChE,CAAC;QACF,MAAM,CAAC,IAAI,CACT,qCAAqC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CACtE,CAAC;QACF,IAAI,QAAQ,CAAC,cAAc,IAAI,IAAI,EAAE;YACnC,MAAM,CAAC,KAAK,CACV,wCAAwC,QAAQ,CAAC,cAAc,EAAE,CAClE,CAAC;SACH;QACD,MAAM,CAAC,IAAI,CACT,uCAAuC,QAAQ,CAAC,aAAa,EAAE,CAChE,CAAC;KACH;AACH,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI;IACrC,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAc,CAAC;IAC3C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC,CAAC;IAC7E,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAE1D,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,kBAAkB,GAAuB,OAAO,CAAC,YAAY,CAAC;IACpE,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC,MAAM,cAAc,GAAyB,OAAO,CAAC,MAAM,CAAC;IAC5D,MAAM,gBAAgB,GAAyB,OAAO,CAAC,QAAQ,CAAC;IAChE,MAAM,aAAa,GAAyB,OAAO,CAAC,KAAK,CAAC;IAC1D,MAAM,EAAE,eAAe,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,GACrE,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAElC,MAAM,cAAc,GAAG,2BAA2B,CAAC;QACjD,kBAAkB,EAAE,kBAAkB;KACvC,CAAC,CAAC;IAEH,IAAI,eAAe,EAAE;QACnB,eAAe,CACb,MAAM,EACN,eAAe,CAAC;YACd,QAAQ,EAAE,cAAc;YACxB,cAAc,EAAE,YAAY;SAC7B,CAAC,CACH,CAAC;QACF,OAAO;KACR;IAED,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,mCAAmC;IACnC,IAAI,YAAgC,CAAC;IACrC,IAAI,aAAa,GAAG,IAAI,CAAC;IAEzB,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAEtD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;YAChC,MAAM,CAAC,KAAK,CACV,8BAA8B,kBAAkB,kCAAkC,CACnF,CAAC;YACF,UAAU,GAAG,IAAI,CAAC;YAClB,aAAa,GAAG,KAAK,CAAC;SACvB;aAAM;YACL,YAAY,GAAG,YAAY,CAAC;SAC7B;KACF;SAAM,IAAI,aAAa,EAAE;QACxB,YAAY,GAAG,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAC5C,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,MAAM,CAAC,IAAI,CACT,4FAA4F,CAC7F,CAAC;SACH;KACF;IAED,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC;QAC1C,QAAQ,EAAE,cAAc;QACxB,eAAe;QACf,0BAA0B;QAC1B,gBAAgB;QAChB,cAAc,EAAE,YAAY;QAC5B,OAAO,EAAE;YACP,GAAG;YACH,MAAM;YACN,YAAY;YACZ,aAAa;YACb,cAAc;YACd,gBAAgB;YAChB,aAAa;SACd;KACF,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE;QACX,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;KACjC;IAED,MAAM,gBAAgB,GAAG,MAAM,sBAAsB,CAAC;QACpD,QAAQ,EAAE,cAAc;QACxB,SAAS;QACT,OAAO,EAAE;YACP,GAAG;YACH,MAAM;YACN,YAAY;YACZ,aAAa;YACb,cAAc;YACd,gBAAgB;YAChB,aAAa;SACd;KACF,CAAC,CAAC;IAEH,IAAI,gBAAgB,EAAE;QACpB,UAAU,GAAG,IAAI,CAAC;KACnB;IAED,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;SAAM;QACL,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;KACpD;AACH,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE;IAClE,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,QAAgB,CAAC;IACrB,IAAI;QACF,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YACtC,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI;YACzB,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;KAC/D;IAAC,MAAM;QACN,QAAQ,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;KAC5D;IACD,IAAI,QAAQ,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;QAC9C,KAAK,IAAI,EAAE,CAAC;KACb;CACF;AAED,eAAe,IAAI,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,15 @@
+import type { MatrixAILintCfgSource, MatrixAILintCfgResolved, RawMatrixCfg } from './types.js';
+declare const MATRIXAI_LINT_CONFIG_FILENAME = "matrixai-lint-config.json";
+declare function normalizeLintConfig({ rawConfig, source, repoRoot, configFilePath, }: {
+    rawConfig: RawMatrixCfg;
+    source: MatrixAILintCfgSource;
+    repoRoot: string;
+    configFilePath: string;
+}): MatrixAILintCfgResolved;
+declare function parseLintConfig({ rawConfig, repoRoot, configFilePath, }: {
+    rawConfig: unknown;
+    repoRoot: string;
+    configFilePath: string;
+}): MatrixAILintCfgResolved;
+declare function resolveLintConfig(repoRoot?: string): MatrixAILintCfgResolved;
+export { MATRIXAI_LINT_CONFIG_FILENAME, normalizeLintConfig, parseLintConfig, resolveLintConfig, };

package/dist/config.js

@@ -0,0 +1,120 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import ts from 'typescript';
+const MATRIXAI_LINT_CONFIG_FILENAME = 'matrixai-lint-config.json';
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+function toStringArray(value) {
+    if (typeof value === 'string') {
+        return [value];
+    }
+    if (Array.isArray(value)) {
+        return value.filter((item) => typeof item === 'string');
+    }
+    return [];
+}
+function stripLeadingDotSlash(value) {
+    return value.replace(/^\.\//, '');
+}
+function dedupeAndSort(values) {
+    return [...new Set(values)].sort();
+}
+function isReadableTsconfigPath(tsconfigPath) {
+    let stats;
+    try {
+        stats = fs.statSync(tsconfigPath);
+    }
+    catch {
+        return false;
+    }
+    if (!stats.isFile()) {
+        return false;
+    }
+    const readResult = ts.readConfigFile(tsconfigPath, ts.sys.readFile);
+    return readResult.error == null;
+}
+function sanitizeTsconfigPaths(rawValue, root) {
+    return dedupeAndSort(toStringArray(rawValue)
+        .map((tsconfigPath) => path.resolve(root, tsconfigPath))
+        .filter((tsconfigPath) => isReadableTsconfigPath(tsconfigPath)));
+}
+function sanitizeForceInclude(rawValue) {
+    return dedupeAndSort(toStringArray(rawValue)
+        .map((glob) => stripLeadingDotSlash(glob))
+        .filter((glob) => glob.length > 0));
+}
+function normalizeLintConfig({ rawConfig, source, repoRoot, configFilePath, }) {
+    const rawRoot = typeof rawConfig.root === 'string' && rawConfig.root.length > 0
+        ? rawConfig.root
+        : '.';
+    const resolvedRoot = path.resolve(repoRoot, rawRoot);
+    const rawDomains = isRecord(rawConfig.domains)
+        ? rawConfig.domains
+        : {};
+    const rawEslintDomain = isRecord(rawDomains.eslint)
+        ? rawDomains.eslint
+        : {};
+    let tsconfigPaths = sanitizeTsconfigPaths(rawEslintDomain.tsconfigPaths, resolvedRoot);
+    const forceInclude = sanitizeForceInclude(rawEslintDomain.forceInclude);
+    if (tsconfigPaths.length === 0) {
+        const rootTsconfigPath = path.join(resolvedRoot, 'tsconfig.json');
+        if (isReadableTsconfigPath(rootTsconfigPath)) {
+            tsconfigPaths.push(rootTsconfigPath);
+        }
+    }
+    tsconfigPaths = dedupeAndSort(tsconfigPaths);
+    return {
+        version: 2,
+        root: resolvedRoot,
+        source,
+        configFilePath,
+        domains: {
+            eslint: {
+                tsconfigPaths,
+                forceInclude,
+            },
+        },
+    };
+}
+function parseLintConfig({ rawConfig, repoRoot, configFilePath, }) {
+    if (!isRecord(rawConfig)) {
+        throw new Error('[matrixai-lint]  ✖  matrixai-lint-config.json must contain a JSON object.');
+    }
+    if (rawConfig.version !== 2) {
+        throw new Error('[matrixai-lint]  ✖  matrixai-lint-config.json must declare "version": 2.');
+    }
+    return normalizeLintConfig({
+        rawConfig: rawConfig,
+        source: 'config',
+        repoRoot,
+        configFilePath,
+    });
+}
+function resolveLintConfig(repoRoot = process.cwd()) {
+    const configFilePath = path.join(repoRoot, MATRIXAI_LINT_CONFIG_FILENAME);
+    if (!fs.existsSync(configFilePath)) {
+        return normalizeLintConfig({
+            rawConfig: { version: 2 },
+            source: 'default',
+            repoRoot,
+            configFilePath,
+        });
+    }
+    let rawConfig = {};
+    try {
+        const text = fs.readFileSync(configFilePath, 'utf8').trim();
+        rawConfig = text.length > 0 ? JSON.parse(text) : {};
+    }
+    catch (error) {
+        throw new Error(`[matrixai-lint]  ✖  matrixai-lint-config.json has been provided but it is not valid JSON.\n ${String(error)}`);
+    }
+    return parseLintConfig({
+        rawConfig,
+        repoRoot,
+        configFilePath,
+    });
+}
+export { MATRIXAI_LINT_CONFIG_FILENAME, normalizeLintConfig, parseLintConfig, resolveLintConfig, };
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,6BAA6B,GAAG,2BAA2B,CAAC;AAElE,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,CAAC,KAAK,CAAC,CAAC;KAChB;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;KACzE;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,MAAyB;IAC9C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACrC,CAAC;AAED,SAAS,sBAAsB,CAAC,YAAoB;IAClD,IAAI,KAAe,CAAC;IACpB,IAAI;QACF,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;KACnC;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,UAAU,GAAG,EAAE,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpE,OAAO,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC;AAClC,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAiB,EAAE,IAAY;IAC5D,OAAO,aAAa,CAClB,aAAa,CAAC,QAAQ,CAAC;SACpB,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACvD,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,QAAiB;IAC7C,OAAO,aAAa,CAClB,aAAa,CAAC,QAAQ,CAAC;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;SACzC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CACrC,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,EAC3B,SAAS,EACT,MAAM,EACN,QAAQ,EACR,cAAc,GAMf;IACC,MAAM,OAAO,GACX,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAC,IAAI;QAChB,CAAC,CAAC,GAAG,CAAC;IACV,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAErD,MAAM,UAAU,GAA4B,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC;QACrE,CAAC,CAAC,SAAS,CAAC,OAAO;QACnB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACjD,CAAC,CAAC,UAAU,CAAC,MAAM;QACnB,CAAC,CAAE,EAA8B,CAAC;IAEpC,IAAI,aAAa,GAAG,qBAAqB,CACvC,eAAe,CAAC,aAAa,EAC7B,YAAY,CACb,CAAC;IACF,MAAM,YAAY,GAAG,oBAAoB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAExE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAClE,IAAI,sBAAsB,CAAC,gBAAgB,CAAC,EAAE;YAC5C,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACtC;KACF;IAED,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAE7C,OAAO;QACL,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,YAAY;QAClB,MAAM;QACN,cAAc;QACd,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,aAAa;gBACb,YAAY;aACb;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,EACvB,SAAS,EACT,QAAQ,EACR,cAAc,GAKf;IACC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;KACH;IAED,IAAI,SAAS,CAAC,OAAO,KAAK,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;KACH;IAED,OAAO,mBAAmB,CAAC;QACzB,SAAS,EAAE,SAAyB;QACpC,MAAM,EAAE,QAAQ;QAChB,QAAQ;QACR,cAAc;KACf,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE;IACjD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IAE1E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QAClC,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;YACzB,MAAM,EAAE,SAAS;YACjB,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;KACJ;IAED,IAAI,SAAS,GAAY,EAAE,CAAC;IAE5B,IAAI;QACF,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5D,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACrD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CACb,+FAA+F,MAAM,CAAC,KAAK,CAAC,EAAE,CAC/G,CAAC;KACH;IAED,OAAO,eAAe,CAAC;QACrB,SAAS;QACT,QAAQ;QACR,cAAc;KACf,CAAC,CAAC;AACL,CAAC;AAED,OAAO,EACL,6BAA6B,EAC7B,mBAAmB,EACnB,eAAe,EACf,iBAAiB,GAClB,CAAC"}

package/dist/configs/{js.js → eslint.js}

@@ -6,9 +6,10 @@ import js from '@eslint/js';
 import tsParser from '@typescript-eslint/parser';
 import { FlatCompat } from '@eslint/eslintrc';
 import { fixupPluginRules } from '@eslint/compat';
-import prettierOptions from './prettier.config.mjs';
+import prettierOptions from './prettier.config.js';
 import matrixaiPlugin from '../plugins/eslint-plugin-matrixai.js';
-import { resolveMatrixConfig } from '../utils.js';
+import { resolveLintConfig } from '../config.js';
+const resolvedLintConfig = resolveLintConfig();
 const filename = fileURLToPath(import.meta.url);
 const dirname = path.dirname(filename);
 const compat = new FlatCompat({
@@ -39,7 +40,7 @@ const config = [
             ecmaVersion: 5,
             sourceType: 'module',
             parserOptions: {
-                project: resolveMatrixConfig().tsconfigPaths,
+                project: resolvedLintConfig.domains.eslint.tsconfigPaths,
             },
         },
         rules: {
@@ -246,4 +247,4 @@ const config = [
     },
 ];
 export default config;
-//# sourceMappingURL=js.js.map
+//# sourceMappingURL=eslint.js.map