@pho9ubenaa/siro 0.1.3 → 0.3.0

package/dist/index.d.mts

@@ -47,7 +47,8 @@ interface IO {
 declare const nodeIO: IO;
 //#endregion
 //#region src/domain/entities/config-value.d.ts
-type CodecKind = 'npmrc' | 'yaml' | 'toml' | 'json';
+declare const CODEC_KINDS: readonly ["json", "npmrc", "toml", "yaml"];
+type CodecKind = (typeof CODEC_KINDS)[number];
 /** Scalar value that can be written back to a config file. */
 type ConfigValue = string | number | boolean;
 /** Scalar value as it appears when reading (codecs may produce `null`). */
@@ -106,6 +107,10 @@ declare const PackageJsonSchema: vb.LooseObjectSchema<{
 }, undefined>;
 type PackageJson = vb.InferOutput<typeof PackageJsonSchema>;
 //#endregion
+//#region src/domain/entities/project-type.d.ts
+declare const PROJECT_TYPES: readonly ["application", "package"];
+type ProjectType = (typeof PROJECT_TYPES)[number];
+//#endregion
 //#region src/domain/ports/repo-context.d.ts
 /** Read-only view of a repository, passed to every rule's `check` and `fix`. */
 interface RepoContext {
@@ -113,6 +118,7 @@ interface RepoContext {
   exists: (relPath: RelPath) => boolean;
   readText: (relPath: RelPath) => string | undefined;
   readonly packageJson: PackageJson | undefined;
+  readonly projectType?: ProjectType;
 }
 //#endregion
 //#region src/domain/entities/rule.d.ts
@@ -178,6 +184,12 @@ type FixOp = {
  * - `advisory`: `fix` only produces notes/ensureFileTracked hints.
  */
 type FixKind = 'auto' | 'advisory';
+/** Display-only package-manager version metadata. */
+interface VersionNote {
+  readonly configAvailableSince?: string;
+  readonly defaultSafeSince?: string;
+  readonly note?: string;
+}
 type SetKeyOp = Extract<FixOp, {
   op: 'setKey';
 }>;
@@ -197,6 +209,7 @@ interface AutoRuleBinding {
    * override always wins over both.
    */
   readonly severity?: Severity;
+  readonly versionNote?: VersionNote;
   check: (ctx: RepoContext, config: ParsedConfig) => CheckStatus;
   fix: (ctx: RepoContext) => readonly SetKeyOp[];
 }
@@ -207,17 +220,20 @@ interface AdvisoryRuleBinding {
   readonly docs?: string;
   /** See {@link AutoRuleBinding.severity}. */
   readonly severity?: Severity;
+  readonly versionNote?: VersionNote;
   check: (ctx: RepoContext, config: ParsedConfig) => CheckStatus;
   fix: (ctx: RepoContext) => readonly AdvisoryOp[];
 }
 type RuleBinding = AutoRuleBinding | AdvisoryRuleBinding;
 /** A package-manager-agnostic security intent, realized per PM via `bindings`. */
-interface Rule {
-  readonly id: string;
+interface Rule<Id extends string = string> {
+  readonly id: Id;
   readonly title: string;
   readonly description: string;
   readonly severity: Severity;
   readonly docs?: string;
+  /** Project types this rule applies to; omission means both types. */
+  readonly projectTypes?: readonly ProjectType[];
   /** Absence of a PM key means the rule does not apply (N/A) to that PM. */
   readonly bindings: Partial<Record<PM, RuleBinding>>;
 }
@@ -317,6 +333,8 @@ interface LintOptions {
   cwd: AbsPath;
   /** Restrict to a single PM; otherwise PMs are auto-detected. */
   pm?: PM;
+  /** Select application or published-package policy; otherwise infer it. */
+  projectType?: ProjectType;
   /** Reporter name or instance; defaults to `pretty`. */
   reporter?: string | Reporter;
   /** Extra reporters to make available by name (merged with the user config). */
@@ -334,7 +352,7 @@ interface LintOptions {
   severity?: Severity;
   /**
    * Inject a non-default FS (e.g. memfs in tests). Caveat: `siro.config.{ts,mjs,js}`
-   * is loaded by jiti from the REAL disk — only the config's existence is probed
+   * is imported from the REAL disk — only the config's existence is probed
    * through this FS. A config that lives solely in an injected FS won't load.
    */
   fs?: FileSystem;
@@ -431,13 +449,9 @@ declare const PM_SIGNALS: {
   };
 };
 //#endregion
-//#region src/domain/entities/rule-id.d.ts
-/**
- * Closed set of built-in rule IDs. Declared in `domain/` so SiroConfig can
- * type `rules` keys without depending on the engine.
- */
-declare const BUILTIN_RULE_IDS: readonly ["advisory-check", "approved-git-repos", "audit-suppression", "block-auto-install", "block-exotic-subdeps", "bun-security-scanner", "checksum-verification", "commit-lockfile", "dependency-overrides", "disable-lifecycle-scripts", "enforce-strict-ssl", "files-field", "frozen-lockfile", "frozen-store", "hardened-mode", "minimum-release-age", "named-registries", "paranoid-mode", "patched-dependencies", "pin-exact-versions", "provenance", "publish-access", "store-server", "strict-allow-scripts", "strict-release-age", "strict-store-integrity", "trust-policy"];
-type BuiltinRuleId = (typeof BUILTIN_RULE_IDS)[number];
+//#region src/domain/builtin-rules.d.ts
+declare const rules: readonly [Rule<"advisory-check">, Rule<"approved-git-repos">, Rule<"audit-suppression">, Rule<"block-auto-install">, Rule<"block-exotic-subdeps">, Rule<"bun-security-scanner">, Rule<"checksum-verification">, Rule<"commit-lockfile">, Rule<"dependency-overrides">, Rule<"disable-lifecycle-scripts">, Rule<"enforce-strict-ssl">, Rule<"files-field">, Rule<"frozen-lockfile">, Rule<"frozen-store">, Rule<"hardened-mode">, Rule<"minimum-release-age">, Rule<"named-registries">, Rule<"paranoid-mode">, Rule<"patched-dependencies">, Rule<"pin-exact-versions">, Rule<"provenance">, Rule<"publish-access">, Rule<"store-server">, Rule<"strict-allow-scripts">, Rule<"strict-release-age">, Rule<"strict-store-integrity">, Rule<"trust-policy">];
+type BuiltinRuleId = (typeof rules)[number]['id'];
 //#endregion
 //#region src/domain/entities/siro-config.d.ts
 /** Per-rule setting. `'off'` disables; a Severity overrides the default level. */
@@ -454,6 +468,7 @@ type RuleSetting = Severity | 'off';
  */
 interface SiroConfig {
   readonly pms?: readonly PM[];
+  readonly projectType?: ProjectType;
   readonly rules?: Readonly<Partial<Record<BuiltinRuleId | (string & Record<never, never>), RuleSetting>>>;
   readonly customRules?: readonly Rule[];
   readonly reporters?: readonly Reporter[];
@@ -470,21 +485,6 @@ interface ConfigCodec {
 type CodecFor = (kind: CodecKind) => ConfigCodec;
 //#endregion
 //#region src/domain/rules/builders/require-config-key.d.ts
-/**
- * Display-only metadata for a binding. siro itself is intentionally
- * version-agnostic (we never branch on the user's actual PM version) — these
- * fields exist so the rendered message can still tell the reader *when* a key
- * appeared and *when* the PM started shipping a safe default. They MUST NOT
- * be consulted by any code path that decides severity or applicability.
- */
-interface VersionNote {
-  /** PM version that first shipped this config key (e.g. `'pnpm 10.16.0'`). */
-  readonly configAvailableSince?: string;
-  /** PM version whose built-in default first satisfies the rule (e.g. `'pnpm 11.0.0 (1440 minutes)'`). */
-  readonly defaultSafeSince?: string;
-  /** Free-form trailing note rendered last (e.g. `'replaces auto-install-peers'`). */
-  readonly note?: string;
-}
 interface RequireConfigKeySpec {
   readonly file: ConfigFileRef;
   readonly keyPath: KeyPath;
@@ -524,12 +524,13 @@ interface RequireConfigKeySpec {
   readonly defaultSatisfiedSeverity?: Severity | 'off';
   readonly versionNote?: VersionNote;
 }
-interface RequireConfigKeyOptions {
-  readonly id: string;
+interface RequireConfigKeyOptions<Id extends string = string> {
+  readonly id: Id;
   readonly title: string;
   readonly description: string;
   readonly severity: Severity;
   readonly docs?: string;
+  readonly projectTypes?: Rule['projectTypes'];
   /** Bindings keyed by PM. PMs absent from this map are treated as N/A. */
   readonly bindings: Partial<Record<PM, RequireConfigKeySpec>>;
   /** Return false to short-circuit `check` as N/A (e.g. private packages). */
@@ -542,10 +543,12 @@ interface RequireConfigKeyOptions {
  * the hand-written bindings in via this helper rather than rebuilding from
  * scratch or mutating the source rule.
  */
-declare const overrideBindings: (rule: Rule, overrides: Partial<Rule["bindings"]>) => Rule;
-declare const renderVersionNoteMessage: (message: string, versionNote: VersionNote | undefined) => string;
+declare const overrideBindings: <Id extends string>(rule: Rule<Id>, overrides: Partial<Rule["bindings"]>) => Rule<Id>;
 /** Build a Rule from a per-PM table of {file, keyPath, value, message}. */
-declare const requireConfigKey: (options: RequireConfigKeyOptions) => Rule;
+declare const requireConfigKey: <const Id extends string>(options: RequireConfigKeyOptions<Id>) => Rule<Id>;
+//#endregion
+//#region src/domain/services/render-version-note.d.ts
+declare const renderVersionNoteMessage: (message: string, versionNote: VersionNote | undefined) => string;
 //#endregion
 //#region src/domain/services/detect-pms.d.ts
 declare const detectPMs: (ctx: RepoContext) => PM[];
@@ -565,11 +568,6 @@ declare const exitCodeForLint: (result: LintResult, threshold?: Severity) => num
  * place so individual commands never have to think about exit semantics.
  * The exit-code table lives in docs/configuration.md S"Exit codes" and
  * src/cli/help.ts (HELP_LINT) -- not restated here.
- *
- * One mapping note that belongs at this altitude: filesystem errno errors
- * are routed to 2 by SHAPE (numeric `errno`) in cli run(), so an
- * errno-bearing throw from a user extension also lands on 2 rather than the
- * 70 crash path -- same remedy (fix the environment) either way.
  */
 declare class SiroError extends Error {
   /** Recommended process exit code for this error. */
@@ -599,7 +597,7 @@ declare class UsageError extends SiroError {
 declare const wrapCodecError: <TResult>(filePath: string, fn: () => TResult) => TResult;
 //#endregion
 //#region src/version.d.ts
-declare const version = "0.1.3";
+declare const version = "0.3.0";
 //#endregion
-export { type AbsPath, type AdvisoryRuleBinding, type AutoRuleBinding, BUILTIN_REPORTER_NAMES, type BuiltinReporterName, CONFIG_FILES, type CheckStatus, type CodecFor, type ConfigCodec, ConfigError, type ConfigFileRef, type ConfigReadValue, type ConfigScalar, type ConfigValue, type FileSystem, type Finding, type FixKind, type FixOp, type IO, type KeyAssignment, type KeyPath, type LintOptions, type LintResult, type PM, PMS, type PMSignals, PM_SIGNALS, type PackageJson, type ParsedConfig, type RelPath, type RepoContext, type Reporter, type ReporterRegistry, type RequireConfigKeyOptions, type Rule, type RuleBinding, type RuleSetting, SEVERITIES, type Severity, type SiroConfig, SiroError, UsageError, type VersionNote, asAbsPath, asRelPath, createRegistry, defineConfig, detectPMs, exitCodeForLint, filterBySeverity, getByPath, githubReporter, isPM, isReporterShape, isSeverity, jsonReporter, lintCommand, nodeFileSystem, nodeIO, overrideBindings, prettyReporter, renderVersionNoteMessage, requireConfigKey, version, wrapCodecError };
+export { type AbsPath, type AdvisoryRuleBinding, type AutoRuleBinding, BUILTIN_REPORTER_NAMES, type BuiltinReporterName, CONFIG_FILES, type CheckStatus, type CodecFor, type ConfigCodec, ConfigError, type ConfigFileRef, type ConfigReadValue, type ConfigScalar, type ConfigValue, type FileSystem, type Finding, type FixKind, type FixOp, type IO, type KeyAssignment, type KeyPath, type LintOptions, type LintResult, type PM, PMS, type PMSignals, PM_SIGNALS, PROJECT_TYPES, type PackageJson, type ParsedConfig, type ProjectType, type RelPath, type RepoContext, type Reporter, type ReporterRegistry, type RequireConfigKeyOptions, type Rule, type RuleBinding, type RuleSetting, SEVERITIES, type Severity, type SiroConfig, SiroError, UsageError, type VersionNote, asAbsPath, asRelPath, createRegistry, defineConfig, detectPMs, exitCodeForLint, filterBySeverity, getByPath, githubReporter, isPM, isReporterShape, isSeverity, jsonReporter, lintCommand, nodeFileSystem, nodeIO, overrideBindings, prettyReporter, renderVersionNoteMessage, requireConfigKey, version, wrapCodecError };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,2 +1,9 @@
-import{A as e,C as t,D as n,E as r,O as i,S as a,T as o,_ as s,a as c,b as l,c as u,d,f,g as p,h as m,i as h,k as g,l as _,m as v,n as y,o as b,r as x,s as S,t as C,u as w,v as T,w as E,x as D,y as O}from"./node-io-BLwef7p6.mjs";const k=e=>e;export{v as BUILTIN_REPORTER_NAMES,_ as CONFIG_FILES,n as ConfigError,D as PMS,c as PM_SIGNALS,a as SEVERITIES,i as SiroError,r as UsageError,g as asAbsPath,e as asRelPath,m as createRegistry,k as defineConfig,x as detectPMs,d as exitCodeForLint,f as filterBySeverity,w as getByPath,O as githubReporter,t as isPM,l as isReporterShape,E as isSeverity,s as jsonReporter,y as lintCommand,h as nodeFileSystem,C as nodeIO,b as overrideBindings,p as prettyReporter,S as renderVersionNoteMessage,u as requireConfigKey,T as version,o as wrapCodecError};
+import { A as isSeverity, C as jsonReporter, D as PMS, E as isReporterShape, F as asAbsPath, I as asRelPath, M as UsageError, N as ConfigError, O as SEVERITIES, P as SiroError, S as prettyReporter, T as githubReporter, a as nodeFileSystem, c as requireConfigKey, d as exitCodeForLint, f as filterBySeverity, i as detectPMs, j as wrapCodecError, k as isPM, l as CONFIG_FILES, m as PROJECT_TYPES, n as lintCommand, o as PM_SIGNALS, r as renderVersionNoteMessage, s as overrideBindings, t as nodeIO, u as getByPath, v as BUILTIN_REPORTER_NAMES, w as version, x as createRegistry } from "./node-io-CUcMwlGH.mjs";
+
+//#region src/domain/entities/siro-config.ts
+/** Identity helper for type-checked config files. */
+const defineConfig = (config) => config;
+
+//#endregion
+export { BUILTIN_REPORTER_NAMES, CONFIG_FILES, ConfigError, PMS, PM_SIGNALS, PROJECT_TYPES, SEVERITIES, SiroError, UsageError, asAbsPath, asRelPath, createRegistry, defineConfig, detectPMs, exitCodeForLint, filterBySeverity, getByPath, githubReporter, isPM, isReporterShape, isSeverity, jsonReporter, lintCommand, nodeFileSystem, nodeIO, overrideBindings, prettyReporter, renderVersionNoteMessage, requireConfigKey, version, wrapCodecError };
 //# sourceMappingURL=index.mjs.map