Class TypescriptConfigContainer

Hierarchy

Component
- TypescriptConfigContainer

Constructors

constructor

new TypescriptConfigContainer(
project: Project,
options?: TypescriptConfigContainerOptions,
): TypescriptConfigContainer
Parameters
- project: Project
- options: TypescriptConfigContainerOptions = ...
Returns TypescriptConfigContainer
Overrides Component.constructor
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:92

Properties

`Readonly`configs

configs: Map<string, TypescriptConfig> = ...

Mapping of reusable configs.

`Readonly`node

node: Node

The tree node.

`Readonly`options

options: TypescriptConfigContainerOptions = ...

`Readonly`project

project: Project

`Readonly`projectPaths

projectPaths: Map<TypeScriptProject, Set<TypeScriptProject>> = ...

Mapping of project paths that will be established during pre synthesis.

`Readonly`projectReferences

projectReferences: Map<TypeScriptProject, Set<TypeScriptProject>> = ...

Methods

addTsConfigPaths

addTsConfigPaths(
fromProject: TypeScriptProject,
toProjects: TypeScriptProject[],
): this
Add tsconfig path entries for the given projects.
Parameters
- fromProject: TypeScriptProject
  Target project to modify.
- toProjects: TypeScriptProject[]
  Projects to reference.
Returns this
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:352

addTsConfigReferences

addTsConfigReferences(
fromProject: TypeScriptProject,
toProjects: TypeScriptProject[],
): this
Add tsconfig reference entries for the given projects.
Parameters
- fromProject: TypeScriptProject
  Target project to modify.
- toProjects: TypeScriptProject[]
  Projects to reference.
Returns this
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:366

`Protected`applyTsConfigPaths

applyTsConfigPaths(): void
Protected
Apply all tsconfig paths.

Returns void
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:324

`Protected`applyTsProjectReferences

applyTsProjectReferences(): void
Protected
Apply all tsconfig references.

Returns void
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:337

buildConfig

buildConfig(
project: Project,
options: TypescriptConfigContainerBuildOptions,
): TypescriptConfig
Build projen#javascript.TypescriptConfig from options.
Parameters
- project: Project
  Parent project.
- options: TypescriptConfigContainerBuildOptions
  TypescriptConfigContainerBuildOptions
Returns TypescriptConfig
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:202

buildExtendableTypeScriptConfig

buildExtendableTypeScriptConfig(
fileName: string,
options: TypeScriptCompilerOptions,
): TypescriptConfig
Build tsconfig primed for extending.
Parameters
- fileName: string
  File name of tsconfig.
- options: TypeScriptCompilerOptions
  Compiler options.
Returns TypescriptConfig
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:111

buildExtends

buildExtends(...names: string[]): TypescriptConfigExtends
Build TypescriptConfigExtends object from configs.
Parameters
- ...names: string[]
Returns TypescriptConfigExtends
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:157

`Protected`buildReference

buildReference(
fromProject: TypeScriptProject,
toProject: TypeScriptProject,
): { path: string } | undefined
Protected
Build tsconfig project reference object.
Parameters
- fromProject: TypeScriptProject
  Target to add reference to.
- toProject: TypeScriptProject
  Reference target.
Returns { path: string } | undefined
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:300

defineConfig

defineConfig<
    Options extends
        TypeScriptCompilerOptions & { overrides?: Record<string, unknown> },
>(
    name: string,
    options: Options,
): TypescriptConfigContainer
Define a new config.
Type Parameters
- Options extends TypeScriptCompilerOptions & { overrides?: Record<string, unknown> }
Parameters
- name: string
  Name of tsconfig.
- options: Options
  Compiler options.
Returns TypescriptConfigContainer
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:129

`Protected`linkProjectTsPath

linkProjectTsPath(
fromProject: TypeScriptProject,
toProject: TypeScriptProject,
): void
Protected
Add paths reference from one project to another in tsconfig.json
Parameters
- fromProject: TypeScriptProject
  Target to add path to.
- toProject: TypeScriptProject
  Target of the path.
Returns void
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:273

mergeTsConfigFiles

mergeTsConfigFiles<ConfigT extends { exclude: string[]; include: string[] }>(
base?: ConfigT,
paths?: { exclude?: string[]; include?: string[] },
): { exclude: string[]; include: string[] }
Merge two tsconfig include/exclude files.
Type Parameters
- ConfigT extends { exclude: string[]; include: string[] }
Parameters
- Optionalbase: ConfigT
  Base config.
- Optionalpaths: { exclude?: string[]; include?: string[] }
  Override config.
Returns { exclude: string[]; include: string[] }
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:171

mergeTsConfigs

mergeTsConfigs(
base: TypescriptConfigOptions,
override: TypescriptConfigOptions,
): TypescriptConfigOptions
Merge two tsconfig objects.
Parameters
- base: TypescriptConfigOptions
  Base config.
- override: TypescriptConfigOptions
  Override config.
Returns TypescriptConfigOptions
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:188

postSynthesize

postSynthesize(): void
Called after synthesis. Order is not guaranteed.

Returns void
Inherited from Component.postSynthesize
- Defined in node_modules/.pnpm/projen@0.99.23_constructs@10.6.0/node_modules/projen/lib/component.d.ts:26

preSynthesize

preSynthesize(): void
Returns void
Inherit Doc
Overrides Component.preSynthesize
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:381

synthesize

synthesize(): void
Synthesizes files to the project output directory.

Returns void
Inherited from Component.synthesize
- Defined in node_modules/.pnpm/projen@0.99.23_constructs@10.6.0/node_modules/projen/lib/component.d.ts:22

toString

toString(): string
Returns a string representation of this construct.

Returns string
Inherited from Component.toString
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:314

with

with(...mixins: IMixin[]): IConstruct
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
Parameters
- ...mixins: IMixin[]
  The mixins to apply
Returns IConstruct
This construct for chaining
Inherited from Component.with
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:310

`Static`ensure

ensure(
project: Project,
options?: TypescriptConfigContainerOptions,
): TypescriptConfigContainer
Find the nearest config container up project ancestry or create one.
Parameters
- project: Project
  target project.
- Optionaloptions: TypescriptConfigContainerOptions
  TypescriptConfigContainerOptions used to create new config container if needed.
Returns TypescriptConfigContainer
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:52

`Static`isComponent

isComponent(x: any): x is Component
Test whether the given construct is a component.
Parameters
- x: any
Returns x is Component
Inherited from Component.isComponent
- Defined in node_modules/.pnpm/projen@0.99.23_constructs@10.6.0/node_modules/projen/lib/component.d.ts:12

`Static`isConstruct

isConstruct(x: any): x is Construct
Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
- x: any
  Any object
Returns x is Construct
true if x is an object created from a class which extends Construct.
Inherited from Component.isConstruct
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:285

`Static`nearest

nearest(project: Project): TypescriptConfigContainer | undefined
Find nearest config container up project ancestry.
Parameters
- project: Project
Returns TypescriptConfigContainer | undefined
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:65

`Static`of

of(project: Project): TypescriptConfigContainer | undefined
Parameters
- project: Project
Returns TypescriptConfigContainer | undefined
- Defined in packages/projen/component/tsconfig-container/src/tsconfig-container.ts:40

Class TypescriptConfigContainer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TypescriptConfigContainer

Properties

Readonlyconfigs

Readonlynode

Readonlyoptions

Readonlyproject

ReadonlyprojectPaths

ReadonlyprojectReferences

Methods

addTsConfigPaths

Parameters

Returns this

addTsConfigReferences

Parameters

Returns this

ProtectedapplyTsConfigPaths

Returns void

ProtectedapplyTsProjectReferences

Returns void

buildConfig

Parameters

Returns TypescriptConfig

buildExtendableTypeScriptConfig

Parameters

Returns TypescriptConfig

buildExtends

Parameters

Returns TypescriptConfigExtends

ProtectedbuildReference

Parameters

Returns { path: string } | undefined

defineConfig

Type Parameters

Parameters

Returns TypescriptConfigContainer

ProtectedlinkProjectTsPath

Parameters

Returns void

mergeTsConfigFiles

Type Parameters

Parameters

Returns { exclude: string[]; include: string[] }

mergeTsConfigs

Parameters

Returns TypescriptConfigOptions

postSynthesize

Returns void

preSynthesize

Returns void

Inherit Doc

synthesize

Returns void

toString

Returns string

with

Parameters

Returns IConstruct

Staticensure

Parameters

Returns TypescriptConfigContainer

StaticisComponent

Parameters

Returns x is Component

StaticisConstruct

Parameters

Returns x is Construct

Staticnearest

Parameters

Returns TypescriptConfigContainer | undefined

Staticof

Parameters

`Readonly`configs

`Readonly`node

`Readonly`options

`Readonly`project

`Readonly`projectPaths

`Readonly`projectReferences

`Protected`applyTsConfigPaths

`Protected`applyTsProjectReferences

`Protected`buildReference

`Protected`linkProjectTsPath

`Static`ensure

`Static`isComponent

`Static`isConstruct

`Static`nearest

`Static`of