Class ProjectInspector

Describes a project from its resolved toolchain configuration and the project model. Reads package.json, cell*.yml and manifest.json only: no project code runs and nothing is built, so it returns quickly and is safe to call from agents and editors (docs/design/agent-first.md R2).

Index

Constructors

constructor

new ProjectInspector(
    config: ResolvedConfig,
    preset: Preset,
    presets: string[],
    contributions?: { modules?: ModuleRegistrations[]; projectOptions?: any },
): ProjectInspector
Parameters
- config: ResolvedConfig
- preset: Preset
- presets: string[]
- contributions: { modules?: ModuleRegistrations[]; projectOptions?: any } = {}
  What toolchain modules contributed: project options (DI modules, entries) and their registrations.
Returns ProjectInspector
- Defined in dev-packages/cli/src/info/project-inspector.ts:118

Properties

`Protected` `Readonly`config

config: ResolvedConfig

`Protected` `Readonly`contributions

contributions: { modules?: ModuleRegistrations[]; projectOptions?: any } = {}

What toolchain modules contributed: project options (DI modules, entries) and their registrations.

`Readonly`issues

issues: CheckIssue[] = []

What cell info warns about, with stable codes for cell check.

`Protected` `Readonly`preset

preset: Preset

`Protected` `Readonly`presets

presets: string[]

`Static` `Readonly`COMMAND_MODES

COMMAND_MODES: string[] = ...

`Static` `Readonly`MODE_FILE

MODE_FILE: RegExp = ...

Accessors

warnings

get warnings(): string[]
Returns string[]
- Defined in dev-packages/cli/src/info/project-inspector.ts:110

Methods

`Protected`availableModes

availableModes(model: ProjectModel): string[]
Modes with a cell.<mode>.yml in the project or any of its components, active or not.
Parameters
- model: ProjectModel
Returns string[]
- Defined in dev-packages/cli/src/info/project-inspector.ts:344

`Protected`check

check(model: ProjectModel): void
Settings that cell build would accept but that change nothing or fail: say so before the build does.
Parameters
- model: ProjectModel
Returns void
- Defined in dev-packages/cli/src/info/project-inspector.ts:312

`Protected`component

component(component: ComponentInfo): ComponentSummary
Parameters
- component: ComponentInfo
Returns ComponentSummary
- Defined in dev-packages/cli/src/info/project-inspector.ts:269

inspect

inspect(options?: InspectOptions): ProjectInfo
Parameters
- options: InspectOptions = {}
Returns ProjectInfo
- Defined in dev-packages/cli/src/info/project-inspector.ts:126

`Protected`output

output(): OutputSummary
Returns OutputSummary
- Defined in dev-packages/cli/src/info/project-inspector.ts:296

`Protected`relative

relative(path: string): string
Parameters
- path: string
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:349

`Protected`target

target(model: TargetModel, appConfig: boolean): TargetSummary
Parameters
- model: TargetModel
- appConfig: boolean
Returns TargetSummary
- Defined in dev-packages/cli/src/info/project-inspector.ts:284

`Protected`targetSources

targetSources(model: ProjectModel): Partial<Record<TestApp, string[]>>
Parameters
- model: ProjectModel
Returns Partial<Record<TestApp, string[]>>
- Defined in dev-packages/cli/src/info/project-inspector.ts:256

`Protected`warn

warn(code: string, message: string, file?: string): void
Parameters
- code: string
- message: string
- Optionalfile: string
Returns void
- Defined in dev-packages/cli/src/info/project-inspector.ts:114

`Static`envProblemWarning

envProblemWarning(
target: Target,
problem: { message: string; variable: string },
): string
Parameters
- target: Target
- problem: { message: string; variable: string }
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:220

`Static`format

format(info: ProjectInfo): string
The human form of ProjectInfo: a short summary; --json has the details.
Parameters
- info: ProjectInfo
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:173

`Static`formatModule

formatModule(spec: ModuleSpec): string
Parameters
- spec: ModuleSpec
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:243

`Static`formatToolchainModule

formatToolchainModule(module: ModuleRegistrations): string
@x/ui (2 vite plugins, 1 check): what a module registered, counted.
Parameters
- module: ModuleRegistrations
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:225

`Static`missingEntryWarning

missingEntryWarning(preset: Preset): string
Parameters
- preset: Preset
Returns string
- Defined in dev-packages/cli/src/info/project-inspector.ts:216

Class ProjectInspector

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProjectInspector

Properties

Protected Readonlyconfig

Protected Readonlycontributions

Readonlyissues

Protected Readonlypreset

Protected Readonlypresets

Static ReadonlyCOMMAND_MODES

Static ReadonlyMODE_FILE

Accessors

warnings

Returns string[]

Methods

ProtectedavailableModes

Parameters

Returns string[]

Protectedcheck

Parameters

Returns void

Protectedcomponent

Parameters

Returns ComponentSummary

inspect

Parameters

Returns ProjectInfo

Protectedoutput

Returns OutputSummary

Protectedrelative

Parameters

Returns string

Protectedtarget

Parameters

Returns TargetSummary

ProtectedtargetSources

Parameters

Returns Partial<Record<TestApp, string[]>>

Protectedwarn

Parameters

Returns void

StaticenvProblemWarning

Parameters

Returns string

Staticformat

Parameters

Returns string

StaticformatModule

Parameters

Returns string

StaticformatToolchainModule

Parameters

Returns string

StaticmissingEntryWarning

Parameters

Returns string

Settings

On This Page

`Protected` `Readonly`config

`Protected` `Readonly`contributions

`Readonly`issues

`Protected` `Readonly`preset

`Protected` `Readonly`presets

`Static` `Readonly`COMMAND_MODES

`Static` `Readonly`MODE_FILE

`Protected`availableModes

`Protected`check

`Protected`component

`Protected`output

`Protected`relative

`Protected`target

`Protected`targetSources

`Protected`warn

`Static`envProblemWarning

`Static`format

`Static`formatModule

`Static`formatToolchainModule

`Static`missingEntryWarning