Class Main

Represents the main class for updating Jest and TypeScript configurations.

Hierarchy

Cli.Abstractions.Loader
- Main

Index

Constructors

Properties

Accessors

jestConfigPath typescriptConfigPath

Methods

configure finish generate jestConfig processModuleMapper sort typescriptConfig writeJestConfig

Constructors

constructor

new Main(): Cli.Dev.Generate.Jest.Config.Main
Creates an instance of _Loader.

Returns Cli.Dev.Generate.Jest.Config.Main
Inherited from Loader.constructor
- Defined in lib/cli/abstractions/abstractions.loader.ts:16

Properties

`Protected` ora

ora: Ora = ...

Instance of the Ora abstraction for loading messages.

Accessors

`Private` jestConfigPath

get jestConfigPath(): string
Private
Gets the path to the Jest configuration file.

Returns string
Member
jestConfigPath
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:24

`Private` typescriptConfigPath

get typescriptConfigPath(): string
Private
Gets the path to the TypeScript configuration file.

Returns string
Member
typescriptConfigPath
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:36

Methods

configure

configure(): void
Configures the loader by starting a loading message.

Returns void
Inherited from Loader.configure
- Defined in lib/cli/abstractions/abstractions.loader.ts:40

finish

finish(): void
Finishes the configuration update and prints a completion message.

Returns void
Method
finish
Overrides Loader.finish
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:49

generate

generate(): Promise<void>
Generates and updates the Jest and TypeScript configurations.

Returns Promise<void>
A Promise that resolves when the generation is complete.

Method
generate
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:60

`Private` jestConfig

jestConfig(): Promise<Cli.Dev.Generate.Jest.Config.Types.Jest.ApproximateConfig>
Private
Reads and returns the Jest configuration.

Returns Promise<Cli.Dev.Generate.Jest.Config.Types.Jest.ApproximateConfig>
A Promise that resolves to the Jest configuration.

Method
jestConfig
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:193

`Private` processModuleMapper

processModuleMapper(acc, -): Record<string, string[]>
Private
Processes the module mapper entries for Jest configuration.
Parameters
- acc: Record<string, string[]>
  The accumulator object.
- -: StringAndArrayOfStrings
  The key-value pair representing module mapping.
Returns Record<string, string[]>
The updated accumulator.

Method
processModuleMapper
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:85

`Private` sort

sort(moduleNameMapper): Record<string, string[]>
Private
Sorts the module name mapper for Jest configuration.
Parameters
- moduleNameMapper: Record<string, string[]>
  The module name mapper to be sorted.
Returns Record<string, string[]>
The sorted module name mapper.

Method
sort
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:143

`Private` typescriptConfig

typescriptConfig(): Promise<Cli.Dev.Generate.Jest.Config.Types.Typescript.ApproximateConfig>
Private
Reads and returns the TypeScript configuration.

Returns Promise<Cli.Dev.Generate.Jest.Config.Types.Typescript.ApproximateConfig>
A Promise that resolves to the TypeScript configuration.

Method
typescriptConfig
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:208

`Private` writeJestConfig

writeJestConfig(config): Promise<void>
Private
Writes the updated Jest configuration to the file.
Parameters
- config: Cli.Dev.Generate.Jest.Config.Types.Jest.ApproximateConfig
  The updated Jest configuration.
Returns Promise<void>
A Promise that resolves when the write operation is complete.

Method
writeJestConfig
- Defined in lib/cli/dev/generate/jest/config/config.main.ts:180

Generated using TypeDoc