Interface: AttwOptions

Defined in: src/features/pkg/attw.ts:29

Extends

• CheckPackageOptions

Properties

entrypoints?

optional entrypoints?: string[];

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.5/node_modules/@arethetypeswrong/core/dist/checkPackage.d.ts:9

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

Inherited from

CheckPackageOptions.entrypoints

---

entrypointsLegacy?

optional entrypointsLegacy?: boolean;

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.5/node_modules/@arethetypeswrong/core/dist/checkPackage.d.ts:22

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

Inherited from

CheckPackageOptions.entrypointsLegacy

---

excludeEntrypoints?

optional excludeEntrypoints?: (string | RegExp)[];

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.5/node_modules/@arethetypeswrong/core/dist/checkPackage.d.ts:17

Entrypoints to exclude from checking.

Inherited from

CheckPackageOptions.excludeEntrypoints

---

ignoreRules?

optional ignoreRules?: (
  | string & object
  | "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")[];

Defined in: src/features/pkg/attw.ts:82

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

Example

ignoreRules: ['no-resolution', 'false-cjs']

Default

;[]

Unique Items

---

includeEntrypoints?

optional includeEntrypoints?: string[];

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.5/node_modules/@arethetypeswrong/core/dist/checkPackage.d.ts:13

Entrypoints to check in addition to automatically discovered ones.

Inherited from

CheckPackageOptions.includeEntrypoints

---

level?

optional level?: "error" | "warn";

Defined in: src/features/pkg/attw.ts:54

The level of the check.

The available levels are:

• error: fails the build
• warn: warns the build

Default

'warn'

---

module?

optional module?: __module;

Defined in: src/features/pkg/attw.ts:31

Ts-ignore

• optional dep

---

profile?

optional profile?: "strict" | "node16" | "esm-only";

Defined in: src/features/pkg/attw.ts:44

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

Default

'strict'