Class TactConfigManager

Manages the logic around the Tact configuration file.

Tact config describes the structure of the project, and includes the entry points to run compilation and analysis on.

Index

Methods

findProjectByName findProjectByPath getConfig getEntryPoints getProjectRoot getProjects resolveProjectPath fromConfig fromContract

Methods

findProjectByName

findProjectByName(projectName): undefined | Project
Find the project config based on the provided name.
Parameters
- projectName: ProjectName
Returns undefined | Project
- Defined in src/internals/tact/config.ts:104

findProjectByPath

findProjectByPath(projectPath): undefined | Project
Find the project config based on the provided path.
Parameters
- projectPath: string
Returns undefined | Project
- Defined in src/internals/tact/config.ts:111

getConfig

getConfig(): Config
Returns Config
- Defined in src/internals/tact/config.ts:83

getEntryPoints

getEntryPoints(): string[]
Returns absolute paths to entry points specified in the Tact configuration file.

Returns string[]
- Defined in src/internals/tact/config.ts:153

getProjectRoot

getProjectRoot(): string
Returns absolute path to the project root.

Returns string
- Defined in src/internals/tact/config.ts:90

getProjects

getProjects(): readonly Project[]
Gets projects defined within the configuration file.

Returns readonly Project[]
- Defined in src/internals/tact/config.ts:97

resolveProjectPath

resolveProjectPath(projectPath): string
Returns an absolute path or the project based on the project path.
Parameters
- projectPath: string
Returns string
- Defined in src/internals/tact/config.ts:120

`Static`fromConfig

fromConfig(tactConfigPath): TactConfigManager
Creates a TactConfigManager from a Tact configuration file typically specified by the user.
Parameters
- tactConfigPath: string
  Path to the Tact configuration file.
Returns TactConfigManager
- Defined in src/internals/tact/config.ts:32

`Static`fromContract

fromContract(projectRoot, contractPath, projectName?, vfs): TactConfigManager
Creates a TactConfigManager from a single Tact contract.
Parameters
- projectRoot: string
- contractPath: string
  Path to the Tact contract.
- projectName: ProjectName = ...
  Name of the project.
- vfs: VirtualFileSystem
  Virtual file system to manage interactions with the project files.
Returns TactConfigManager
- Defined in src/internals/tact/config.ts:47