Module: index

O Nx Devkit é a tecnologia subjacente utilizada para personalizar o Nx para suportar diferentes tecnologias e casos de uso personalizados.Contém muitas funções de utilidade para ler e escrever ficheiros,actualizar a configuração,trabalhar com Árvores de Sintaxe Abstrata (ASTs),e muito mais.

Como na maioria das coisas em Nx,o núcleo do Nx Devkit é muito simples.Utiliza apenas primitivos da linguagem e objectos imutáveis (sendo a árvore a única excepção).

Índice

Contagens do gráfico do projecto

Utils Enumerations

Aulas do gráfico do projecto

Utils Classes

Workspace Classes

Commands Interfaces

Other Interfaces

Interfaces do gráfico do projecto

Tree Interfaces

Utils Interfaces

Workspace Interfaces

Geradores Tipo alias

Outros tipos de pseudónimos

Gestor de embalagens Tipo pseudónimos

Tipo de gráfico do projecto

Utils Tipo alias

Tipos de espaço de trabalho

Logger Variables

Utils Variables

Functions

Contagens do gráfico do projecto

DependencyType

• Tipo de Dependência : Object


Utils Enumerations

ChangeType

ChangeType: Object

Aulas do gráfico do projecto

ProjectGraphBuilder

ProjectGraphBuilder: Object


Utils Classes

Hasher

Hasher: Object


Workspace Classes

Workspaces

Espaços de trabalho : Object

Commands Interfaces

Target

Alvo : Object


Other Interfaces

NxPlugin

NxPlugin: Object

Um plugin para Nx


Interfaces do gráfico do projecto

FileData

FileData: Object


ProjectFileMap

ProjectFileMap: Object


ProjectGraph

ProjectGraph<T>: Object

Type parameters

Name Type
T any

ProjectGraphDependency

ProjectGraphDependency: Object


ProjectGraphExternalNode

ProjectGraphExternalNode: Object


ProjectGraphProcessorContext

ProjectGraphProcessorContext: Object


ProjectGraphProjectNode

ProjectGraphProjectNode<T>: Object

Type parameters

Name Type
T any

ProjectGraphV4

ProjectGraphV4<T>: Object

Type parameters

Name Type
T any

Tree Interfaces

FileChange

FileChange: Object


Tree

Árvore : Object


Utils Interfaces

DefaultTasksRunnerOptions

DefaultTasksRunnerOptions: Object


Hash

Hash: Object


JsonParseOptions

JsonParseOptions: Object


JsonSerializeOptions

JsonSerializeOptions: Object


RemoteCache

RemoteCache: Object


StringDeletion

StringDeletion: Object


StringInsertion

StringInsertion: Object


Workspace Interfaces

ExecutorContext

ExecutorContext: Object


ExecutorsJson

ExecutorsJson: Object


GeneratorsJson

GeneratorsJson: Object


HasherContext

HasherContext: Object


ImplicitJsonSubsetDependency

ImplicitJsonSubsetDependency<T>: Object

Type parameters

Name Type
T "*" | string[]

MigrationsJson

MigrationsJson: Object


NxAffectedConfig

NxAffectedConfig: Object


NxJsonConfiguration

NxJsonConfiguration<T>: Object

Type parameters

Name Type
T "*" | string[]

ProjectConfiguration

• Configuração do Projeto : Object


ProjectsConfigurations

• Configurações de Projetos : Object


TargetConfiguration

TargetConfiguration<T>: Object

Type parameters

Name Type
T any

TargetDependencyConfig

TargetDependencyConfig: Object


Task

Tarefa : Object


TaskGraph

TaskGraph: Object


Workspace

Área de trabalho : Object

Geradores Tipo alias

WorkspaceConfiguration

Ƭ WorkspaceConfiguration: Omit<ProjectsConfigurations, "projects"> & Partial<NxJsonConfiguration>


Outros tipos de pseudónimos

ProjectTargetConfigurator

Ƭ ProjectTargetConfigurator: (file: string) => Record<string, TargetConfiguration>

Type declaration

▸ (file): Record<string, TargetConfiguration>

Parameters
Name Type
file string
Returns

Record<string, TargetConfiguration>


Gestor de embalagens Tipo pseudónimos

PackageManager

Ƭ PackageManager: "yarn" | "pnpm" | "npm"


Tipo de gráfico do projecto

ProjectGraphNode

Ƭ ProjectGraphNode < T T : ProjectGraphProjectNode < T > | ProjectGraphExternalNode

Type parameters

Name Type
T any

Utils Tipo alias

StringChange

Ƭ StringChange: StringInsertion | StringDeletion


Tipos de espaço de trabalho

CustomHasher

Ƭ CustomHasher: (task: Task, context: HasherContext) => Promise<Hash>

Type declaration

▸ ( task , context o ): Promise < Hash >

Parameters
Name Type
task Task
context HasherContext
Returns

Promise<Hash>


Executor

Ƭ Executor < T >: ( options : T , context o : ExecutorContext ) => Promise < Object > | AsyncIterableIterator < Object >

Type parameters

Name Type
T any

Type declaration

▸ ( options , context o ): Promise < Object > | AsyncIterableIterator < Object >

Implementação de um alvo de um projecto

Parameters
Name Type
options T
context ExecutorContext
Returns

Promise<Object> | AsyncIterableIterator<Object>


Generator

Ƭ Gerador < T >: ( tree : any , schema : T ) => void | GeneratorCallback | Promise < void | GeneratorCallback >

Type parameters

Name Type
T unknown

Type declaration

▸ (tree, schema): void | GeneratorCallback | Promise<void | GeneratorCallback>

Uma função que agenda actualizações do sistema de ficheiros para serem feitas atomicamente

Parameters
Name Type
tree any
schema T
Returns

void | GeneratorCallback | Promise<void | GeneratorCallback>


GeneratorCallback

Ƭ GeneratorCallback: () => void | Promise<void>

Type declaration

▸ (): void | Promise<void>

Uma função de chamada de retorno que é executada após a realização de alterações no sistema de ficheiros

Returns

void | Promise<void>


ImplicitDependencyEntry

Ƭ ImplicitDependencyEntry<T>: Object

Type parameters

Name Type
T "*" | string[]

Index signature

[chave: string ]: T | ImplicitJsonSubsetDependency < T >


ProjectType

Ƭ ProjectType: "library" | "application"


TaskGraphExecutor

Ƭ TaskGraphExecutor<T>: (taskGraph: TaskGraph, options: Record<string, T>, overrides: T, context: ExecutorContext) => Promise<Record<string, Object>>

Type parameters

Name Type
T any

Type declaration

▸ (taskGraph, options, overrides, context): Promise<Record<string, Object>>

Implementação de um objectivo de um projecto que lida com múltiplos projectos a serem agrupados

Parameters
Name Type
taskGraph TaskGraph
options Record<string, T>
overrides T
context ExecutorContext
Returns

Promise<Record<string, Object>>


WorkspaceJsonConfiguration

Ƭ WorkspaceJsonConfiguration: ProjectsConfigurations

Logger Variables

logger

registrador : Object

Type declaration

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

Utils Variables

appRootPath

appRootPath: string = workspaceRoot


cacheDir

cacheDir: string


output

saída : CLIOutput


workspaceRoot

workspaceRoot: string

Functions

addDependenciesToPackageJson

addDependenciesToPackageJson(tree, dependencies, devDependencies, packageJsonPath?): GeneratorCallback

Adicionar Dependências e Devendências a package.json

For example:

addDependenciesToPackageJson(tree, { react: 'latest' }, { jest: 'latest' });

Isso adicionará react e jest às seções de dependências e devDependencies do package.json, respectivamente.

Parameters

Name Type Default value Description
tree Tree undefined Árvore que representa o sistema de ficheiros a modificar
dependencies Record<string, string> undefined Dependências a adicionar à secção de dependências do package.json
devDependencies Record<string, string> undefined Dependências a adicionar à secção devDependências do pacote.json
packageJsonPath string 'package.json' Caminho para package.json

Returns

GeneratorCallback

A chamada de retorno para instalar dependências apenas se necessário.indefinida é devolvida se não forem necessárias alterações.


addProjectConfiguration

addProjectConfiguration(tree, projectName, projectConfiguration, standalone?): void

Adiciona a configuração do projecto ao espaço de trabalho Nx.

A configuração do projecto é armazenada em workspace.json ou no ficheiro project.json associado.O utilitário actualizará ambos os ficheiros.

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros
projectName string nome único.Muitas vezes os directórios fazem parte do nome (por exemplo,mydir-mylib)
projectConfiguration ProjectConfiguration project configuration
standalone? boolean deverá o projecto utilizar package.json? Se falso,a configuração do projecto está dentro do workspace.json

Returns

void


applyChangesToString

applyChangesToString(text, changes): string

Aplica uma lista de alterações ao valor original de uma corda.

Isto é útil quando se trabalha com ASTs.

Por exemplo,para renomear um imóvel nas opções de um método:

const code = `bootstrap({
  target: document.querySelector('#app')
})`;

const indexOfPropertyName = 13; // Geralmente determinado pela análise de um AST.
const updatedCode = applyChangesToString(code, [
  {
    type: ChangeType.Insert,
    index: indexOfPropertyName,
    text: 'element',
  },
  {
    type: ChangeType.Delete,
    start: indexOfPropertyName,
    length: 6,
  },
]);

bootstrap({
  element: document.querySelector('#app'),
});

Parameters

Name Type
text string
changes StringChange[]

Returns

string


convertNxExecutor

convertNxExecutor(executor): any

Converter um Executor Nx num Construtor de Devkit Angular

Use isto para expor um Angular Builder compatível

Parameters

Name Type
executor Executor<any>

Returns

any


convertNxGenerator

convertNxGenerator<T>(generator, skipWritingConfigInOldFormat?): (generatorOptions: T) => (tree: any, context: any) => Promise<any>

Converter um Gerador Nx num Esquema de Devkit Angular.

Type parameters

Name Type
T any

Parameters

Name Type Default value Description
generator Generator<T> undefined O gerador Nx para converter para um esquema de Devkit Angular.
skipWritingConfigInOldFormat boolean false Se deve saltar a escrita da configuração no formato antigo (o utilizado pelo DevKit Angular).

Returns

fn

▸ (generatorOptions): (tree: any, context: any) => Promise<any>

Parameters
Name Type
generatorOptions T
Returns

fn

▸ ( tree , context o ): Promise < any >

Parameters
Name Type
tree any
context any
Returns

Promise<any>


createProjectGraphAsync

createProjectGraphAsync(): Promise<ProjectGraph>

Compulta e devolve um ProjectGraph.

Nx irá calcular o gráfico quer num processo daemon quer no processo actual.

Nx irá calculá-lo no processo actual se:

  • O processo está a decorrer em IC (a variável inve é verdadeira ou são definidas outras variáveis comuns utilizadas pelos fornecedores de IC).
  • Está a funcionar no contentor do cais.
  • O processo daemon está desactivado devido ao erro anterior ao iniciar o daemon.
  • NX_DAEMON está definido como false .
  • useDaemon é definido como false em nx.json

NX_DAEMON tem precedência:

  • Se for definido como verdadeiro,o daemon será sempre utilizado.
  • Se for definido como falso,o gráfico será sempre calculado no processo actual.

Dica:Se quiser depurar a criação de gráficos de projectos,execute o seu comando com NX_DAEMON=false.

O Nx usa duas camadas de cache: as informações sobre dependências explícitas armazenadas no disco e as informações armazenadas no processo daemon. Para redefinir ambos, execute: nx reset .

Returns

Promise<ProjectGraph>


defaultTasksRunner

ConstdefaultTasksRunner(tasks, options, context?): any

Parameters

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

Returns

any


detectPackageManager

detectPackageManager(dir?): PackageManager

Detecta que gestor de pacotes é utilizado no espaço de trabalho com base no ficheiro de bloqueio.

Parameters

Name Type Default value
dir string ''

Returns

PackageManager


detectWorkspaceScope

detectWorkspaceScope(packageName): string

Detectar o âmbito do espaço de trabalho a partir do nome do pacote.json

Parameters

Name Type
packageName string

Returns

string


formatFiles

formatFiles(tree): Promise<void>

Formata todos os ficheiros criados ou actualizados utilizando Prettier

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros

Returns

Promise<void>


generateFiles

generateFiles(tree, srcFolder, target, substitutions): void

Gera uma pasta de ficheiros com base nos modelos fornecidos.

Ao fazê-lo,efectua duas substituições:

  • Substitui segmentos de nomes de ficheiros rodeados por __
  • Utiliza ejs para substituir valores em modelos

Examples:

generateFiles(tree, path.join(__dirname, 'files'), './tools/scripts', {
  tmpl: '',
  name: 'myscript',
});

Este comando pegará todos os arquivos do diretório de files próximo ao local de onde o comando é invocado. Ele substituirá todos os __tmpl__ por '' e todos os __name__ por 'myscript' nos nomes dos arquivos e substituirá todos os <%= name %> por myscript nos próprios arquivos. tmpl: '' é um padrão comum. Com ele você pode nomear arquivos assim: index.ts__tmpl__ , para que seu editor não fique confuso sobre arquivos TypeScript incorretos.

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros
srcFolder string a pasta de origem dos ficheiros (caminho absoluto)
target string a pasta de destino (relativa à raiz da árvore)
substitutions Object um objecto de pares de valores-chave

Returns

void


getImportPath

getImportPath(npmScope, projectDirectory): string

Prefixos do nome do projecto com âmbito npm

Parameters

Name Type
npmScope string
projectDirectory string

Returns

string


getOutputsForTargetAndConfiguration

getOutputsForTargetAndConfiguration(task, node): any

Devolve a lista de resultados que serão armazenados em cache.

Parameters

Name Type Description
task Pick<Task, "target" | "overrides"> alvo+sobreposições
node ProjectGraphProjectNode<any> ProjectGraphProjectNode objecto contra o qual a tarefa corre

Returns

any


getPackageManagerCommand

getPackageManagerCommand(packageManager?): PackageManagerCommands

Comandos de retorno para o gestor de pacotes utilizado no espaço de trabalho.Por defeito,o gestor de pacotes é derivado com base no ficheiro de bloqueio,mas também pode ser passado de forma explícita.

Example:

execSync(`${getPackageManagerCommand().addDev} my-dev-package`);

Parameters

Name Type
packageManager PackageManager

Returns

PackageManagerCommands


getPackageManagerVersion

getPackageManagerVersion(packageManager?): string

Devolve a versão do gestor de pacotes utilizada no espaço de trabalho.Por defeito,o gestor de pacotes é derivado com base no ficheiro de bloqueio,mas também pode ser passado de forma explícita.

Parameters

Name Type
packageManager PackageManager

Returns

string


getProjects

getProjects(tree): Map<string, ProjectConfiguration>

Obter um mapa de todos os projectos num espaço de trabalho.

Use readProjectConfiguration se apenas um projeto for necessário.

Parameters

Name Type
tree Tree

Returns

Map<string, ProjectConfiguration>


getWorkspaceLayout

getWorkspaceLayout(tree): Object

Devolve os padrões do espaço de trabalho.Inclui pastas por defeito para aplicações e libs,e o âmbito por defeito.

Example:

{ appsDir: 'apps', libsDir: 'libs', npmScope: 'myorg' }

Parameters

Name Type Description
tree Tree árvore do sistema de ficheiros

Returns

Object

Name Type
appsDir string
libsDir string
npmScope string
standaloneAsDefault boolean

getWorkspacePath

getWorkspacePath(tree): "/angular.json" | "/workspace.json" | null

Parameters

Name Type
tree Tree

Returns

"/angular.json" | "/workspace.json" | null


installPackagesTask

installPackagesTask(tree, alwaysRun?, cwd?, packageManager?): void

Executa npm install ou yarn install . Ele pulará a execução da instalação se package.json não mudou nada ou não mudou desde a última invocação.

Parameters

Name Type Default value Description
tree Tree undefined a árvore do sistema de ficheiros
alwaysRun boolean false sempre execute o comando mesmo que package.json não tenha sido alterado.
cwd string '' -
packageManager PackageManager undefined -

Returns

void


isStandaloneProject

isStandaloneProject(tree, project): boolean

Retorna se um projecto tiver uma configuração autónoma (project.json).

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros
project string o nome do projecto

Returns

boolean


joinPathFragments

joinPathFragments(...fragments): string

Fragmentos de caminho normalizados e junta-se a eles

Parameters

Name Type
...fragments string[]

Returns

string


moveFilesToNewDirectory

moveFilesToNewDirectory(tree, oldDir, newDir): void

Análogo ao cp -r oldDir newDir

Parameters

Name Type
tree Tree
oldDir string
newDir string

Returns

void


names

nomes ( name ): Object

Utilizar a função de gerar diferentes cordas com base no nome fornecido.

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'}

Parameters

Name Type
name string

Returns

Object

Name Type
className string
constantName string
fileName string
name string
propertyName string

normalizePath

normalizePath(osSpecificPath): string

Cobre um caminho específico para um caminho de estilo unix

Parameters

Name Type
osSpecificPath string

Returns

string


offsetFromRoot

offsetFromRoot(fullPathToDir): string

Calcula uma compensação a partir da raiz do espaço de trabalho,que é útil para a construção de URLs relativas.

Examples:

offsetFromRoot('apps/mydir/myapp/'); // returns "../../../"

Parameters

Name Type Description
fullPathToDir string directory path

Returns

string


parseJson

parseJson<T>(input, options?): T

Parses a corda dada ao JSON e devolve o objecto que o conteúdo do JSON representa.Por defeito,são permitidos comentários ao estilo javascript.

Type parameters

Name Type
T estende object = any

Parameters

Name Type Description
input string Conteúdo do JSON como fio
options? JsonParseOptions Opções de análise do JSON

Returns

T

Objeto que o conteúdo do JSON representa


parseTargetString

parseTargetString(targetString): Target

Parses uma cadeia alvo em {projecto,alvo,configuração}

Examples:

parseTargetString('proj:test'); // returns { project: "proj", target: "test" }
parseTargetString('proj:test:production'); // returns { project: "proj", target: "test", configuration: "production" }

Parameters

Name Type Description
targetString string target reference

Returns

Target


readAllWorkspaceConfiguration

readAllWorkspaceConfiguration(): ProjectsConfigurations & NxJsonConfiguration

deprecated Use readProjectsConfigurationFromProjectGraph(aguarde createProjectGraphAsync())

Returns

ProjectsConfigurations & NxJsonConfiguration


readCachedProjectGraph

readCachedProjectGraph(): ProjectGraph<ProjectConfiguration>

Lê sincronizadamente a última cópia em cache do ProjectGraph do espaço de trabalho.

throws {Error} se não houver ProjectGraph em cache para ler

Returns

ProjectGraph<ProjectConfiguration>


readJson

readJson<T>(tree, path, options?): T

Lê um ficheiro json,remove todos os comentários e parses JSON.

Type parameters

Name Type
T estende object = any

Parameters

Name Type Description
tree Tree árvore do sistema de ficheiros
path string file path
options? JsonParseOptions Opções opcionais JSON Parse Options

Returns

T


readJsonFile

readJsonFile<T>(path, options?): T

Lê um ficheiro JSON e devolve o objecto que o conteúdo do JSON representa.

Type parameters

Name Type
T estende object = any

Parameters

Name Type Description
path string Um caminho para um ficheiro.
options? JsonReadOptions Opções de análise do JSON

Returns

T

Objetar o conteúdo do JSON do ficheiro representa


readNxJson

readNxJson(): NxJsonConfiguration

Returns

NxJsonConfiguration


readProjectConfiguration

readProjectConfiguration(tree, projectName): ProjectConfiguration

Lê a configuração de um projecto.

A configuração do projecto é armazenada em workspace.json ou no ficheiro project.json associado.A utilidade será lida a partir de qualquer um dos ficheiros.

throws Se o projectName fornecido não puder ser encontrado

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros
projectName string nome único.Muitas vezes os directórios fazem parte do nome (por exemplo,mydir-mylib)

Returns

ProjectConfiguration


readTargetOptions

readTargetOptions<T>(__namedParameters, context): T

Lê e combina opções para um determinado alvo.

Funciona como se tivesse sido o próprio utilizador a invocar o alvo sem passar qualquer comando de substituição de cotão.

Type parameters

Name Type
T any

Parameters

Name Type
__namedParameters Target
context ExecutorContext

Returns

T


readWorkspaceConfiguration

readWorkspaceConfiguration(tree): WorkspaceConfiguration

Ler a configuração geral do espaço de trabalho,como o projecto padrão ou as configurações do cliente

Isso não fornece configuração de projetos, use readProjectConfiguration em vez disso.

Parameters

Name Type
tree Tree

Returns

WorkspaceConfiguration


removeDependenciesFromPackageJson

removeDependenciesFromPackageJson(tree, dependencies, devDependencies, packageJsonPath?): GeneratorCallback

Remover Dependências e Devendências de package.json

For example:

removeDependenciesFromPackageJson(tree, ['react'], ['jest']);

Isso removerá react e jest das seções de dependências e devDependencies do package.json, respectivamente.

Parameters

Name Type Default value Description
tree Tree undefined -
dependencies string[] undefined Dependências a remover da secção de dependências do pacote.json
devDependencies string[] undefined Dependências a remover da secção devDependências do pacote.json
packageJsonPath string 'package.json' -

Returns

GeneratorCallback

A chamada de retorno para desinstalar dependências apenas se necessário.indefinida é devolvida se não forem necessárias alterações.


removeProjectConfiguration

removeProjectConfiguration(tree, projectName): void

Elimina a configuração de um projecto existente.

A configuração do projecto é armazenada em workspace.json ou no ficheiro project.json associado.O utilitário actualizará qualquer um dos ficheiros.

Parameters

Name Type
tree Tree
projectName string

Returns

void


reverse

reverso ( graph ): ProjectGraph

Devolve um novo gráfico do projecto onde todas as arestas são invertidas.

Por exemplo,se o projecto A depende de B,no gráfico invertido B dependerá de A.

Parameters

Name Type
graph ProjectGraph<any>

Returns

ProjectGraph


runExecutor

runExecutor<T>(targetDescription, overrides, context): Promise<AsyncIterableIterator<T>>

Carrega e invoca o executor.

Isto é análogo a invocar o executor do terminal,com a excepção de que os param não são analisados a partir da corda,mas em vez disso já são analisados.

Para além disso,funciona da mesma forma:

  • irá carregar a configuração do espaço de trabalho
  • resolverá o alvo
  • irá carregar o executor e o esquema
  • irá carregar as opções para a configuração apropriada
  • efectuará as validações e definirá o valor por defeito
  • e,claro,invocará o executor

Example:

for await (const s of await runExecutor(
  { project: 'myproj', target: 'serve' },
  { watch: true },
  context
)) {
  // s.success
}

Note que o valor de retorno é uma promessa de um iterador,por isso é necessário aguardar antes de o iterar sobre ele.

Type parameters

Name Type
T extends Object

Parameters

Name Type
targetDescription Object
targetDescription.configuration? string
targetDescription.project string
targetDescription.target string
overrides Object
context ExecutorContext

Returns

Promise<AsyncIterableIterator<T>>


serializeJson

serializeJson<T>(input, options?): string

Serializa os dados fornecidos para uma cadeia JSON.Por defeito,a cadeia JSON é formatada com uma intenção de 2 espaços para ser de fácil leitura.

Type parameters

Name Type
T estende object = object

Parameters

Name Type Description
input T Objecto que deve ser serializado ao JSON
options? JsonSerializeOptions Opções de seriação do JSON

Returns

string

a representação formatada do JSON do objecto


stripIndents

stripIndents(strings, ...values): string

Remove travessões,o que é útil para imprimir avisos e mensagens.

Example:

stripIndents`
 Options:
 - option1
 - option2
`;

Parameters

Name Type
strings TemplateStringsArray
...values any[]

Returns

string


stripJsonComments

ConststripJsonComments(text, replaceCh?): string

Toma JSON com comentários ao estilo JavaScript e remove-os.Opcionalmente,substitui todos os caracteres de comentários que não sejam de linha nova por um substitutoCharacter

Parameters

Name Type
text string
replaceCh? string

Returns

string


targetToTargetString

targetToTargetString(target): string

Retorna uma cadeia no formato "projecto:alvo[:configuração]" para o alvo

Parameters

Name Type Description
target Target target object Exemplos: typescript targetToTargetString({ project: "proj", target: "test" }) // returns "proj:test" targetToTargetString({ project: "proj", target: "test", configuration: "production" }) // returns "proj:test:production"

Returns

string


toJS

toJS(tree): void

Renomear e transportar quaisquer novos ficheiros datilografados criados para ficheiros javascript

Parameters

Name Type
tree Tree

Returns

void


updateJson

updateJson<T, U>(tree, path, updater, options?): void

Actualiza um valor JSON para a árvore do sistema de ficheiros

Type parameters

Name Type
T estende object = any
U estende object = T

Parameters

Name Type Description
tree Tree Árvore do sistema de ficheiros
path string Caminho do ficheiro JSON na Árvore
updater (value: T) => U Função que mapeia o valor actual de um documento JSON para um novo valor a ser escrito no documento
options? JsonParseOptions & JsonSerializeOptions Opções opcionais do JSON Analisar e Serializar

Returns

void


updateProjectConfiguration

updateProjectConfiguration(tree, projectName, projectConfiguration): void

Actualiza a configuração de um projecto existente.

A configuração do projecto é armazenada em workspace.json ou no ficheiro project.json associado.O utilitário actualizará ambos os ficheiros.

Parameters

Name Type Description
tree Tree a árvore do sistema de ficheiros
projectName string nome único.Muitas vezes os directórios fazem parte do nome (por exemplo,mydir-mylib)
projectConfiguration ProjectConfiguration project configuration

Returns

void


updateTsConfigsToJs

updateTsConfigsToJs(tree, options): void

Parameters

Name Type
tree Tree
options Object
options.projectRoot string

Returns

void


updateWorkspaceConfiguration

updateWorkspaceConfiguration(tree, workspaceConfig): void

Actualizar a configuração geral do espaço de trabalho,tal como as configurações por defeito do projecto ou do cliente.

Isso não atualiza a configuração dos projetos, use updateProjectConfiguration ou addProjectConfiguration .

Parameters

Name Type
tree Tree
workspaceConfig WorkspaceConfiguration

Returns

void


visitNotIgnoredFiles

visitNotIgnoredFiles(tree, dirPath?, visitor): void

Utilidade para actuar em todos os ficheiros de uma árvore que não são ignorados pelo idiota.

Parameters

Name Type Default value
tree Tree undefined
dirPath string tree.root
visitor (path: string) => void undefined

Returns

void


workspaceLayout

workspaceLayout(): Object

Devolve informação sobre onde as aplicações e libras serão criadas.

Returns

Object

Name Type
appsDir string
libsDir string

writeJson

writeJson<T>(tree, path, value, options?): void

Escreve um valor JSON para a árvore do sistema de ficheiros

Type parameters

Name Type
T estende object = object

Parameters

Name Type Description
tree Tree Árvore do sistema de ficheiros
path string Caminho do ficheiro JSON na Árvore
value T Valor sériavel para escrever
options? JsonSerializeOptions Opções opcionais de Serialização JSON

Returns

void


writeJsonFile

writeJsonFile<T>(path, data, options?): void

Serializa os dados fornecidos ao JSON e grava-os num ficheiro.

Type parameters

Name Type
T estende object = object

Parameters

Name Type Description
path string Um caminho para um ficheiro.
data T dados que devem ser serializados ao JSON e escritos no ficheiro
options? JsonWriteOptions Opções de seriação do JSON

Returns

void