KC's Workspace
    Preparing search index...

    Interface AttwOptions

    interface AttwOptions {
        entrypoints?: string[];
        entrypointsLegacy?: boolean;
        excludeEntrypoints?: (string | RegExp)[];
        ignoreRules?: (
            | "no-resolution"
            | "untyped-resolution"
            | "false-cjs"
            | "false-esm"
            | "cjs-resolves-to-esm"
            | "fallback-condition"
            | "cjs-only-exports-default"
            | "named-exports"
            | "false-export-default"
            | "missing-export-equals"
            | "unexpected-module-syntax"
            | "internal-resolution-error"
            | string & {}
        )[];
        includeEntrypoints?: string[];
        level?: "error"
        | "warn";
        module?: node_modules/.pnpm/@[email protected]/node_modules/@arethetypeswrong/core/dist;
        profile?: "strict" | "esm-only" | "node16";
    }

    Hierarchy (View Summary)

    Index
    entrypoints? entrypointsLegacy? excludeEntrypoints? ignoreRules? includeEntrypoints? level? module? profile?
    entrypoints?: string[]

    Exhaustive list of entrypoints to check. The package root is ".". Specifying this option disables automatic entrypoint discovery, and overrides the includeEntrypoints and excludeEntrypoints options.

    entrypointsLegacy?: boolean

    Whether to automatically consider all published files as entrypoints in the absence of any other detected or configured entrypoints.

    excludeEntrypoints?: (string | RegExp)[]

    Entrypoints to exclude from checking.

    ignoreRules?: (
        | "no-resolution"
        | "untyped-resolution"
        | "false-cjs"
        | "false-esm"
        | "cjs-resolves-to-esm"
        | "fallback-condition"
        | "cjs-only-exports-default"
        | "named-exports"
        | "false-export-default"
        | "missing-export-equals"
        | "unexpected-module-syntax"
        | "internal-resolution-error"
        | string & {}
    )[]

    List of problem types to ignore by rule name.

    The available values are:

    • no-resolution
    • untyped-resolution
    • false-cjs
    • false-esm
    • cjs-resolves-to-esm
    • fallback-condition
    • cjs-only-exports-default
    • named-exports
    • false-export-default
    • missing-export-equals
    • unexpected-module-syntax
    • internal-resolution-error
    ignoreRules: ['no-resolution', 'false-cjs']

    []
    includeEntrypoints?: string[]

    Entrypoints to check in addition to automatically discovered ones.

    level?: "error" | "warn"

    The level of the check.

    The available levels are:

    • error: fails the build
    • warn: warns the build
    'warn'
    module?: node_modules/.pnpm/@[email protected]/node_modules/@arethetypeswrong/core/dist
    profile?: "strict" | "esm-only" | "node16"

    Profiles select a set of resolution modes to require/ignore. All are evaluated but failures outside of those required are ignored.

    The available profiles are:

    • strict: requires all resolutions
    • node16: ignores node10 resolution failures
    • esm-only: ignores CJS resolution failures
    'strict'

    Settings
    Member Visibility

    On This Page
    Properties