mcdev 4.1.7 → 4.1.8
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 +1 -0
- package/README.md +70 -69
- package/docs/dist/documentation.md +34 -34
- package/lib/Deployer.js +27 -19
- package/lib/index.js +1 -1
- package/lib/metadataTypes/Asset.js +8 -8
- package/lib/metadataTypes/DataExtension.js +1 -1
- package/lib/metadataTypes/DataExtensionField.js +1 -1
- package/lib/metadataTypes/Folder.js +29 -15
- package/lib/metadataTypes/MetadataType.js +4 -4
- package/lib/metadataTypes/Query.js +4 -4
- package/lib/metadataTypes/Script.js +4 -4
- package/lib/metadataTypes/definitions/Folder.definition.js +6 -0
- package/lib/util/cli.js +2 -2
- package/lib/util/file.js +1 -1
- package/lib/util/init.config.js +1 -1
- package/lib/util/init.js +1 -1
- package/lib/util/util.js +1 -1
- package/package.json +1 -1
- package/test/mockRoot/.mcdevrc.json +1 -1
|
@@ -85,7 +85,7 @@ class Script extends MetadataType {
|
|
|
85
85
|
}
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
|
-
* helper for
|
|
88
|
+
* helper for {@link preDeployTasks} that loads extracted code content back into JSON
|
|
89
89
|
*
|
|
90
90
|
* @param {TYPE.ScriptItem} metadata a single asset definition
|
|
91
91
|
* @param {string} deployDir directory of deploy files
|
|
@@ -137,7 +137,7 @@ class Script extends MetadataType {
|
|
|
137
137
|
return metadata;
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* helper for buildDefinition
|
|
140
|
+
* helper for {@link MetadataType.buildDefinition}
|
|
141
141
|
* handles extracted code if any are found for complex types
|
|
142
142
|
*
|
|
143
143
|
* @param {string} templateDir Directory where metadata templates are stored
|
|
@@ -164,7 +164,7 @@ class Script extends MetadataType {
|
|
|
164
164
|
);
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
|
-
* helper for buildTemplate
|
|
167
|
+
* helper for {@link MetadataType.buildTemplate}
|
|
168
168
|
* handles extracted code if any are found for complex types
|
|
169
169
|
*
|
|
170
170
|
* @example scripts are saved as 1 json and 1 ssjs file. both files need to be run through templating
|
|
@@ -193,7 +193,7 @@ class Script extends MetadataType {
|
|
|
193
193
|
}
|
|
194
194
|
|
|
195
195
|
/**
|
|
196
|
-
* helper for buildTemplateForNested / buildDefinitionForNested
|
|
196
|
+
* helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
|
|
197
197
|
* handles extracted code if any are found for complex types
|
|
198
198
|
*
|
|
199
199
|
* @param {string} templateDir Directory where metadata templates are stored
|
package/lib/util/cli.js
CHANGED
|
@@ -294,7 +294,7 @@ const Cli = {
|
|
|
294
294
|
},
|
|
295
295
|
|
|
296
296
|
/**
|
|
297
|
-
* helper for addExtraCredential
|
|
297
|
+
* helper for {@link Cli.addExtraCredential}
|
|
298
298
|
*
|
|
299
299
|
* @param {TYPE.Mcdevrc} properties from config file
|
|
300
300
|
* @param {string} [credName] name of credential that needs updating
|
|
@@ -489,7 +489,7 @@ const Cli = {
|
|
|
489
489
|
}
|
|
490
490
|
},
|
|
491
491
|
/**
|
|
492
|
-
* helper for
|
|
492
|
+
* helper for {@link Cli.selectTypes} that converts subtypes back to main type if all and only defaults were selected
|
|
493
493
|
* this keeps the config automatically upgradable when we add new subtypes or change what is selected by default
|
|
494
494
|
*
|
|
495
495
|
* @param {object} responses wrapper object for respones
|
package/lib/util/file.js
CHANGED
|
@@ -169,7 +169,7 @@ const File = {
|
|
|
169
169
|
return this.writeToFile(directory, filename, filetype, formatted);
|
|
170
170
|
},
|
|
171
171
|
/**
|
|
172
|
-
* helper for writePrettyToFile, applying prettier onto given stringified content
|
|
172
|
+
* helper for {@link File.writePrettyToFile}, applying prettier onto given stringified content
|
|
173
173
|
* ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
|
|
174
174
|
*
|
|
175
175
|
* @param {string|string[]} directory directory the file will be written to
|
package/lib/util/init.config.js
CHANGED
|
@@ -267,7 +267,7 @@ const Init = {
|
|
|
267
267
|
}
|
|
268
268
|
},
|
|
269
269
|
/**
|
|
270
|
-
* recursive helper for
|
|
270
|
+
* recursive helper for {@link Init.fixMcdevConfig} that adds missing settings
|
|
271
271
|
*
|
|
272
272
|
* @param {object} propertiersCur current sub-object of project settings
|
|
273
273
|
* @param {object} defaultPropsCur current sub-object of default settings
|
package/lib/util/init.js
CHANGED
package/lib/util/util.js
CHANGED
|
@@ -151,7 +151,7 @@ const Util = {
|
|
|
151
151
|
return ['false', 'FALSE', 'False', '0', 0, 'N', false].includes(attrValue);
|
|
152
152
|
},
|
|
153
153
|
/**
|
|
154
|
-
* helper for retrieve, retrieveAsTemplate and deploy
|
|
154
|
+
* helper for {@link Mcdev.retrieve}, {@link Mcdev.retrieveAsTemplate} and {@link Mcdev.deploy}
|
|
155
155
|
*
|
|
156
156
|
* @param {TYPE.SupportedMetadataTypes} selectedType type or type-subtype
|
|
157
157
|
* @returns {boolean} type ok or not
|
package/package.json
CHANGED