Skip to content
This repository has been archived by the owner on Jul 24, 2023. It is now read-only.

Commit

Permalink
Merged PR 264: Customized code generation
Browse files Browse the repository at this point in the history
Related work items: #509, #510
  • Loading branch information
CloudSmithBrandon committed Feb 6, 2020
2 parents 3200069 + 42b7ff3 commit 5692ac4
Show file tree
Hide file tree
Showing 47 changed files with 931 additions and 278 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,70 @@ sidebar_label: "CodeGenerationManager"

### Methods

* [generateEntities](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#static-generateentities)
* [generateEntityCodeToFile](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#static-generateentitycodetofile)
* [generateEntityCodeToFolder](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#static-generateentitycodetofolder)
* [createCrmSvcUtilConfig](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#createcrmsvcutilconfig)
* [createCrmSvcUtilConfigFromConfig](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#createcrmsvcutilconfigfromconfig)
* [createCrmSvcUtilConfigToFile](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#createcrmsvcutilconfigtofile)
* [generateEntities](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#generateentities)
* [generateEntityCodeToFile](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#generateentitycodetofile)
* [generateEntityCodeToFolder](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#generateentitycodetofolder)
* [parseXml](_components_codegeneration_codegenerationmanager_.codegenerationmanager.md#parsexml)

## Methods

### `Static` generateEntities
### createCrmSvcUtilConfig

**createCrmSvcUtilConfig**(`config?`: [Config](../interfaces/_api_cds_webapi_cdswebapi_.cdswebapi.config.md), `file?`: Uri): *Promise‹void›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:36

**Parameters:**

Name | Type |
------ | ------ |
`config?` | [Config](../interfaces/_api_cds_webapi_cdswebapi_.cdswebapi.config.md) |
`file?` | Uri |

**Returns:** *Promise‹void›*

___

### createCrmSvcUtilConfigFromConfig

**createCrmSvcUtilConfigFromConfig**(`config?`: [Config](../interfaces/_api_cds_webapi_cdswebapi_.cdswebapi.config.md)): *Promise‹unknown›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:26

**Parameters:**

Name | Type |
------ | ------ |
`config?` | [Config](../interfaces/_api_cds_webapi_cdswebapi_.cdswebapi.config.md) |

**Returns:** *Promise‹unknown›*

___

### createCrmSvcUtilConfigToFile

**createCrmSvcUtilConfigToFile**(`defaultUri?`: Uri): *Promise‹unknown›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:21

**Parameters:**

Name | Type |
------ | ------ |
`defaultUri?` | Uri |

**Returns:** *Promise‹unknown›*

___

### generateEntities

**generateEntities**(`config?`: [Config](../interfaces/_api_cds_webapi_cdswebapi_.cdswebapi.config.md), `folder?`: string, `outputFileName?`: string, `namespace?`: string): *Promise‹void›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:20
Defined in src/components/CodeGeneration/CodeGenerationManager.ts:31

**Parameters:**

Expand All @@ -39,11 +92,11 @@ Name | Type |

___

### `Static` generateEntityCodeToFile
### generateEntityCodeToFile

**generateEntityCodeToFile**(`file?`: Uri): *Promise‹unknown›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:10
Defined in src/components/CodeGeneration/CodeGenerationManager.ts:11

**Parameters:**

Expand All @@ -55,11 +108,11 @@ Name | Type |

___

### `Static` generateEntityCodeToFolder
### generateEntityCodeToFolder

**generateEntityCodeToFolder**(`folder?`: Uri): *Promise‹unknown›*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:15
Defined in src/components/CodeGeneration/CodeGenerationManager.ts:16

**Parameters:**

Expand All @@ -68,3 +121,19 @@ Name | Type |
`folder?` | Uri |

**Returns:** *Promise‹unknown›*

___

### parseXml

**parseXml**(`xml`: any): *any*

Defined in src/components/CodeGeneration/CodeGenerationManager.ts:40

**Parameters:**

Name | Type |
------ | ------ |
`xml` | any |

**Returns:** *any*
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ sidebar_label: "TemplateFilesystemItem"

\+ **new TemplateFilesystemItem**(`type`: FileType, `name`: string): *[TemplateFilesystemItem](_components_templates_templatemanager_.templatefilesystemitem.md)*

Defined in src/components/Templates/TemplateManager.ts:882
Defined in src/components/Templates/TemplateManager.ts:874

**Parameters:**

Expand All @@ -44,12 +44,12 @@ Name | Type |

**name**: *string*

Defined in src/components/Templates/TemplateManager.ts:885
Defined in src/components/Templates/TemplateManager.ts:877

___

### type

**type**: *FileType*

Defined in src/components/Templates/TemplateManager.ts:884
Defined in src/components/Templates/TemplateManager.ts:876
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Name | Type |

**_systemTemplates**: *[TemplateItem](_components_templates_types_.templateitem.md)[]*

Defined in src/components/Templates/TemplateManager.ts:498
Defined in src/components/Templates/TemplateManager.ts:490

## Methods

Expand Down Expand Up @@ -241,7 +241,7 @@ ___

**saveToFilesystem**(`fsPath`: string, `type`: [TemplateType](../enums/_components_templates_types_.templatetype.md)): *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)*

Defined in src/components/Templates/TemplateManager.ts:383
Defined in src/components/Templates/TemplateManager.ts:376

Saves a workspace as a new template

Expand Down Expand Up @@ -313,7 +313,7 @@ ___

**createTemplatesDirIfNotExists**(): *Promise‹void›*

Defined in src/components/Templates/TemplateManager.ts:649
Defined in src/components/Templates/TemplateManager.ts:641

Creates the templates directory if it does not exists

Expand All @@ -327,7 +327,7 @@ ___

**defaultResolver**(`data`: string | Buffer, `placeholderRegExp`: RegExp, `template?`: [TemplateItem](_components_templates_types_.templateitem.md), `defaultPlaceholders?`: [Dictionary](_core_types_dictionary_.dictionary.md)‹string, string›): *Promise‹string | Buffer›*

Defined in src/components/Templates/TemplateManager.ts:796
Defined in src/components/Templates/TemplateManager.ts:788

**Parameters:**

Expand All @@ -346,7 +346,7 @@ ___

**exportTemplate**(`template`: [TemplateItem](_components_templates_types_.templateitem.md), `archive`: string, `systemTemplate`: boolean): *Promise‹void›*

Defined in src/components/Templates/TemplateManager.ts:324
Defined in src/components/Templates/TemplateManager.ts:317

**Parameters:**

Expand All @@ -364,7 +364,7 @@ ___

**getDefaultTemplatesFolder**(`systemTemplates`: boolean): *string*

Defined in src/components/Templates/TemplateManager.ts:578
Defined in src/components/Templates/TemplateManager.ts:570

Returns the default templates location, which is based on the global storage-path directory.

Expand All @@ -384,7 +384,7 @@ ___

**getPlaceholders**(`fsItem`: string, `placeholderRegExp`: string, `isFolder`: boolean): *string[]*

Defined in src/components/Templates/TemplateManager.ts:668
Defined in src/components/Templates/TemplateManager.ts:660

**Parameters:**

Expand All @@ -402,7 +402,7 @@ ___

**getSystemTemplate**(`name`: string): *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)*

Defined in src/components/Templates/TemplateManager.ts:508
Defined in src/components/Templates/TemplateManager.ts:500

**Parameters:**

Expand All @@ -418,7 +418,7 @@ ___

**getSystemTemplates**(): *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)[]*

Defined in src/components/Templates/TemplateManager.ts:500
Defined in src/components/Templates/TemplateManager.ts:492

**Returns:** *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)[]*

Expand All @@ -428,7 +428,7 @@ ___

**getTemplateCatalog**(`filename?`: string, `getSystemCatalog`: boolean): *Promise‹[TemplateCatalog](_components_templates_templatecatalog_.templatecatalog.md)*

Defined in src/components/Templates/TemplateManager.ts:471
Defined in src/components/Templates/TemplateManager.ts:463

Gets a copy of the template catalog

Expand All @@ -451,7 +451,7 @@ ___

**getTemplateFolder**(`template`: [TemplateItem](_components_templates_types_.templateitem.md), `systemTemplate`: boolean): *Promise‹string›*

Defined in src/components/Templates/TemplateManager.ts:308
Defined in src/components/Templates/TemplateManager.ts:301

**Parameters:**

Expand All @@ -468,7 +468,7 @@ ___

**getTemplateFolderItems**(`folder?`: string): *Promise‹[TemplateFilesystemItem](_components_templates_templatemanager_.templatefilesystemitem.md)[]*

Defined in src/components/Templates/TemplateManager.ts:618
Defined in src/components/Templates/TemplateManager.ts:610

Returns a list of available project templates by reading the Templates Directory.

Expand All @@ -488,7 +488,7 @@ ___

**getTemplates**(`folder`: string, `mergeWith?`: [TemplateItem](_components_templates_types_.templateitem.md)[], `exclusions?`: string[]): *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)[]*

Defined in src/components/Templates/TemplateManager.ts:513
Defined in src/components/Templates/TemplateManager.ts:505

**Parameters:**

Expand All @@ -506,7 +506,7 @@ ___

**getTemplatesFolder**(`systemTemplates`: boolean): *Promise‹string›*

Defined in src/components/Templates/TemplateManager.ts:558
Defined in src/components/Templates/TemplateManager.ts:550

Returns the templates directory location.
If no user configuration is found, the extension will look for
Expand All @@ -529,7 +529,7 @@ ___

**importTemplate**(`archive`: string, `systemTemplate`: boolean): *Promise‹[TemplateItem](_components_templates_types_.templateitem.md)*

Defined in src/components/Templates/TemplateManager.ts:332
Defined in src/components/Templates/TemplateManager.ts:325

**Parameters:**

Expand All @@ -546,7 +546,7 @@ ___

**mergePlaceholders**(`source`: [TemplatePlaceholder](_components_templates_types_.templateplaceholder.md)[], `merge`: [TemplatePlaceholder](_components_templates_types_.templateplaceholder.md)[]): *[TemplatePlaceholder](_components_templates_types_.templateplaceholder.md)‹›[]*

Defined in src/components/Templates/TemplateManager.ts:740
Defined in src/components/Templates/TemplateManager.ts:732

**Parameters:**

Expand Down Expand Up @@ -579,7 +579,7 @@ ___

**openTemplateFolderInExplorer**(`template`: [TemplateItem](_components_templates_types_.templateitem.md), `systemTemplate`: boolean): *Promise‹void›*

Defined in src/components/Templates/TemplateManager.ts:373
Defined in src/components/Templates/TemplateManager.ts:366

**Parameters:**

Expand All @@ -596,7 +596,7 @@ ___

**resolvePlaceholders**(`data`: string | Buffer, `placeholderRegExp`: string, `placeholders`: [Dictionary](_core_types_dictionary_.dictionary.md)‹string, string›, `templateInfo`: [TemplateItem](_components_templates_types_.templateitem.md), `resolvers?`: function[]): *Promise‹string | Buffer›*

Defined in src/components/Templates/TemplateManager.ts:772
Defined in src/components/Templates/TemplateManager.ts:764

Replaces any placeholders found within the input data. Will use a
dictionary of values from the user's workspace settings, or will prompt
Expand Down
Loading

0 comments on commit 5692ac4

Please sign in to comment.