The Nx Devkit is the underlying technology used to customize Nx to support different technologies and custom use-cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.
As with most things in Nx, the core of Nx Devkit is very simple. It only uses language primitives and immutable objects (the tree being the only exception).
- FileData
- ProjectFileMap
- ProjectGraph
- ProjectGraphDependency
- ProjectGraphExternalNode
- ProjectGraphProcessorContext
- ProjectGraphProjectNode
- ProjectGraphV4
- DefaultTasksRunnerOptions
- Hash
- JsonParseOptions
- JsonSerializeOptions
- RemoteCache
- StringDeletion
- StringInsertion
- ExecutorContext
- ExecutorsJson
- GeneratorsJson
- HasherContext
- ImplicitJsonSubsetDependency
- MigrationsJson
- NxAffectedConfig
- NxJsonConfiguration
- ProjectConfiguration
- ProjectsConfigurations
- TargetConfiguration
- TargetDependencyConfig
- Task
- TaskGraph
- Workspace
- CustomHasher
- Executor
- Generator
- GeneratorCallback
- ImplicitDependencyEntry
- ProjectType
- TaskGraphExecutor
- WorkspaceJsonConfiguration
- addDependenciesToPackageJson
- addProjectConfiguration
- applyChangesToString
- convertNxExecutor
- convertNxGenerator
- createProjectGraphAsync
- defaultTasksRunner
- detectPackageManager
- formatFiles
- generateFiles
- getOutputsForTargetAndConfiguration
- getPackageManagerCommand
- getPackageManagerVersion
- getProjects
- getWorkspaceLayout
- getWorkspacePath
- installPackagesTask
- isStandaloneProject
- joinPathFragments
- moveFilesToNewDirectory
- names
- normalizePath
- offsetFromRoot
- parseJson
- parseTargetString
- readAllWorkspaceConfiguration
- readCachedProjectGraph
- readJson
- readJsonFile
- readNxJson
- readProjectConfiguration
- readTargetOptions
- readWorkspaceConfiguration
- removeDependenciesFromPackageJson
- removeProjectConfiguration
- reverse
- runExecutor
- serializeJson
- stripIndents
- stripJsonComments
- targetToTargetString
- toJS
- updateJson
- updateProjectConfiguration
- updateTsConfigsToJs
- updateWorkspaceConfiguration
- visitNotIgnoredFiles
- workspaceLayout
- writeJson
- writeJsonFile
• DependencyType: Object
• ChangeType: Object
• ProjectGraphBuilder: Object
• Hasher: Object
• Workspaces: Object
• Target: Object
• NxPlugin: Object
A plugin for Nx
• FileData: Object
• ProjectFileMap: Object
• ProjectGraph<T
>: Object
Name | Type |
---|---|
T |
any |
• ProjectGraphDependency: Object
• ProjectGraphExternalNode: Object
• ProjectGraphProcessorContext: Object
• ProjectGraphProjectNode<T
>: Object
Name | Type |
---|---|
T |
any |
• ProjectGraphV4<T
>: Object
Name | Type |
---|---|
T |
any |
• FileChange: Object
• Tree: Object
• DefaultTasksRunnerOptions: Object
• Hash: Object
• JsonParseOptions: Object
• JsonSerializeOptions: Object
• RemoteCache: Object
• StringDeletion: Object
• StringInsertion: Object
• ExecutorContext: Object
• ExecutorsJson: Object
• GeneratorsJson: Object
• HasherContext: Object
• ImplicitJsonSubsetDependency<T
>: Object
Name | Type |
---|---|
T |
"*" | string [] |
• MigrationsJson: Object
• NxAffectedConfig: Object
• NxJsonConfiguration<T
>: Object
Name | Type |
---|---|
T |
"*" | string [] |
• ProjectConfiguration: Object
• ProjectsConfigurations: Object
• TargetConfiguration: Object
• TargetDependencyConfig: Object
• Task: Object
• TaskGraph: Object
• Workspace: Object
Ƭ WorkspaceConfiguration: Omit
<ProjectsConfigurations
, "projects"
> & Partial
<NxJsonConfiguration
>
Ƭ ProjectTargetConfigurator: (file
: string
) => Record
<string
, TargetConfiguration
>
▸ (file
): Record
<string
, TargetConfiguration
>
Name | Type |
---|---|
file |
string |
Record
<string
, TargetConfiguration
>
Ƭ PackageManager: "yarn"
| "pnpm"
| "npm"
Ƭ ProjectGraphNode<T
>: ProjectGraphProjectNode
<T
> | ProjectGraphExternalNode
Name | Type |
---|---|
T |
any |
Ƭ StringChange: StringInsertion
| StringDeletion
Ƭ CustomHasher: (task
: Task
, context
: HasherContext
) => Promise
<Hash
>
▸ (task
, context
): Promise
<Hash
>
Name | Type |
---|---|
task |
Task |
context |
HasherContext |
Promise
<Hash
>
Ƭ Executor<T
>: (options
: T
, context
: ExecutorContext
) => Promise
<Object
> | AsyncIterableIterator
<Object
>
Name | Type |
---|---|
T |
any |
▸ (options
, context
): Promise
<Object
> | AsyncIterableIterator
<Object
>
Implementation of a target of a project
Name | Type |
---|---|
options |
T |
context |
ExecutorContext |
Promise
<Object
> | AsyncIterableIterator
<Object
>
Ƭ Generator<T
>: (tree
: any
, schema
: T
) => void
| GeneratorCallback
| Promise
<void
| GeneratorCallback
>
Name | Type |
---|---|
T |
unknown |
▸ (tree
, schema
): void
| GeneratorCallback
| Promise
<void
| GeneratorCallback
>
A function that schedules updates to the filesystem to be done atomically
Name | Type |
---|---|
tree |
any |
schema |
T |
void
| GeneratorCallback
| Promise
<void
| GeneratorCallback
>
Ƭ GeneratorCallback: () => void
| Promise
<void
>
▸ (): void
| Promise
<void
>
A callback function that is executed after changes are made to the file system
void
| Promise
<void
>
Ƭ ImplicitDependencyEntry<T
>: Object
Name | Type |
---|---|
T |
"*" | string [] |
▪ [key: string
]: T
| ImplicitJsonSubsetDependency
<T
>
Ƭ ProjectType: "library"
| "application"
Ƭ TaskGraphExecutor<T
>: (taskGraph
: TaskGraph
, options
: Record
<string
, T
>, overrides
: T
, context
: ExecutorContext
) => Promise
<Record
<string
, Object
>>
Name | Type |
---|---|
T |
any |
▸ (taskGraph
, options
, overrides
, context
): Promise
<Record
<string
, Object
>>
Implementation of a target of a project that handles multiple projects to be batched
Name | Type |
---|---|
taskGraph |
TaskGraph |
options |
Record <string , T > |
overrides |
T |
context |
ExecutorContext |
Promise
<Record
<string
, Object
>>
Ƭ WorkspaceJsonConfiguration: ProjectsConfigurations
• logger: Object
Name | Type |
---|---|
debug |
(...s : any []) => void |
error |
(s : any ) => void |
fatal |
(...s : any []) => void |
info |
(s : any ) => void |
log |
(...s : any []) => void |
warn |
(s : any ) => void |
• appRootPath: string
= workspaceRoot
• cacheDir: string
• output: CLIOutput
• workspaceRoot: string
▸ addDependenciesToPackageJson(tree
, dependencies
, devDependencies
, packageJsonPath?
): GeneratorCallback
Add Dependencies and Dev Dependencies to package.json
For example:
addDependenciesToPackageJson(tree, { react: 'latest' }, { jest: 'latest' });
This will add react
and jest
to the dependencies and devDependencies sections of package.json respectively.
Name | Type | Default value | Description |
---|---|---|---|
tree |
Tree |
undefined |
Tree representing file system to modify |
dependencies |
Record <string , string > |
undefined |
Dependencies to be added to the dependencies section of package.json |
devDependencies |
Record <string , string > |
undefined |
Dependencies to be added to the devDependencies section of package.json |
packageJsonPath |
string |
'package.json' |
Path to package.json |
Callback to install dependencies only if necessary. undefined is returned if changes are not necessary.
▸ addProjectConfiguration(tree
, projectName
, projectConfiguration
, standalone?
): void
Adds project configuration to the Nx workspace.
The project configuration is stored in workspace.json or the associated project.json file. The utility will update either files.
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
projectName |
string |
unique name. Often directories are part of the name (e.g., mydir-mylib) |
projectConfiguration |
ProjectConfiguration |
project configuration |
standalone? |
boolean |
should the project use package.json? If false, the project config is inside workspace.json |
void
▸ applyChangesToString(text
, changes
): string
Applies a list of changes to a string's original value.
This is useful when working with ASTs.
For Example, to rename a property in a method's options:
const code = `bootstrap({
target: document.querySelector('#app')
})`;
const indexOfPropertyName = 13; // Usually determined by analyzing an AST.
const updatedCode = applyChangesToString(code, [
{
type: ChangeType.Insert,
index: indexOfPropertyName,
text: 'element',
},
{
type: ChangeType.Delete,
start: indexOfPropertyName,
length: 6,
},
]);
bootstrap({
element: document.querySelector('#app'),
});
Name | Type |
---|---|
text |
string |
changes |
StringChange [] |
string
▸ convertNxExecutor(executor
): any
Convert an Nx Executor into an Angular Devkit Builder
Use this to expose a compatible Angular Builder
Name | Type |
---|---|
executor |
Executor <any > |
any
▸ convertNxGenerator<T
>(generator
, skipWritingConfigInOldFormat?
): (generatorOptions
: T
) => (tree
: any
, context
: any
) => Promise
<any
>
Convert an Nx Generator into an Angular Devkit Schematic.
Name | Type |
---|---|
T |
any |
Name | Type | Default value | Description |
---|---|---|---|
generator |
Generator <T > |
undefined |
The Nx generator to convert to an Angular Devkit Schematic. |
skipWritingConfigInOldFormat |
boolean |
false |
Whether to skip writing the configuration in the old format (the one used by the Angular DevKit). |
fn
▸ (generatorOptions
): (tree
: any
, context
: any
) => Promise
<any
>
Name | Type |
---|---|
generatorOptions |
T |
fn
▸ (tree
, context
): Promise
<any
>
Name | Type |
---|---|
tree |
any |
context |
any |
Promise
<any
>
▸ createProjectGraphAsync(): Promise
<ProjectGraph
>
Computes and returns a ProjectGraph.
Nx will compute the graph either in a daemon process or in the current process.
Nx will compute it in the current process if:
- The process is running in CI (CI env variable is to true or other common variables used by CI providers are set).
- It is running in the docker container.
- The daemon process is disabled because of the previous error when starting the daemon.
NX_DAEMON
is set tofalse
.useDaemon
is set to false innx.json
NX_DAEMON
env variable takes precedence:
- If it is set to true, the daemon will always be used.
- If it is set to false, the graph will always be computed in the current process.
Tip: If you want to debug project graph creation, run your command with NX_DAEMON=false.
Nx uses two layers of caching: the information about explicit dependencies stored on the disk and the information
stored in the daemon process. To reset both run: nx reset
.
Promise
<ProjectGraph
>
▸ Const
defaultTasksRunner(tasks
, options
, context?
): any
Name | Type |
---|---|
tasks |
Task [] |
options |
DefaultTasksRunnerOptions |
context? |
Object |
context.initiatingProject? |
string |
context.nxArgs |
NxArgs |
context.nxJson |
NxJsonConfiguration <string [] | "*" > |
context.projectGraph |
ProjectGraph <any > |
context.target? |
string |
context.taskGraph? |
TaskGraph |
any
▸ detectPackageManager(dir?
): PackageManager
Detects which package manager is used in the workspace based on the lock file.
Name | Type | Default value |
---|---|---|
dir |
string |
'' |
▸ formatFiles(tree
): Promise
<void
>
Formats all the created or updated files using Prettier
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
Promise
<void
>
▸ generateFiles(tree
, srcFolder
, target
, substitutions
): void
Generates a folder of files based on provided templates.
While doing so it performs two substitutions:
- Substitutes segments of file names surrounded by __
- Uses ejs to substitute values in templates
Examples:
generateFiles(tree, path.join(__dirname, 'files'), './tools/scripts', {
tmpl: '',
name: 'myscript',
});
This command will take all the files from the files
directory next to the place where the command is invoked from.
It will replace all __tmpl__
with '' and all __name__
with 'myscript' in the file names, and will replace all
<%= name %>
with myscript
in the files themselves.
tmpl: ''
is a common pattern. With it you can name files like this: index.ts__tmpl__
, so your editor
doesn't get confused about incorrect TypeScript files.
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
srcFolder |
string |
the source folder of files (absolute path) |
target |
string |
the target folder (relative to the tree root) |
substitutions |
Object |
an object of key-value pairs |
void
▸ getOutputsForTargetAndConfiguration(task
, node
): any
Returns the list of outputs that will be cached.
Name | Type | Description |
---|---|---|
task |
Pick <Task , "target" | "overrides" > |
target + overrides |
node |
ProjectGraphProjectNode <any > |
ProjectGraphProjectNode object that the task runs against |
any
▸ getPackageManagerCommand(packageManager?
): PackageManagerCommands
Returns commands for the package manager used in the workspace. By default, the package manager is derived based on the lock file, but it can also be passed in explicitly.
Example:
execSync(`${getPackageManagerCommand().addDev} my-dev-package`);
Name | Type |
---|---|
packageManager |
PackageManager |
PackageManagerCommands
▸ getPackageManagerVersion(packageManager?
): string
Returns the version of the package manager used in the workspace. By default, the package manager is derived based on the lock file, but it can also be passed in explicitly.
Name | Type |
---|---|
packageManager |
PackageManager |
string
▸ getProjects(tree
): Map
<string
, ProjectConfiguration
>
Get a map of all projects in a workspace.
Use readProjectConfiguration if only one project is needed.
Name | Type |
---|---|
tree |
Tree |
Map
<string
, ProjectConfiguration
>
▸ getWorkspaceLayout(tree
): Object
Returns workspace defaults. It includes defaults folders for apps and libs, and the default scope.
Example:
{ appsDir: 'apps', libsDir: 'libs', npmScope: 'myorg' }
Name | Type | Description |
---|---|---|
tree |
Tree |
file system tree |
Object
Name | Type |
---|---|
appsDir |
string |
libsDir |
string |
npmScope |
string |
standaloneAsDefault |
boolean |
▸ getWorkspacePath(tree
): "/angular.json"
| "/workspace.json"
| null
Name | Type |
---|---|
tree |
Tree |
"/angular.json"
| "/workspace.json"
| null
▸ installPackagesTask(tree
, alwaysRun?
, cwd?
, packageManager?
): void
Runs npm install
or yarn install
. It will skip running the install if
package.json
hasn't changed at all or it hasn't changed since the last invocation.
Name | Type | Default value | Description |
---|---|---|---|
tree |
Tree |
undefined |
the file system tree |
alwaysRun |
boolean |
false |
always run the command even if package.json hasn't changed. |
cwd |
string |
'' |
- |
packageManager |
PackageManager |
undefined |
- |
void
▸ isStandaloneProject(tree
, project
): boolean
Returns if a project has a standalone configuration (project.json).
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
project |
string |
the project name |
boolean
▸ joinPathFragments(...fragments
): string
Normalized path fragments and joins them
Name | Type |
---|---|
...fragments |
string [] |
string
▸ moveFilesToNewDirectory(tree
, oldDir
, newDir
): void
Analogous to cp -r oldDir newDir
Name | Type |
---|---|
tree |
Tree |
oldDir |
string |
newDir |
string |
void
▸ names(name
): Object
Util function to generate different strings based off the provided name.
Examples:
names('my-name'); // {name: 'my-name', className: 'MyName', propertyName: 'myName', constantName: 'MY_NAME', fileName: 'my-name'}
names('myName'); // {name: 'myName', className: 'MyName', propertyName: 'myName', constantName: 'MY_NAME', fileName: 'my-name'}
Name | Type |
---|---|
name |
string |
Object
Name | Type |
---|---|
className |
string |
constantName |
string |
fileName |
string |
name |
string |
propertyName |
string |
▸ normalizePath(osSpecificPath
): string
Coverts an os specific path to a unix style path
Name | Type |
---|---|
osSpecificPath |
string |
string
▸ offsetFromRoot(fullPathToDir
): string
Calculates an offset from the root of the workspace, which is useful for constructing relative URLs.
Examples:
offsetFromRoot('apps/mydir/myapp/'); // returns "../../../"
Name | Type | Description |
---|---|---|
fullPathToDir |
string |
directory path |
string
▸ parseJson<T
>(input
, options?
): T
Parses the given JSON string and returns the object the JSON content represents. By default javascript-style comments are allowed.
Name | Type |
---|---|
T |
extends object = any |
Name | Type | Description |
---|---|---|
input |
string |
JSON content as string |
options? |
JsonParseOptions |
JSON parse options |
T
Object the JSON content represents
▸ parseTargetString(targetString
): Target
Parses a target string into {project, target, configuration}
Examples:
parseTargetString('proj:test'); // returns { project: "proj", target: "test" }
parseTargetString('proj:test:production'); // returns { project: "proj", target: "test", configuration: "production" }
Name | Type | Description |
---|---|---|
targetString |
string |
target reference |
▸ readAllWorkspaceConfiguration(): ProjectsConfigurations
& NxJsonConfiguration
ProjectsConfigurations
& NxJsonConfiguration
▸ readCachedProjectGraph(): ProjectGraph
Synchronously reads the latest cached copy of the workspace's ProjectGraph.
throws
{Error} if there is no cached ProjectGraph to read from
▸ readJson<T
>(tree
, path
, options?
): T
Reads a json file, removes all comments and parses JSON.
Name | Type |
---|---|
T |
extends object = any |
Name | Type | Description |
---|---|---|
tree |
Tree |
file system tree |
path |
string |
file path |
options? |
JsonParseOptions |
Optional JSON Parse Options |
T
▸ readJsonFile<T
>(path
, options?
): T
Reads a JSON file and returns the object the JSON content represents.
Name | Type |
---|---|
T |
extends object = any |
Name | Type | Description |
---|---|---|
path |
string |
A path to a file. |
options? |
JsonReadOptions |
JSON parse options |
T
Object the JSON content of the file represents
▸ readNxJson(): NxJsonConfiguration
▸ readProjectConfiguration(tree
, projectName
): ProjectConfiguration
Reads a project configuration.
The project configuration is stored in workspace.json or the associated project.json file. The utility will read from either file.
throws
If supplied projectName cannot be found
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
projectName |
string |
unique name. Often directories are part of the name (e.g., mydir-mylib) |
▸ readTargetOptions<T
>(__namedParameters
, context
): T
Reads and combines options for a given target.
Works as if you invoked the target yourself without passing any command lint overrides.
Name | Type |
---|---|
T |
any |
Name | Type |
---|---|
__namedParameters |
Target |
context |
ExecutorContext |
T
▸ readWorkspaceConfiguration(tree
): WorkspaceConfiguration
Read general workspace configuration such as the default project or cli settings
This does not provide projects configuration, use readProjectConfiguration instead.
Name | Type |
---|---|
tree |
Tree |
▸ removeDependenciesFromPackageJson(tree
, dependencies
, devDependencies
, packageJsonPath?
): GeneratorCallback
Remove Dependencies and Dev Dependencies from package.json
For example:
removeDependenciesFromPackageJson(tree, ['react'], ['jest']);
This will remove react
and jest
from the dependencies and devDependencies sections of package.json respectively.
Name | Type | Default value | Description |
---|---|---|---|
tree |
Tree |
undefined |
- |
dependencies |
string [] |
undefined |
Dependencies to be removed from the dependencies section of package.json |
devDependencies |
string [] |
undefined |
Dependencies to be removed from the devDependencies section of package.json |
packageJsonPath |
string |
'package.json' |
- |
Callback to uninstall dependencies only if necessary. undefined is returned if changes are not necessary.
▸ removeProjectConfiguration(tree
, projectName
): void
Removes the configuration of an existing project.
The project configuration is stored in workspace.json or the associated project.json file. The utility will update either file.
Name | Type |
---|---|
tree |
Tree |
projectName |
string |
void
▸ reverse(graph
): ProjectGraph
Returns a new project graph where all the edges are reversed.
For instance, if project A depends on B, in the reversed graph B will depend on A.
Name | Type |
---|---|
graph |
ProjectGraph <any > |
▸ runExecutor<T
>(targetDescription
, options
, context
): Promise
<AsyncIterableIterator
<T
>>
Loads and invokes executor.
This is analogous to invoking executor from the terminal, with the exception that the params aren't parsed from the string, but instead provided parsed already.
Apart from that, it works the same way:
- it will load the workspace configuration
- it will resolve the target
- it will load the executor and the schema
- it will load the options for the appropriate configuration
- it will run the validations and will set the default
- and, of course, it will invoke the executor
Example:
for await (const s of await runExecutor(
{ project: 'myproj', target: 'serve' },
{ watch: true },
context
)) {
// s.success
}
Note that the return value is a promise of an iterator, so you need to await before iterating over it.
Name | Type |
---|---|
T |
extends Object |
Name | Type |
---|---|
targetDescription |
Object |
targetDescription.configuration? |
string |
targetDescription.project |
string |
targetDescription.target |
string |
options |
Object |
context |
ExecutorContext |
Promise
<AsyncIterableIterator
<T
>>
▸ serializeJson<T
>(input
, options?
): string
Serializes the given data to a JSON string. By default the JSON string is formatted with a 2 space intendation to be easy readable.
Name | Type |
---|---|
T |
extends object = object |
Name | Type | Description |
---|---|---|
input |
T |
Object which should be serialized to JSON |
options? |
JsonSerializeOptions |
JSON serialize options |
string
the formatted JSON representation of the object
▸ stripIndents(strings
, ...values
): string
Removes indents, which is useful for printing warning and messages.
Example:
stripIndents`
Options:
- option1
- option2
`;
Name | Type |
---|---|
strings |
TemplateStringsArray |
...values |
any [] |
string
▸ Const
stripJsonComments(text
, replaceCh?
): string
Takes JSON with JavaScript-style comments and remove them. Optionally replaces every none-newline character of comments with a replaceCharacter
Name | Type |
---|---|
text |
string |
replaceCh? |
string |
string
▸ targetToTargetString(target
): string
Returns a string in the format "project:target[:configuration]" for the target
Name | Type | Description |
---|---|---|
target |
Target |
target object Examples: typescript targetToTargetString({ project: "proj", target: "test" }) // returns "proj:test" targetToTargetString({ project: "proj", target: "test", configuration: "production" }) // returns "proj:test:production" |
string
▸ toJS(tree
): void
Rename and transpile any new typescript files created to javascript files
Name | Type |
---|---|
tree |
Tree |
void
▸ updateJson<T
, U
>(tree
, path
, updater
, options?
): void
Updates a JSON value to the file system tree
Name | Type |
---|---|
T |
extends object = any |
U |
extends object = T |
Name | Type | Description |
---|---|---|
tree |
Tree |
File system tree |
path |
string |
Path of JSON file in the Tree |
updater |
(value : T ) => U |
Function that maps the current value of a JSON document to a new value to be written to the document |
options? |
JsonParseOptions & JsonSerializeOptions |
Optional JSON Parse and Serialize Options |
void
▸ updateProjectConfiguration(tree
, projectName
, projectConfiguration
): void
Updates the configuration of an existing project.
The project configuration is stored in workspace.json or the associated project.json file. The utility will update either files.
Name | Type | Description |
---|---|---|
tree |
Tree |
the file system tree |
projectName |
string |
unique name. Often directories are part of the name (e.g., mydir-mylib) |
projectConfiguration |
ProjectConfiguration |
project configuration |
void
▸ updateTsConfigsToJs(tree
, options
): void
Name | Type |
---|---|
tree |
Tree |
options |
Object |
options.projectRoot |
string |
void
▸ updateWorkspaceConfiguration(tree
, workspaceConfig
): void
Update general workspace configuration such as the default project or cli settings.
This does not update projects configuration, use updateProjectConfiguration or addProjectConfiguration instead.
Name | Type |
---|---|
tree |
Tree |
workspaceConfig |
WorkspaceConfiguration |
void
▸ visitNotIgnoredFiles(tree
, dirPath?
, visitor
): void
Utility to act on all files in a tree that are not ignored by git.
Name | Type | Default value |
---|---|---|
tree |
Tree |
undefined |
dirPath |
string |
tree.root |
visitor |
(path : string ) => void |
undefined |
void
▸ workspaceLayout(): Object
Returns information about where apps and libs will be created.
Object
Name | Type |
---|---|
appsDir |
string |
libsDir |
string |
▸ writeJson<T
>(tree
, path
, value
, options?
): void
Writes a JSON value to the file system tree
Name | Type |
---|---|
T |
extends object = object |
Name | Type | Description |
---|---|---|
tree |
Tree |
File system tree |
path |
string |
Path of JSON file in the Tree |
value |
T |
Serializable value to write |
options? |
JsonSerializeOptions |
Optional JSON Serialize Options |
void
▸ writeJsonFile<T
>(path
, data
, options?
): void
Serializes the given data to JSON and writes it to a file.
Name | Type |
---|---|
T |
extends object = object |
Name | Type | Description |
---|---|---|
path |
string |
A path to a file. |
data |
T |
data which should be serialized to JSON and written to the file |
options? |
JsonWriteOptions |
JSON serialize options |
void