mcdev 4.1.3 → 4.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/ISSUE_TEMPLATE/bug.yml +2 -0
- package/.github/dependabot.yml +1 -1
- package/.github/workflows/code-analysis.yml +2 -2
- package/.github/workflows/npm-publish.yml +4 -4
- package/README.md +6 -6
- package/docs/dist/documentation.md +123 -166
- package/lib/Retriever.js +8 -2
- package/lib/cli.js +1 -1
- package/lib/index.js +5 -16
- package/lib/metadataTypes/Asset.js +17 -9
- package/lib/metadataTypes/Automation.js +23 -12
- package/lib/metadataTypes/ContentArea.js +20 -7
- package/lib/metadataTypes/DataExtension.js +30 -12
- package/lib/metadataTypes/Email.js +1 -14
- package/lib/metadataTypes/EmailSendDefinition.js +2 -13
- package/lib/metadataTypes/MetadataType.js +26 -0
- package/lib/metadataTypes/Query.js +1 -12
- package/lib/metadataTypes/Script.js +1 -11
- package/lib/metadataTypes/TriggeredSendDefinition.js +2 -13
- package/lib/metadataTypes/definitions/Automation.definition.js +1 -0
- package/lib/metadataTypes/definitions/ContentArea.definition.js +1 -0
- package/lib/metadataTypes/definitions/DataExtension.definition.js +1 -0
- package/lib/metadataTypes/definitions/Email.definition.js +1 -0
- package/lib/metadataTypes/definitions/EmailSendDefinition.definition.js +1 -0
- package/lib/metadataTypes/definitions/Query.definition.js +1 -0
- package/lib/metadataTypes/definitions/Script.definition.js +1 -0
- package/lib/metadataTypes/definitions/TriggeredSendDefinition.definition.js +1 -0
- package/lib/util/cli.js +10 -11
- package/lib/util/devops.js +2 -2
- package/lib/util/init.git.js +12 -13
- package/lib/util/init.js +13 -21
- package/package.json +3 -3
- package/test/mockRoot/.mcdevrc.json +1 -1
|
@@ -454,10 +454,10 @@ main class
|
|
|
454
454
|
* [.createDeltaPkg(argv)](#Mcdev.createDeltaPkg) ⇒ <code>Promise.<Array.<TYPE.DeltaPkgItem>></code>
|
|
455
455
|
* [.selectTypes()](#Mcdev.selectTypes) ⇒ <code>Promise</code>
|
|
456
456
|
* [.explainTypes()](#Mcdev.explainTypes) ⇒ <code>void</code>
|
|
457
|
-
* [.upgrade(
|
|
457
|
+
* [.upgrade()](#Mcdev.upgrade) ⇒ <code>Promise.<boolean></code>
|
|
458
458
|
* [.retrieve(businessUnit, [selectedTypesArr], [keys], [changelogOnly])](#Mcdev.retrieve) ⇒ <code>Promise.<object></code>
|
|
459
459
|
* [.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve])](#Mcdev.deploy) ⇒ <code>Promise.<Object.<string, TYPE.MultiMetadataTypeMap>></code>
|
|
460
|
-
* [.initProject([credentialsName]
|
|
460
|
+
* [.initProject([credentialsName])](#Mcdev.initProject) ⇒ <code>Promise.<void></code>
|
|
461
461
|
* [.findBUs(credentialsName)](#Mcdev.findBUs) ⇒ <code>Promise.<void></code>
|
|
462
462
|
* [.document(businessUnit, type)](#Mcdev.document) ⇒ <code>Promise.<void></code>
|
|
463
463
|
* [.deleteByKey(businessUnit, type, customerKey)](#Mcdev.deleteByKey) ⇒ <code>Promise.<void></code>
|
|
@@ -507,7 +507,6 @@ handler for 'mcdev createDeltaPkg
|
|
|
507
507
|
| [argv.range] | <code>string</code> | git commit range into deploy directory |
|
|
508
508
|
| [argv.filter] | <code>string</code> | filter file paths that start with any |
|
|
509
509
|
| [argv.diffArr] | <code>Array.<TYPE.DeltaPkgItem></code> | list of files to include in delta package (skips git diff when provided) |
|
|
510
|
-
| [argv.skipInteraction] | <code>TYPE.skipInteraction</code> | allows to skip interactive wizard |
|
|
511
510
|
|
|
512
511
|
<a name="Mcdev.selectTypes"></a>
|
|
513
512
|
|
|
@@ -520,14 +519,9 @@ handler for 'mcdev createDeltaPkg
|
|
|
520
519
|
**Kind**: static method of [<code>Mcdev</code>](#Mcdev)
|
|
521
520
|
<a name="Mcdev.upgrade"></a>
|
|
522
521
|
|
|
523
|
-
### Mcdev.upgrade(
|
|
522
|
+
### Mcdev.upgrade() ⇒ <code>Promise.<boolean></code>
|
|
524
523
|
**Kind**: static method of [<code>Mcdev</code>](#Mcdev)
|
|
525
524
|
**Returns**: <code>Promise.<boolean></code> - success flag
|
|
526
|
-
|
|
527
|
-
| Param | Type | Description |
|
|
528
|
-
| --- | --- | --- |
|
|
529
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
530
|
-
|
|
531
525
|
<a name="Mcdev.retrieve"></a>
|
|
532
526
|
|
|
533
527
|
### Mcdev.retrieve(businessUnit, [selectedTypesArr], [keys], [changelogOnly]) ⇒ <code>Promise.<object></code>
|
|
@@ -560,7 +554,7 @@ Deploys all metadata located in the 'deploy' directory to the specified business
|
|
|
560
554
|
|
|
561
555
|
<a name="Mcdev.initProject"></a>
|
|
562
556
|
|
|
563
|
-
### Mcdev.initProject([credentialsName]
|
|
557
|
+
### Mcdev.initProject([credentialsName]) ⇒ <code>Promise.<void></code>
|
|
564
558
|
Creates template file for properties.json
|
|
565
559
|
|
|
566
560
|
**Kind**: static method of [<code>Mcdev</code>](#Mcdev)
|
|
@@ -569,7 +563,6 @@ Creates template file for properties.json
|
|
|
569
563
|
| Param | Type | Description |
|
|
570
564
|
| --- | --- | --- |
|
|
571
565
|
| [credentialsName] | <code>string</code> | identifying name of the installed package / project |
|
|
572
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
573
566
|
|
|
574
567
|
<a name="Mcdev.findBUs"></a>
|
|
575
568
|
|
|
@@ -836,6 +829,7 @@ FileTransfer MetadataType
|
|
|
836
829
|
* [.buildDefinitionForNested(templateDir, targetDir, metadata, templateVariables, templateName)](#Asset.buildDefinitionForNested) ⇒ <code>Promise.<void></code>
|
|
837
830
|
* [.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName)](#Asset.buildTemplateForNested) ⇒ <code>Promise.<void></code>
|
|
838
831
|
* [._buildForNested(templateDir, targetDir, metadata, templateVariables, templateName, mode)](#Asset._buildForNested) ⇒ <code>Promise.<void></code>
|
|
832
|
+
* [.setFolderPath(metadata)](#Asset.setFolderPath)
|
|
839
833
|
* [.parseMetadata(metadata)](#Asset.parseMetadata) ⇒ <code>TYPE.CodeExtractItem</code>
|
|
840
834
|
* [._mergeCode(metadata, deployDir, subType, [templateName], [fileListOnly])](#Asset._mergeCode) ⇒ <code>Promise.<Array.<TYPE.CodeExtract>></code>
|
|
841
835
|
* [._mergeCode_slots(prefix, metadataSlots, readDirArr, subtypeExtension, subDirArr, fileList, customerKey, [templateName], [fileListOnly])](#Asset._mergeCode_slots) ⇒ <code>Promise.<void></code>
|
|
@@ -1072,6 +1066,17 @@ handles extracted code if any are found for complex types
|
|
|
1072
1066
|
| templateName | <code>string</code> | name of the template to be built |
|
|
1073
1067
|
| mode | <code>'definition'</code> \| <code>'template'</code> | defines what we use this helper for |
|
|
1074
1068
|
|
|
1069
|
+
<a name="Asset.setFolderPath"></a>
|
|
1070
|
+
|
|
1071
|
+
### Asset.setFolderPath(metadata)
|
|
1072
|
+
generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
|
|
1073
|
+
|
|
1074
|
+
**Kind**: static method of [<code>Asset</code>](#Asset)
|
|
1075
|
+
|
|
1076
|
+
| Param | Type | Description |
|
|
1077
|
+
| --- | --- | --- |
|
|
1078
|
+
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
|
|
1079
|
+
|
|
1075
1080
|
<a name="Asset.parseMetadata"></a>
|
|
1076
1081
|
|
|
1077
1082
|
### Asset.parseMetadata(metadata) ⇒ <code>TYPE.CodeExtractItem</code>
|
|
@@ -1254,6 +1259,7 @@ Automation MetadataType
|
|
|
1254
1259
|
* [.preDeployTasks(metadata)](#Automation.preDeployTasks) ⇒ <code>Promise.<TYPE.AutomationItem></code>
|
|
1255
1260
|
* [.validateDeployMetadata(metadata)](#Automation.validateDeployMetadata) ⇒ <code>boolean</code>
|
|
1256
1261
|
* [.postDeployTasks(metadata, originalMetadata)](#Automation.postDeployTasks) ⇒ <code>Promise.<void></code>
|
|
1262
|
+
* [.setFolderPath(metadata)](#Automation.setFolderPath)
|
|
1257
1263
|
* [.parseMetadata(metadata)](#Automation.parseMetadata) ⇒ <code>TYPE.AutomationItem</code>
|
|
1258
1264
|
* [._buildSchedule(scheduleObject)](#Automation._buildSchedule) ⇒ <code>TYPE.AutomationScheduleSoap</code>
|
|
1259
1265
|
* [._calcTime(offsetServer, dateInput, [offsetInput])](#Automation._calcTime) ⇒ <code>string</code>
|
|
@@ -1393,6 +1399,17 @@ Gets executed after deployment of metadata type
|
|
|
1393
1399
|
| metadata | <code>TYPE.AutomationMap</code> | metadata mapped by their keyField |
|
|
1394
1400
|
| originalMetadata | <code>TYPE.AutomationMap</code> | metadata to be updated (contains additioanl fields) |
|
|
1395
1401
|
|
|
1402
|
+
<a name="Automation.setFolderPath"></a>
|
|
1403
|
+
|
|
1404
|
+
### Automation.setFolderPath(metadata)
|
|
1405
|
+
generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
|
|
1406
|
+
|
|
1407
|
+
**Kind**: static method of [<code>Automation</code>](#Automation)
|
|
1408
|
+
|
|
1409
|
+
| Param | Type | Description |
|
|
1410
|
+
| --- | --- | --- |
|
|
1411
|
+
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
|
|
1412
|
+
|
|
1396
1413
|
<a name="Automation.parseMetadata"></a>
|
|
1397
1414
|
|
|
1398
1415
|
### Automation.parseMetadata(metadata) ⇒ <code>TYPE.AutomationItem</code>
|
|
@@ -1511,6 +1528,7 @@ ContentArea MetadataType
|
|
|
1511
1528
|
* [ContentArea](#ContentArea) ⇐ [<code>MetadataType</code>](#MetadataType)
|
|
1512
1529
|
* [.retrieve(retrieveDir, [_], [__], [___], [key])](#ContentArea.retrieve) ⇒ <code>Promise.<TYPE.MetadataTypeMapObj></code>
|
|
1513
1530
|
* [.postRetrieveTasks(metadata)](#ContentArea.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
|
|
1531
|
+
* [.setFolderPath(metadata)](#ContentArea.setFolderPath)
|
|
1514
1532
|
* [.parseMetadata(metadata)](#ContentArea.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
|
|
1515
1533
|
|
|
1516
1534
|
<a name="ContentArea.retrieve"></a>
|
|
@@ -1541,6 +1559,17 @@ manages post retrieve steps
|
|
|
1541
1559
|
| --- | --- | --- |
|
|
1542
1560
|
| metadata | <code>TYPE.MetadataTypeItem</code> | a single item |
|
|
1543
1561
|
|
|
1562
|
+
<a name="ContentArea.setFolderPath"></a>
|
|
1563
|
+
|
|
1564
|
+
### ContentArea.setFolderPath(metadata)
|
|
1565
|
+
generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
|
|
1566
|
+
|
|
1567
|
+
**Kind**: static method of [<code>ContentArea</code>](#ContentArea)
|
|
1568
|
+
|
|
1569
|
+
| Param | Type | Description |
|
|
1570
|
+
| --- | --- | --- |
|
|
1571
|
+
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
|
|
1572
|
+
|
|
1544
1573
|
<a name="ContentArea.parseMetadata"></a>
|
|
1545
1574
|
|
|
1546
1575
|
### ContentArea.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
|
|
@@ -1576,6 +1605,7 @@ DataExtension MetadataType
|
|
|
1576
1605
|
* [.postDeleteTasks(buObject, customerKey)](#DataExtension.postDeleteTasks) ⇒ <code>void</code>
|
|
1577
1606
|
* [.retrieveForCache(buObject)](#DataExtension.retrieveForCache) ⇒ <code>Promise.<{metadata: TYPE.DataExtensionMap, type: string}></code>
|
|
1578
1607
|
* [.retrieveAsTemplate(templateDir, name, templateVariables)](#DataExtension.retrieveAsTemplate) ⇒ <code>Promise.<{metadata: TYPE.DataExtensionMap, type: string}></code>
|
|
1608
|
+
* [.setFolderPath(metadata)](#DataExtension.setFolderPath)
|
|
1579
1609
|
* [.getFilesToCommit(keyArr)](#DataExtension.getFilesToCommit) ⇒ <code>Array.<string></code>
|
|
1580
1610
|
|
|
1581
1611
|
<a name="DataExtension.upsert"></a>
|
|
@@ -1758,6 +1788,18 @@ Retrieves dataExtension metadata in template format.
|
|
|
1758
1788
|
| name | <code>string</code> | name of the metadata item |
|
|
1759
1789
|
| templateVariables | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |
|
|
1760
1790
|
|
|
1791
|
+
<a name="DataExtension.setFolderPath"></a>
|
|
1792
|
+
|
|
1793
|
+
### DataExtension.setFolderPath(metadata)
|
|
1794
|
+
dataExtension logic that retrieves the folder path from cache and updates the given metadata with it after retrieve
|
|
1795
|
+
it also sets the content type which is basically the subtype
|
|
1796
|
+
|
|
1797
|
+
**Kind**: static method of [<code>DataExtension</code>](#DataExtension)
|
|
1798
|
+
|
|
1799
|
+
| Param | Type | Description |
|
|
1800
|
+
| --- | --- | --- |
|
|
1801
|
+
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
|
|
1802
|
+
|
|
1761
1803
|
<a name="DataExtension.getFilesToCommit"></a>
|
|
1762
1804
|
|
|
1763
1805
|
### DataExtension.getFilesToCommit(keyArr) ⇒ <code>Array.<string></code>
|
|
@@ -2946,6 +2988,7 @@ Provides default functionality that can be overwritten by child metadata type cl
|
|
|
2946
2988
|
* [.deploy(metadata, deployDir, retrieveDir, buObject)](#MetadataType.deploy) ⇒ <code>Promise.<TYPE.MetadataTypeMap></code>
|
|
2947
2989
|
* [.postDeployTasks(metadata, originalMetadata)](#MetadataType.postDeployTasks) ⇒ <code>void</code>
|
|
2948
2990
|
* [.postRetrieveTasks(metadata, targetDir, [isTemplating])](#MetadataType.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
|
|
2991
|
+
* [.setFolderPath(metadata)](#MetadataType.setFolderPath)
|
|
2949
2992
|
* [.retrieve(retrieveDir, [additionalFields], buObject, [subType], [key])](#MetadataType.retrieve) ⇒ <code>Promise.<TYPE.MetadataTypeMapObj></code>
|
|
2950
2993
|
* [.retrieveChangelog([buObject], [additionalFields], [subType])](#MetadataType.retrieveChangelog) ⇒ <code>Promise.<TYPE.MetadataTypeMapObj></code>
|
|
2951
2994
|
* [.retrieveForCache(buObject, [subType])](#MetadataType.retrieveForCache) ⇒ <code>Promise.<TYPE.MetadataTypeMapObj></code>
|
|
@@ -3069,6 +3112,17 @@ Gets executed after retreive of metadata type
|
|
|
3069
3112
|
| targetDir | <code>string</code> | folder where retrieves should be saved |
|
|
3070
3113
|
| [isTemplating] | <code>boolean</code> | signals that we are retrieving templates |
|
|
3071
3114
|
|
|
3115
|
+
<a name="MetadataType.setFolderPath"></a>
|
|
3116
|
+
|
|
3117
|
+
### MetadataType.setFolderPath(metadata)
|
|
3118
|
+
generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
|
|
3119
|
+
|
|
3120
|
+
**Kind**: static method of [<code>MetadataType</code>](#MetadataType)
|
|
3121
|
+
|
|
3122
|
+
| Param | Type | Description |
|
|
3123
|
+
| --- | --- | --- |
|
|
3124
|
+
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
|
|
3125
|
+
|
|
3072
3126
|
<a name="MetadataType.retrieve"></a>
|
|
3073
3127
|
|
|
3074
3128
|
### MetadataType.retrieve(retrieveDir, [additionalFields], buObject, [subType], [key]) ⇒ <code>Promise.<TYPE.MetadataTypeMapObj></code>
|
|
@@ -4735,12 +4789,12 @@ CLI helper class
|
|
|
4735
4789
|
**Kind**: global constant
|
|
4736
4790
|
|
|
4737
4791
|
* [Cli](#Cli)
|
|
4738
|
-
* [.initMcdevConfig(
|
|
4739
|
-
* [.addExtraCredential(properties
|
|
4740
|
-
* [.updateCredential(properties, credName
|
|
4792
|
+
* [.initMcdevConfig()](#Cli.initMcdevConfig) ⇒ <code>Promise.<boolean></code>
|
|
4793
|
+
* [.addExtraCredential(properties)](#Cli.addExtraCredential) ⇒ <code>Promise.<void></code>
|
|
4794
|
+
* [.updateCredential(properties, credName)](#Cli.updateCredential) ⇒ <code>Promise.<boolean></code>
|
|
4741
4795
|
* [.getCredentialObject(properties, target, [isCredentialOnly], [allowAll])](#Cli.getCredentialObject) ⇒ <code>Promise.<TYPE.BuObject></code>
|
|
4742
4796
|
* [._selectBU(properties, [credential], [isCredentialOnly], [allowAll])](#Cli._selectBU) ⇒ <code>Promise.<Array></code>
|
|
4743
|
-
* [._setCredential(properties, [credName]
|
|
4797
|
+
* [._setCredential(properties, [credName])](#Cli._setCredential) ⇒ <code>Promise.<(boolean\|string)></code>
|
|
4744
4798
|
* [._askCredentials(properties, [credName])](#Cli._askCredentials) ⇒ <code>Promise.<object></code>
|
|
4745
4799
|
* [.selectTypes(properties, [setTypesArr])](#Cli.selectTypes) ⇒ <code>Promise.<void></code>
|
|
4746
4800
|
* [._summarizeSubtypes(responses, type)](#Cli._summarizeSubtypes) ⇒ <code>void</code>
|
|
@@ -4748,20 +4802,15 @@ CLI helper class
|
|
|
4748
4802
|
|
|
4749
4803
|
<a name="Cli.initMcdevConfig"></a>
|
|
4750
4804
|
|
|
4751
|
-
### Cli.initMcdevConfig(
|
|
4805
|
+
### Cli.initMcdevConfig() ⇒ <code>Promise.<boolean></code>
|
|
4752
4806
|
used when initially setting up a project.
|
|
4753
4807
|
loads default config and adds first credential
|
|
4754
4808
|
|
|
4755
4809
|
**Kind**: static method of [<code>Cli</code>](#Cli)
|
|
4756
4810
|
**Returns**: <code>Promise.<boolean></code> - success of init
|
|
4757
|
-
|
|
4758
|
-
| Param | Type | Description |
|
|
4759
|
-
| --- | --- | --- |
|
|
4760
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
4761
|
-
|
|
4762
4811
|
<a name="Cli.addExtraCredential"></a>
|
|
4763
4812
|
|
|
4764
|
-
### Cli.addExtraCredential(properties
|
|
4813
|
+
### Cli.addExtraCredential(properties) ⇒ <code>Promise.<void></code>
|
|
4765
4814
|
Extends template file for properties.json
|
|
4766
4815
|
|
|
4767
4816
|
**Kind**: static method of [<code>Cli</code>](#Cli)
|
|
@@ -4770,11 +4819,10 @@ Extends template file for properties.json
|
|
|
4770
4819
|
| Param | Type | Description |
|
|
4771
4820
|
| --- | --- | --- |
|
|
4772
4821
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
4773
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
4774
4822
|
|
|
4775
4823
|
<a name="Cli.updateCredential"></a>
|
|
4776
4824
|
|
|
4777
|
-
### Cli.updateCredential(properties, credName
|
|
4825
|
+
### Cli.updateCredential(properties, credName) ⇒ <code>Promise.<boolean></code>
|
|
4778
4826
|
Extends template file for properties.json
|
|
4779
4827
|
update credentials
|
|
4780
4828
|
|
|
@@ -4785,7 +4833,6 @@ update credentials
|
|
|
4785
4833
|
| --- | --- | --- |
|
|
4786
4834
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
4787
4835
|
| credName | <code>string</code> | name of credential that needs updating |
|
|
4788
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
4789
4836
|
|
|
4790
4837
|
<a name="Cli.getCredentialObject"></a>
|
|
4791
4838
|
|
|
@@ -4819,7 +4866,7 @@ helps select the right credential in case of bad initial input
|
|
|
4819
4866
|
|
|
4820
4867
|
<a name="Cli._setCredential"></a>
|
|
4821
4868
|
|
|
4822
|
-
### Cli.\_setCredential(properties, [credName]
|
|
4869
|
+
### Cli.\_setCredential(properties, [credName]) ⇒ <code>Promise.<(boolean\|string)></code>
|
|
4823
4870
|
helper around _askCredentials
|
|
4824
4871
|
|
|
4825
4872
|
**Kind**: static method of [<code>Cli</code>](#Cli)
|
|
@@ -4829,7 +4876,6 @@ helper around _askCredentials
|
|
|
4829
4876
|
| --- | --- | --- |
|
|
4830
4877
|
| properties | <code>TYPE.Mcdevrc</code> | from config file |
|
|
4831
4878
|
| [credName] | <code>string</code> | name of credential that needs updating |
|
|
4832
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
4833
4879
|
|
|
4834
4880
|
<a name="Cli._askCredentials"></a>
|
|
4835
4881
|
|
|
@@ -4933,7 +4979,7 @@ DevOps helper class
|
|
|
4933
4979
|
* [.getDeltaList(properties, [range], [saveToDeployDir], [filterPaths])](#DevOps.getDeltaList) ⇒ <code>Promise.<Array.<TYPE.DeltaPkgItem>></code>
|
|
4934
4980
|
* [~delta](#DevOps.getDeltaList..delta) : <code>Array.<TYPE.DeltaPkgItem></code>
|
|
4935
4981
|
* [~copied](#DevOps.getDeltaList..copied) : <code>TYPE.DeltaPkgItem</code>
|
|
4936
|
-
* [.buildDeltaDefinitions(properties, range, [diffArr]
|
|
4982
|
+
* [.buildDeltaDefinitions(properties, range, [diffArr])](#DevOps.buildDeltaDefinitions) ⇒ <code>Promise.<Array.<TYPE.DeltaPkgItem>></code>
|
|
4937
4983
|
* [~deltaDeployAll](#DevOps.buildDeltaDefinitions..deltaDeployAll) : <code>Array.<TYPE.DeltaPkgItem></code>
|
|
4938
4984
|
* [.document(directory, jsonReport)](#DevOps.document) ⇒ <code>void</code>
|
|
4939
4985
|
* [.getFilesToCommit(properties, buObject, metadataType, keyArr)](#DevOps.getFilesToCommit) ⇒ <code>Promise.<Array.<string>></code>
|
|
@@ -4969,7 +5015,7 @@ Interactive commit selection if no commits are passed.
|
|
|
4969
5015
|
**Kind**: inner constant of [<code>getDeltaList</code>](#DevOps.getDeltaList)
|
|
4970
5016
|
<a name="DevOps.buildDeltaDefinitions"></a>
|
|
4971
5017
|
|
|
4972
|
-
### DevOps.buildDeltaDefinitions(properties, range, [diffArr]
|
|
5018
|
+
### DevOps.buildDeltaDefinitions(properties, range, [diffArr]) ⇒ <code>Promise.<Array.<TYPE.DeltaPkgItem>></code>
|
|
4973
5019
|
wrapper around DevOps.getDeltaList, Builder.buildTemplate and M
|
|
4974
5020
|
|
|
4975
5021
|
**Kind**: static method of [<code>DevOps</code>](#DevOps)
|
|
@@ -4980,7 +5026,6 @@ wrapper around DevOps.getDeltaList, Builder.buildTemplate and M
|
|
|
4980
5026
|
| properties | <code>TYPE.Mcdevrc</code> | project config file |
|
|
4981
5027
|
| range | <code>string</code> | git commit range |
|
|
4982
5028
|
| [diffArr] | <code>Array.<TYPE.DeltaPkgItem></code> | instead of running git diff the method can also get a list of files to process |
|
|
4983
|
-
| [skipInteraction] | <code>TYPE.SkipInteraction</code> | allows to skip interactive wizard |
|
|
4984
5029
|
|
|
4985
5030
|
<a name="DevOps.buildDeltaDefinitions..deltaDeployAll"></a>
|
|
4986
5031
|
|
|
@@ -5271,13 +5316,13 @@ CLI helper class
|
|
|
5271
5316
|
* [._getForcedUpdateList(projectVersion)](#Init._getForcedUpdateList) ⇒ <code>Promise.<Array.<string>></code>
|
|
5272
5317
|
* [._createIdeConfigFile(fileNameArr, relevantForcedUpdates, [boilerplateFileContent])](#Init._createIdeConfigFile) ⇒ <code>Promise.<boolean></code>
|
|
5273
5318
|
* [.upgradeAuthFile()](#Init.upgradeAuthFile) ⇒ <code>Promise.<boolean></code>
|
|
5274
|
-
* [.initGitRepo(
|
|
5275
|
-
* [.gitPush(
|
|
5276
|
-
* [._addGitRemote(
|
|
5277
|
-
* [._updateGitConfigUser(
|
|
5319
|
+
* [.initGitRepo()](#Init.initGitRepo) ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5320
|
+
* [.gitPush()](#Init.gitPush) ⇒ <code>void</code>
|
|
5321
|
+
* [._addGitRemote()](#Init._addGitRemote) ⇒ <code>string</code>
|
|
5322
|
+
* [._updateGitConfigUser()](#Init._updateGitConfigUser) ⇒ <code>void</code>
|
|
5278
5323
|
* [._getGitConfigUser()](#Init._getGitConfigUser) ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
5279
|
-
* [.initProject(properties, credentialName
|
|
5280
|
-
* [._downloadAllBUs(bu, gitStatus
|
|
5324
|
+
* [.initProject(properties, credentialName)](#Init.initProject) ⇒ <code>Promise.<void></code>
|
|
5325
|
+
* [._downloadAllBUs(bu, gitStatus)](#Init._downloadAllBUs) ⇒ <code>Promise.<void></code>
|
|
5281
5326
|
* [.upgradeProject(properties, [initial], [repoName])](#Init.upgradeProject) ⇒ <code>Promise.<boolean></code>
|
|
5282
5327
|
* [._getMissingCredentials(properties)](#Init._getMissingCredentials) ⇒ <code>Array.<string></code>
|
|
5283
5328
|
* [.installDependencies([repoName])](#Init.installDependencies) ⇒ <code>Promise.<boolean></code>
|
|
@@ -5355,50 +5400,30 @@ helper method for this.upgradeProject that upgrades project config if needed
|
|
|
5355
5400
|
**Returns**: <code>Promise.<boolean></code> - returns true if worked without errors
|
|
5356
5401
|
<a name="Init.initGitRepo"></a>
|
|
5357
5402
|
|
|
5358
|
-
### Init.initGitRepo(
|
|
5403
|
+
### Init.initGitRepo() ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5359
5404
|
check if git repo exists and otherwise create one
|
|
5360
5405
|
|
|
5361
5406
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5362
5407
|
**Returns**: <code>Promise.<{status: string, repoName: string}></code> - success flag
|
|
5363
|
-
|
|
5364
|
-
| Param | Type | Description |
|
|
5365
|
-
| --- | --- | --- |
|
|
5366
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5367
|
-
|
|
5368
5408
|
<a name="Init.gitPush"></a>
|
|
5369
5409
|
|
|
5370
|
-
### Init.gitPush(
|
|
5410
|
+
### Init.gitPush() ⇒ <code>void</code>
|
|
5371
5411
|
offer to push the new repo straight to the server
|
|
5372
5412
|
|
|
5373
5413
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5374
|
-
|
|
5375
|
-
| Param | Type | Description |
|
|
5376
|
-
| --- | --- | --- |
|
|
5377
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5378
|
-
|
|
5379
5414
|
<a name="Init._addGitRemote"></a>
|
|
5380
5415
|
|
|
5381
|
-
### Init.\_addGitRemote(
|
|
5416
|
+
### Init.\_addGitRemote() ⇒ <code>string</code>
|
|
5382
5417
|
offers to add the git remote origin
|
|
5383
5418
|
|
|
5384
5419
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5385
5420
|
**Returns**: <code>string</code> - repo name (optionally)
|
|
5386
|
-
|
|
5387
|
-
| Param | Type | Description |
|
|
5388
|
-
| --- | --- | --- |
|
|
5389
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5390
|
-
|
|
5391
5421
|
<a name="Init._updateGitConfigUser"></a>
|
|
5392
5422
|
|
|
5393
|
-
### Init.\_updateGitConfigUser(
|
|
5423
|
+
### Init.\_updateGitConfigUser() ⇒ <code>void</code>
|
|
5394
5424
|
checks global config and ask to config the user info and then store it locally
|
|
5395
5425
|
|
|
5396
5426
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5397
|
-
|
|
5398
|
-
| Param | Type | Description |
|
|
5399
|
-
| --- | --- | --- |
|
|
5400
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5401
|
-
|
|
5402
5427
|
<a name="Init._getGitConfigUser"></a>
|
|
5403
5428
|
|
|
5404
5429
|
### Init.\_getGitConfigUser() ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
@@ -5408,7 +5433,7 @@ retrieves the global user.name and user.email values
|
|
|
5408
5433
|
**Returns**: <code>Promise.<{'user.name': string, 'user.email': string}></code> - user.name and user.email
|
|
5409
5434
|
<a name="Init.initProject"></a>
|
|
5410
5435
|
|
|
5411
|
-
### Init.initProject(properties, credentialName
|
|
5436
|
+
### Init.initProject(properties, credentialName) ⇒ <code>Promise.<void></code>
|
|
5412
5437
|
Creates template file for properties.json
|
|
5413
5438
|
|
|
5414
5439
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5418,11 +5443,10 @@ Creates template file for properties.json
|
|
|
5418
5443
|
| --- | --- | --- |
|
|
5419
5444
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
5420
5445
|
| credentialName | <code>string</code> | identifying name of the installed package / project |
|
|
5421
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5422
5446
|
|
|
5423
5447
|
<a name="Init._downloadAllBUs"></a>
|
|
5424
5448
|
|
|
5425
|
-
### Init.\_downloadAllBUs(bu, gitStatus
|
|
5449
|
+
### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.<void></code>
|
|
5426
5450
|
helper for this.initProject()
|
|
5427
5451
|
|
|
5428
5452
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5432,7 +5456,6 @@ helper for this.initProject()
|
|
|
5432
5456
|
| --- | --- | --- |
|
|
5433
5457
|
| bu | <code>string</code> | cred/bu or cred/* or * |
|
|
5434
5458
|
| gitStatus | <code>string</code> | signals what state the git repo is in |
|
|
5435
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5436
5459
|
|
|
5437
5460
|
<a name="Init.upgradeProject"></a>
|
|
5438
5461
|
|
|
@@ -5500,13 +5523,13 @@ CLI helper class
|
|
|
5500
5523
|
* [._getForcedUpdateList(projectVersion)](#Init._getForcedUpdateList) ⇒ <code>Promise.<Array.<string>></code>
|
|
5501
5524
|
* [._createIdeConfigFile(fileNameArr, relevantForcedUpdates, [boilerplateFileContent])](#Init._createIdeConfigFile) ⇒ <code>Promise.<boolean></code>
|
|
5502
5525
|
* [.upgradeAuthFile()](#Init.upgradeAuthFile) ⇒ <code>Promise.<boolean></code>
|
|
5503
|
-
* [.initGitRepo(
|
|
5504
|
-
* [.gitPush(
|
|
5505
|
-
* [._addGitRemote(
|
|
5506
|
-
* [._updateGitConfigUser(
|
|
5526
|
+
* [.initGitRepo()](#Init.initGitRepo) ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5527
|
+
* [.gitPush()](#Init.gitPush) ⇒ <code>void</code>
|
|
5528
|
+
* [._addGitRemote()](#Init._addGitRemote) ⇒ <code>string</code>
|
|
5529
|
+
* [._updateGitConfigUser()](#Init._updateGitConfigUser) ⇒ <code>void</code>
|
|
5507
5530
|
* [._getGitConfigUser()](#Init._getGitConfigUser) ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
5508
|
-
* [.initProject(properties, credentialName
|
|
5509
|
-
* [._downloadAllBUs(bu, gitStatus
|
|
5531
|
+
* [.initProject(properties, credentialName)](#Init.initProject) ⇒ <code>Promise.<void></code>
|
|
5532
|
+
* [._downloadAllBUs(bu, gitStatus)](#Init._downloadAllBUs) ⇒ <code>Promise.<void></code>
|
|
5510
5533
|
* [.upgradeProject(properties, [initial], [repoName])](#Init.upgradeProject) ⇒ <code>Promise.<boolean></code>
|
|
5511
5534
|
* [._getMissingCredentials(properties)](#Init._getMissingCredentials) ⇒ <code>Array.<string></code>
|
|
5512
5535
|
* [.installDependencies([repoName])](#Init.installDependencies) ⇒ <code>Promise.<boolean></code>
|
|
@@ -5584,50 +5607,30 @@ helper method for this.upgradeProject that upgrades project config if needed
|
|
|
5584
5607
|
**Returns**: <code>Promise.<boolean></code> - returns true if worked without errors
|
|
5585
5608
|
<a name="Init.initGitRepo"></a>
|
|
5586
5609
|
|
|
5587
|
-
### Init.initGitRepo(
|
|
5610
|
+
### Init.initGitRepo() ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5588
5611
|
check if git repo exists and otherwise create one
|
|
5589
5612
|
|
|
5590
5613
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5591
5614
|
**Returns**: <code>Promise.<{status: string, repoName: string}></code> - success flag
|
|
5592
|
-
|
|
5593
|
-
| Param | Type | Description |
|
|
5594
|
-
| --- | --- | --- |
|
|
5595
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5596
|
-
|
|
5597
5615
|
<a name="Init.gitPush"></a>
|
|
5598
5616
|
|
|
5599
|
-
### Init.gitPush(
|
|
5617
|
+
### Init.gitPush() ⇒ <code>void</code>
|
|
5600
5618
|
offer to push the new repo straight to the server
|
|
5601
5619
|
|
|
5602
5620
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5603
|
-
|
|
5604
|
-
| Param | Type | Description |
|
|
5605
|
-
| --- | --- | --- |
|
|
5606
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5607
|
-
|
|
5608
5621
|
<a name="Init._addGitRemote"></a>
|
|
5609
5622
|
|
|
5610
|
-
### Init.\_addGitRemote(
|
|
5623
|
+
### Init.\_addGitRemote() ⇒ <code>string</code>
|
|
5611
5624
|
offers to add the git remote origin
|
|
5612
5625
|
|
|
5613
5626
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5614
5627
|
**Returns**: <code>string</code> - repo name (optionally)
|
|
5615
|
-
|
|
5616
|
-
| Param | Type | Description |
|
|
5617
|
-
| --- | --- | --- |
|
|
5618
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5619
|
-
|
|
5620
5628
|
<a name="Init._updateGitConfigUser"></a>
|
|
5621
5629
|
|
|
5622
|
-
### Init.\_updateGitConfigUser(
|
|
5630
|
+
### Init.\_updateGitConfigUser() ⇒ <code>void</code>
|
|
5623
5631
|
checks global config and ask to config the user info and then store it locally
|
|
5624
5632
|
|
|
5625
5633
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5626
|
-
|
|
5627
|
-
| Param | Type | Description |
|
|
5628
|
-
| --- | --- | --- |
|
|
5629
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5630
|
-
|
|
5631
5634
|
<a name="Init._getGitConfigUser"></a>
|
|
5632
5635
|
|
|
5633
5636
|
### Init.\_getGitConfigUser() ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
@@ -5637,7 +5640,7 @@ retrieves the global user.name and user.email values
|
|
|
5637
5640
|
**Returns**: <code>Promise.<{'user.name': string, 'user.email': string}></code> - user.name and user.email
|
|
5638
5641
|
<a name="Init.initProject"></a>
|
|
5639
5642
|
|
|
5640
|
-
### Init.initProject(properties, credentialName
|
|
5643
|
+
### Init.initProject(properties, credentialName) ⇒ <code>Promise.<void></code>
|
|
5641
5644
|
Creates template file for properties.json
|
|
5642
5645
|
|
|
5643
5646
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5647,11 +5650,10 @@ Creates template file for properties.json
|
|
|
5647
5650
|
| --- | --- | --- |
|
|
5648
5651
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
5649
5652
|
| credentialName | <code>string</code> | identifying name of the installed package / project |
|
|
5650
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5651
5653
|
|
|
5652
5654
|
<a name="Init._downloadAllBUs"></a>
|
|
5653
5655
|
|
|
5654
|
-
### Init.\_downloadAllBUs(bu, gitStatus
|
|
5656
|
+
### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.<void></code>
|
|
5655
5657
|
helper for this.initProject()
|
|
5656
5658
|
|
|
5657
5659
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5661,7 +5663,6 @@ helper for this.initProject()
|
|
|
5661
5663
|
| --- | --- | --- |
|
|
5662
5664
|
| bu | <code>string</code> | cred/bu or cred/* or * |
|
|
5663
5665
|
| gitStatus | <code>string</code> | signals what state the git repo is in |
|
|
5664
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5665
5666
|
|
|
5666
5667
|
<a name="Init.upgradeProject"></a>
|
|
5667
5668
|
|
|
@@ -5729,13 +5730,13 @@ CLI helper class
|
|
|
5729
5730
|
* [._getForcedUpdateList(projectVersion)](#Init._getForcedUpdateList) ⇒ <code>Promise.<Array.<string>></code>
|
|
5730
5731
|
* [._createIdeConfigFile(fileNameArr, relevantForcedUpdates, [boilerplateFileContent])](#Init._createIdeConfigFile) ⇒ <code>Promise.<boolean></code>
|
|
5731
5732
|
* [.upgradeAuthFile()](#Init.upgradeAuthFile) ⇒ <code>Promise.<boolean></code>
|
|
5732
|
-
* [.initGitRepo(
|
|
5733
|
-
* [.gitPush(
|
|
5734
|
-
* [._addGitRemote(
|
|
5735
|
-
* [._updateGitConfigUser(
|
|
5733
|
+
* [.initGitRepo()](#Init.initGitRepo) ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5734
|
+
* [.gitPush()](#Init.gitPush) ⇒ <code>void</code>
|
|
5735
|
+
* [._addGitRemote()](#Init._addGitRemote) ⇒ <code>string</code>
|
|
5736
|
+
* [._updateGitConfigUser()](#Init._updateGitConfigUser) ⇒ <code>void</code>
|
|
5736
5737
|
* [._getGitConfigUser()](#Init._getGitConfigUser) ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
5737
|
-
* [.initProject(properties, credentialName
|
|
5738
|
-
* [._downloadAllBUs(bu, gitStatus
|
|
5738
|
+
* [.initProject(properties, credentialName)](#Init.initProject) ⇒ <code>Promise.<void></code>
|
|
5739
|
+
* [._downloadAllBUs(bu, gitStatus)](#Init._downloadAllBUs) ⇒ <code>Promise.<void></code>
|
|
5739
5740
|
* [.upgradeProject(properties, [initial], [repoName])](#Init.upgradeProject) ⇒ <code>Promise.<boolean></code>
|
|
5740
5741
|
* [._getMissingCredentials(properties)](#Init._getMissingCredentials) ⇒ <code>Array.<string></code>
|
|
5741
5742
|
* [.installDependencies([repoName])](#Init.installDependencies) ⇒ <code>Promise.<boolean></code>
|
|
@@ -5813,50 +5814,30 @@ helper method for this.upgradeProject that upgrades project config if needed
|
|
|
5813
5814
|
**Returns**: <code>Promise.<boolean></code> - returns true if worked without errors
|
|
5814
5815
|
<a name="Init.initGitRepo"></a>
|
|
5815
5816
|
|
|
5816
|
-
### Init.initGitRepo(
|
|
5817
|
+
### Init.initGitRepo() ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5817
5818
|
check if git repo exists and otherwise create one
|
|
5818
5819
|
|
|
5819
5820
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5820
5821
|
**Returns**: <code>Promise.<{status: string, repoName: string}></code> - success flag
|
|
5821
|
-
|
|
5822
|
-
| Param | Type | Description |
|
|
5823
|
-
| --- | --- | --- |
|
|
5824
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5825
|
-
|
|
5826
5822
|
<a name="Init.gitPush"></a>
|
|
5827
5823
|
|
|
5828
|
-
### Init.gitPush(
|
|
5824
|
+
### Init.gitPush() ⇒ <code>void</code>
|
|
5829
5825
|
offer to push the new repo straight to the server
|
|
5830
5826
|
|
|
5831
5827
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5832
|
-
|
|
5833
|
-
| Param | Type | Description |
|
|
5834
|
-
| --- | --- | --- |
|
|
5835
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5836
|
-
|
|
5837
5828
|
<a name="Init._addGitRemote"></a>
|
|
5838
5829
|
|
|
5839
|
-
### Init.\_addGitRemote(
|
|
5830
|
+
### Init.\_addGitRemote() ⇒ <code>string</code>
|
|
5840
5831
|
offers to add the git remote origin
|
|
5841
5832
|
|
|
5842
5833
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5843
5834
|
**Returns**: <code>string</code> - repo name (optionally)
|
|
5844
|
-
|
|
5845
|
-
| Param | Type | Description |
|
|
5846
|
-
| --- | --- | --- |
|
|
5847
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5848
|
-
|
|
5849
5835
|
<a name="Init._updateGitConfigUser"></a>
|
|
5850
5836
|
|
|
5851
|
-
### Init.\_updateGitConfigUser(
|
|
5837
|
+
### Init.\_updateGitConfigUser() ⇒ <code>void</code>
|
|
5852
5838
|
checks global config and ask to config the user info and then store it locally
|
|
5853
5839
|
|
|
5854
5840
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
5855
|
-
|
|
5856
|
-
| Param | Type | Description |
|
|
5857
|
-
| --- | --- | --- |
|
|
5858
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5859
|
-
|
|
5860
5841
|
<a name="Init._getGitConfigUser"></a>
|
|
5861
5842
|
|
|
5862
5843
|
### Init.\_getGitConfigUser() ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
@@ -5866,7 +5847,7 @@ retrieves the global user.name and user.email values
|
|
|
5866
5847
|
**Returns**: <code>Promise.<{'user.name': string, 'user.email': string}></code> - user.name and user.email
|
|
5867
5848
|
<a name="Init.initProject"></a>
|
|
5868
5849
|
|
|
5869
|
-
### Init.initProject(properties, credentialName
|
|
5850
|
+
### Init.initProject(properties, credentialName) ⇒ <code>Promise.<void></code>
|
|
5870
5851
|
Creates template file for properties.json
|
|
5871
5852
|
|
|
5872
5853
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5876,11 +5857,10 @@ Creates template file for properties.json
|
|
|
5876
5857
|
| --- | --- | --- |
|
|
5877
5858
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
5878
5859
|
| credentialName | <code>string</code> | identifying name of the installed package / project |
|
|
5879
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5880
5860
|
|
|
5881
5861
|
<a name="Init._downloadAllBUs"></a>
|
|
5882
5862
|
|
|
5883
|
-
### Init.\_downloadAllBUs(bu, gitStatus
|
|
5863
|
+
### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.<void></code>
|
|
5884
5864
|
helper for this.initProject()
|
|
5885
5865
|
|
|
5886
5866
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -5890,7 +5870,6 @@ helper for this.initProject()
|
|
|
5890
5870
|
| --- | --- | --- |
|
|
5891
5871
|
| bu | <code>string</code> | cred/bu or cred/* or * |
|
|
5892
5872
|
| gitStatus | <code>string</code> | signals what state the git repo is in |
|
|
5893
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
5894
5873
|
|
|
5895
5874
|
<a name="Init.upgradeProject"></a>
|
|
5896
5875
|
|
|
@@ -5958,13 +5937,13 @@ CLI helper class
|
|
|
5958
5937
|
* [._getForcedUpdateList(projectVersion)](#Init._getForcedUpdateList) ⇒ <code>Promise.<Array.<string>></code>
|
|
5959
5938
|
* [._createIdeConfigFile(fileNameArr, relevantForcedUpdates, [boilerplateFileContent])](#Init._createIdeConfigFile) ⇒ <code>Promise.<boolean></code>
|
|
5960
5939
|
* [.upgradeAuthFile()](#Init.upgradeAuthFile) ⇒ <code>Promise.<boolean></code>
|
|
5961
|
-
* [.initGitRepo(
|
|
5962
|
-
* [.gitPush(
|
|
5963
|
-
* [._addGitRemote(
|
|
5964
|
-
* [._updateGitConfigUser(
|
|
5940
|
+
* [.initGitRepo()](#Init.initGitRepo) ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
5941
|
+
* [.gitPush()](#Init.gitPush) ⇒ <code>void</code>
|
|
5942
|
+
* [._addGitRemote()](#Init._addGitRemote) ⇒ <code>string</code>
|
|
5943
|
+
* [._updateGitConfigUser()](#Init._updateGitConfigUser) ⇒ <code>void</code>
|
|
5965
5944
|
* [._getGitConfigUser()](#Init._getGitConfigUser) ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
5966
|
-
* [.initProject(properties, credentialName
|
|
5967
|
-
* [._downloadAllBUs(bu, gitStatus
|
|
5945
|
+
* [.initProject(properties, credentialName)](#Init.initProject) ⇒ <code>Promise.<void></code>
|
|
5946
|
+
* [._downloadAllBUs(bu, gitStatus)](#Init._downloadAllBUs) ⇒ <code>Promise.<void></code>
|
|
5968
5947
|
* [.upgradeProject(properties, [initial], [repoName])](#Init.upgradeProject) ⇒ <code>Promise.<boolean></code>
|
|
5969
5948
|
* [._getMissingCredentials(properties)](#Init._getMissingCredentials) ⇒ <code>Array.<string></code>
|
|
5970
5949
|
* [.installDependencies([repoName])](#Init.installDependencies) ⇒ <code>Promise.<boolean></code>
|
|
@@ -6042,50 +6021,30 @@ helper method for this.upgradeProject that upgrades project config if needed
|
|
|
6042
6021
|
**Returns**: <code>Promise.<boolean></code> - returns true if worked without errors
|
|
6043
6022
|
<a name="Init.initGitRepo"></a>
|
|
6044
6023
|
|
|
6045
|
-
### Init.initGitRepo(
|
|
6024
|
+
### Init.initGitRepo() ⇒ <code>Promise.<{status: string, repoName: string}></code>
|
|
6046
6025
|
check if git repo exists and otherwise create one
|
|
6047
6026
|
|
|
6048
6027
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
6049
6028
|
**Returns**: <code>Promise.<{status: string, repoName: string}></code> - success flag
|
|
6050
|
-
|
|
6051
|
-
| Param | Type | Description |
|
|
6052
|
-
| --- | --- | --- |
|
|
6053
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6054
|
-
|
|
6055
6029
|
<a name="Init.gitPush"></a>
|
|
6056
6030
|
|
|
6057
|
-
### Init.gitPush(
|
|
6031
|
+
### Init.gitPush() ⇒ <code>void</code>
|
|
6058
6032
|
offer to push the new repo straight to the server
|
|
6059
6033
|
|
|
6060
6034
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
6061
|
-
|
|
6062
|
-
| Param | Type | Description |
|
|
6063
|
-
| --- | --- | --- |
|
|
6064
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6065
|
-
|
|
6066
6035
|
<a name="Init._addGitRemote"></a>
|
|
6067
6036
|
|
|
6068
|
-
### Init.\_addGitRemote(
|
|
6037
|
+
### Init.\_addGitRemote() ⇒ <code>string</code>
|
|
6069
6038
|
offers to add the git remote origin
|
|
6070
6039
|
|
|
6071
6040
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
6072
6041
|
**Returns**: <code>string</code> - repo name (optionally)
|
|
6073
|
-
|
|
6074
|
-
| Param | Type | Description |
|
|
6075
|
-
| --- | --- | --- |
|
|
6076
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6077
|
-
|
|
6078
6042
|
<a name="Init._updateGitConfigUser"></a>
|
|
6079
6043
|
|
|
6080
|
-
### Init.\_updateGitConfigUser(
|
|
6044
|
+
### Init.\_updateGitConfigUser() ⇒ <code>void</code>
|
|
6081
6045
|
checks global config and ask to config the user info and then store it locally
|
|
6082
6046
|
|
|
6083
6047
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
6084
|
-
|
|
6085
|
-
| Param | Type | Description |
|
|
6086
|
-
| --- | --- | --- |
|
|
6087
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6088
|
-
|
|
6089
6048
|
<a name="Init._getGitConfigUser"></a>
|
|
6090
6049
|
|
|
6091
6050
|
### Init.\_getGitConfigUser() ⇒ <code>Promise.<{'user.name': string, 'user.email': string}></code>
|
|
@@ -6095,7 +6054,7 @@ retrieves the global user.name and user.email values
|
|
|
6095
6054
|
**Returns**: <code>Promise.<{'user.name': string, 'user.email': string}></code> - user.name and user.email
|
|
6096
6055
|
<a name="Init.initProject"></a>
|
|
6097
6056
|
|
|
6098
|
-
### Init.initProject(properties, credentialName
|
|
6057
|
+
### Init.initProject(properties, credentialName) ⇒ <code>Promise.<void></code>
|
|
6099
6058
|
Creates template file for properties.json
|
|
6100
6059
|
|
|
6101
6060
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -6105,11 +6064,10 @@ Creates template file for properties.json
|
|
|
6105
6064
|
| --- | --- | --- |
|
|
6106
6065
|
| properties | <code>TYPE.Mcdevrc</code> | config file's json |
|
|
6107
6066
|
| credentialName | <code>string</code> | identifying name of the installed package / project |
|
|
6108
|
-
| [skipInteraction] | <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6109
6067
|
|
|
6110
6068
|
<a name="Init._downloadAllBUs"></a>
|
|
6111
6069
|
|
|
6112
|
-
### Init.\_downloadAllBUs(bu, gitStatus
|
|
6070
|
+
### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.<void></code>
|
|
6113
6071
|
helper for this.initProject()
|
|
6114
6072
|
|
|
6115
6073
|
**Kind**: static method of [<code>Init</code>](#Init)
|
|
@@ -6119,7 +6077,6 @@ helper for this.initProject()
|
|
|
6119
6077
|
| --- | --- | --- |
|
|
6120
6078
|
| bu | <code>string</code> | cred/bu or cred/* or * |
|
|
6121
6079
|
| gitStatus | <code>string</code> | signals what state the git repo is in |
|
|
6122
|
-
| [skipInteraction] | <code>boolean</code> \| <code>TYPE.skipInteraction</code> | signals what to insert automatically for things usually asked via wizard |
|
|
6123
6080
|
|
|
6124
6081
|
<a name="Init.upgradeProject"></a>
|
|
6125
6082
|
|