Skip to content

Interface: AttwOptions

Defined in: src/features/attw.ts:17

Extends

  • CheckPackageOptions

Properties

entrypoints?

ts
optional entrypoints: string[];

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.2/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

ts
CheckPackageOptions.entrypoints;

entrypointsLegacy?

ts
optional entrypointsLegacy: boolean;

Defined in: node_modules/.pnpm/@arethetypeswrong+core@0.18.2/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

ts
CheckPackageOptions.entrypointsLegacy;

excludeEntrypoints?

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

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

Entrypoints to exclude from checking.

Inherited from

ts
CheckPackageOptions.excludeEntrypoints;

includeEntrypoints?

ts
optional includeEntrypoints: string[];

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

Entrypoints to check in addition to automatically discovered ones.

Inherited from

ts
CheckPackageOptions.includeEntrypoints;

level?

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

Defined in: src/features/attw.ts:39

The level of the check.

The available levels are:

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

Default

ts
"warn";

profile?

ts
optional profile: "strict" | "node16" | "esmOnly";

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

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
  • esmOnly: ignores CJS resolution failures

Default

ts
"strict";

Released under the MIT License.