ember-cli 4.0.0 → 4.1.1
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/workflows/ci.yml +4 -4
- package/CHANGELOG.md +42 -2
- package/blueprints/addon/additional-dev-dependencies.json +1 -1
- package/blueprints/addon/files/.github/workflows/ci.yml +0 -1
- package/blueprints/addon/files/.travis.yml +0 -1
- package/blueprints/addon/files/addon-config/ember-try.js +0 -13
- package/blueprints/app/files/config/environment.js +1 -1
- package/blueprints/app/files/package.json +6 -6
- package/docs/build/data.json +3 -3
- package/lib/models/host-info-cache.js +3 -5
- package/lib/models/per-bundle-addon-cache/index.js +2 -3
- package/lib/tasks/npm-task.js +1 -1
- package/lib/utilities/get-lang-arg.js +45 -45
- package/package.json +25 -25
- package/tests/helpers/mock-project.js +1 -1
- package/.github/ISSUE_TEMPLATE.md +0 -12
- package/.github/dependabot.yml +0 -15
- package/.github/workflows/coverage.yml +0 -31
- package/docs/analytics.md +0 -44
- package/docs/architecture.md +0 -316
- package/docs/assets/architecture/Ember-CLI architecture.png +0 -0
- package/docs/assets/architecture/Ember-CLI architecture.xml +0 -1
- package/docs/assets/architecture/README.md +0 -5
- package/docs/brocfile-transition.md +0 -46
- package/docs/build/api.js +0 -44
- package/docs/build/assets/css/external-small.png +0 -0
- package/docs/build/assets/css/logo.png +0 -0
- package/docs/build/assets/css/main.css +0 -555
- package/docs/build/assets/favicon.ico +0 -0
- package/docs/build/assets/img/spinner.gif +0 -0
- package/docs/build/assets/index.html +0 -10
- package/docs/build/assets/js/api-filter.js +0 -56
- package/docs/build/assets/js/api-list.js +0 -255
- package/docs/build/assets/js/api-search.js +0 -98
- package/docs/build/assets/js/apidocs.js +0 -376
- package/docs/build/assets/js/yui-prettify.js +0 -17
- package/docs/build/assets/vendor/prettify/CHANGES.html +0 -130
- package/docs/build/assets/vendor/prettify/COPYING +0 -202
- package/docs/build/assets/vendor/prettify/README.html +0 -203
- package/docs/build/assets/vendor/prettify/prettify-min.css +0 -1
- package/docs/build/assets/vendor/prettify/prettify-min.js +0 -1
- package/docs/build/classes/Addon.html +0 -4318
- package/docs/build/classes/AmdTransformAddon.html +0 -202
- package/docs/build/classes/Blueprint.html +0 -4796
- package/docs/build/classes/Builder.html +0 -611
- package/docs/build/classes/CLI.html +0 -810
- package/docs/build/classes/Command.html +0 -1655
- package/docs/build/classes/DefaultPackager.html +0 -202
- package/docs/build/classes/EmberAddon.html +0 -2207
- package/docs/build/classes/EmberApp.html +0 -2225
- package/docs/build/classes/HardwareInfo.html +0 -620
- package/docs/build/classes/HistorySupportAddon.html +0 -203
- package/docs/build/classes/Instrumentation.html +0 -695
- package/docs/build/classes/NodeModulesList.html +0 -460
- package/docs/build/classes/NpmTask.html +0 -333
- package/docs/build/classes/PackageInfo.html +0 -1390
- package/docs/build/classes/PackageInfoCache.html +0 -963
- package/docs/build/classes/PerBundleAddonCache {.html +0 -1010
- package/docs/build/classes/Project.html +0 -2083
- package/docs/build/classes/ServeFilesAddon.html +0 -260
- package/docs/build/classes/TestsServerAddon.html +0 -203
- package/docs/build/classes/WatcherAddon.html +0 -204
- package/docs/build/classes/WindowsSymlinkChecker.html +0 -1505
- package/docs/build/files/lib_broccoli_default-packager.js.html +0 -1426
- package/docs/build/files/lib_broccoli_ember-addon.js.html +0 -159
- package/docs/build/files/lib_broccoli_ember-app.js.html +0 -1913
- package/docs/build/files/lib_cli_cli.js.html +0 -417
- package/docs/build/files/lib_models_addon-info.js.html +0 -112
- package/docs/build/files/lib_models_addon.js.html +0 -1866
- package/docs/build/files/lib_models_blueprint.js.html +0 -1678
- package/docs/build/files/lib_models_builder.js.html +0 -417
- package/docs/build/files/lib_models_command.js.html +0 -804
- package/docs/build/files/lib_models_hardware-info.js.html +0 -479
- package/docs/build/files/lib_models_host-info-cache.js.html +0 -428
- package/docs/build/files/lib_models_installation-checker.js.html +0 -181
- package/docs/build/files/lib_models_instantiate-addons.js.html +0 -191
- package/docs/build/files/lib_models_instrumentation.js.html +0 -433
- package/docs/build/files/lib_models_package-info-cache_index.js.html +0 -793
- package/docs/build/files/lib_models_package-info-cache_node-modules-list.js.html +0 -208
- package/docs/build/files/lib_models_package-info-cache_package-info.js.html +0 -661
- package/docs/build/files/lib_models_per-bundle-addon-cache_addon-proxy.js.html +0 -252
- package/docs/build/files/lib_models_per-bundle-addon-cache_index.js.html +0 -485
- package/docs/build/files/lib_models_per-bundle-addon-cache_target-instance.js.html +0 -108
- package/docs/build/files/lib_models_project.js.html +0 -913
- package/docs/build/files/lib_models_task.js.html +0 -117
- package/docs/build/files/lib_tasks_build-watch.js.html +0 -157
- package/docs/build/files/lib_tasks_npm-task.js.html +0 -463
- package/docs/build/files/lib_tasks_serve.js.html +0 -207
- package/docs/build/files/lib_tasks_server_middleware_broccoli-serve-files_index.js.html +0 -127
- package/docs/build/files/lib_tasks_server_middleware_broccoli-watcher_index.js.html +0 -158
- package/docs/build/files/lib_tasks_server_middleware_history-support_index.js.html +0 -181
- package/docs/build/files/lib_tasks_server_middleware_tests-server_index.js.html +0 -171
- package/docs/build/files/lib_tasks_test-server.js.html +0 -167
- package/docs/build/files/lib_tasks_transforms_amd_index.js.html +0 -143
- package/docs/build/files/lib_utilities_ember-app-utils.js.html +0 -292
- package/docs/build/files/lib_utilities_insert-into-file.js.html +0 -219
- package/docs/build/files/lib_utilities_is-lazy-engine.js.html +0 -125
- package/docs/build/files/lib_utilities_is-yarn-project.js.html +0 -120
- package/docs/build/files/lib_utilities_valid-project-name.js.html +0 -142
- package/docs/build/files/lib_utilities_will-interrupt-process.js.html +0 -290
- package/docs/build/files/lib_utilities_windows-admin.js.html +0 -230
- package/docs/build/index.html +0 -125
- package/docs/build/modules/ember-cli.html +0 -152
- package/docs/build/modules/is-lazy-engine.html +0 -106
- package/docs/build-concurrency.md +0 -15
- package/docs/build-pipeline-debugging.md +0 -33
- package/docs/code-coverage.md +0 -14
- package/docs/error-propagation.md +0 -136
- package/docs/experiments.md +0 -53
- package/docs/node-support.md +0 -43
- package/docs/perf-guide.md +0 -250
- package/docs/project_version_preprocessor.js +0 -8
- package/docs/sourcemaps.md +0 -60
- package/docs/yuidoc.json +0 -13
|
@@ -1,4796 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>Blueprint - ember-cli</title>
|
|
6
|
-
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
|
|
7
|
-
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
|
|
8
|
-
<script src="https://cdnjs.cloudflare.com/ajax/libs/yui/3.18.0/yui/yui-min.js"></script>
|
|
9
|
-
</head>
|
|
10
|
-
<body class="yui3-skin-sam">
|
|
11
|
-
|
|
12
|
-
<div id="doc">
|
|
13
|
-
<div class="yui3-g">
|
|
14
|
-
<div id="sidebar" class="yui3-u">
|
|
15
|
-
<div class="logo">
|
|
16
|
-
<a href="../index.html">
|
|
17
|
-
<img src="https://ember-cli.com/assets/images/ember-cli-logo-small-dark.png">
|
|
18
|
-
</a>
|
|
19
|
-
</div>
|
|
20
|
-
|
|
21
|
-
<div id="modules" class="sidebox">
|
|
22
|
-
<div class="hd">
|
|
23
|
-
<h2 class="no-toc">Modules</h2>
|
|
24
|
-
</div>
|
|
25
|
-
<div class="bd">
|
|
26
|
-
<ul>
|
|
27
|
-
<li><a href="../modules/ember-cli.html">ember-cli</a>
|
|
28
|
-
</li>
|
|
29
|
-
<li><a href="../modules/is-lazy-engine.html">is-lazy-engine</a>
|
|
30
|
-
</li>
|
|
31
|
-
</ul>
|
|
32
|
-
</div>
|
|
33
|
-
</div>
|
|
34
|
-
|
|
35
|
-
<div id="classes" class="sidebox">
|
|
36
|
-
<div class="hd">
|
|
37
|
-
<h2 class="no-toc">Classes</h2>
|
|
38
|
-
</div>
|
|
39
|
-
<div class="bd">
|
|
40
|
-
<ul>
|
|
41
|
-
<li><a href="../classes/Addon.html">Addon</a></li>
|
|
42
|
-
<li><a href="../classes/AmdTransformAddon.html">AmdTransformAddon</a></li>
|
|
43
|
-
<li><a href="../classes/Blueprint.html">Blueprint</a></li>
|
|
44
|
-
<li><a href="../classes/Builder.html">Builder</a></li>
|
|
45
|
-
<li><a href="../classes/CLI.html">CLI</a></li>
|
|
46
|
-
<li><a href="../classes/Command.html">Command</a></li>
|
|
47
|
-
<li><a href="../classes/DefaultPackager.html">DefaultPackager</a></li>
|
|
48
|
-
<li><a href="../classes/EmberAddon.html">EmberAddon</a></li>
|
|
49
|
-
<li><a href="../classes/EmberApp.html">EmberApp</a></li>
|
|
50
|
-
<li><a href="../classes/HardwareInfo.html">HardwareInfo</a></li>
|
|
51
|
-
<li><a href="../classes/HistorySupportAddon.html">HistorySupportAddon</a></li>
|
|
52
|
-
<li><a href="../classes/Instrumentation.html">Instrumentation</a></li>
|
|
53
|
-
<li><a href="../classes/NodeModulesList.html">NodeModulesList</a></li>
|
|
54
|
-
<li><a href="../classes/NpmTask.html">NpmTask</a></li>
|
|
55
|
-
<li><a href="../classes/PackageInfo.html">PackageInfo</a></li>
|
|
56
|
-
<li><a href="../classes/PackageInfoCache.html">PackageInfoCache</a></li>
|
|
57
|
-
<li><a href="../classes/PerBundleAddonCache {.html">PerBundleAddonCache {</a></li>
|
|
58
|
-
<li><a href="../classes/Project.html">Project</a></li>
|
|
59
|
-
<li><a href="../classes/ServeFilesAddon.html">ServeFilesAddon</a></li>
|
|
60
|
-
<li><a href="../classes/TestsServerAddon.html">TestsServerAddon</a></li>
|
|
61
|
-
<li><a href="../classes/WatcherAddon.html">WatcherAddon</a></li>
|
|
62
|
-
<li><a href="../classes/WindowsSymlinkChecker.html">WindowsSymlinkChecker</a></li>
|
|
63
|
-
</ul>
|
|
64
|
-
</div>
|
|
65
|
-
</div>
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
<div id="sections" class="sidebox">
|
|
69
|
-
<div class="hd">
|
|
70
|
-
<h2 class="no-toc">Blueprint</h2>
|
|
71
|
-
</div>
|
|
72
|
-
<div class="bd">
|
|
73
|
-
<div><a href="#static-property-summary">Static Property Summary</a></div>
|
|
74
|
-
|
|
75
|
-
<div><a href="#static-method-summary">Static Method Summary</a></div>
|
|
76
|
-
|
|
77
|
-
<div><a href="#constructor-summary">Constructor Summary</a></div>
|
|
78
|
-
|
|
79
|
-
<div><a href="#property-summary">Property Summary</a></div>
|
|
80
|
-
|
|
81
|
-
<div><a href="#method-summary">Method Summary</a></div>
|
|
82
|
-
|
|
83
|
-
<div><a href="#static-public-properties">Static Public Properties</a></div>
|
|
84
|
-
<ul>
|
|
85
|
-
<li><a href="#props_defaultLookupPaths">defaultLookupPaths</a></li>
|
|
86
|
-
<li><a href="#props_ignoredFiles">ignoredFiles</a></li>
|
|
87
|
-
<li><a href="#props_ignoredUpdateFiles">ignoredUpdateFiles</a></li>
|
|
88
|
-
<li><a href="#props_renamedFiles">renamedFiles</a></li>
|
|
89
|
-
</ul>
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
<div><a href="#static-public-methods">Static Public Methods</a></div>
|
|
94
|
-
<ul>
|
|
95
|
-
<li><a href="#method_list">list</a></li>
|
|
96
|
-
<li><a href="#method_load">load</a></li>
|
|
97
|
-
<li><a href="#method_lookup">lookup</a></li>
|
|
98
|
-
</ul>
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
<div><a href="#public-constructors">Public Constructors</a></div>
|
|
103
|
-
<ul>
|
|
104
|
-
<li><a href="#method_Blueprint">Blueprint</a></li>
|
|
105
|
-
</ul>
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
<div><a href="#private-properties">Private Properties</a></div>
|
|
112
|
-
<ul>
|
|
113
|
-
<li><a href="#props__actions">_actions</a></li>
|
|
114
|
-
</ul>
|
|
115
|
-
|
|
116
|
-
<div><a href="#public-methods">Public Methods</a></div>
|
|
117
|
-
<ul>
|
|
118
|
-
<li><a href="#method_addAddonsToProject">addAddonsToProject</a></li>
|
|
119
|
-
<li><a href="#method_addAddonToProject">addAddonToProject</a></li>
|
|
120
|
-
<li><a href="#method_addBowerPackagesToProject">addBowerPackagesToProject</a></li>
|
|
121
|
-
<li><a href="#method_addBowerPackageToProject">addBowerPackageToProject</a></li>
|
|
122
|
-
<li><a href="#method_addPackagesToProject">addPackagesToProject</a></li>
|
|
123
|
-
<li><a href="#method_addPackageToProject">addPackageToProject</a></li>
|
|
124
|
-
<li><a href="#method_afterInstall">afterInstall</a></li>
|
|
125
|
-
<li><a href="#method_afterUninstall">afterUninstall</a></li>
|
|
126
|
-
<li><a href="#method_beforeInstall">beforeInstall</a></li>
|
|
127
|
-
<li><a href="#method_beforeUninstall">beforeUninstall</a></li>
|
|
128
|
-
<li><a href="#method_buildFileInfo">buildFileInfo</a></li>
|
|
129
|
-
<li><a href="#method_fileMapTokens">fileMapTokens</a></li>
|
|
130
|
-
<li><a href="#method_files">files</a></li>
|
|
131
|
-
<li><a href="#method_filesPath">filesPath</a></li>
|
|
132
|
-
<li><a href="#method_generateFileMap">generateFileMap</a></li>
|
|
133
|
-
<li><a href="#method_insertIntoFile">insertIntoFile</a></li>
|
|
134
|
-
<li><a href="#method_install">install</a></li>
|
|
135
|
-
<li><a href="#method_isUpdate">isUpdate</a></li>
|
|
136
|
-
<li><a href="#method_locals">locals</a></li>
|
|
137
|
-
<li><a href="#method_lookupBlueprint">lookupBlueprint</a></li>
|
|
138
|
-
<li><a href="#method_mapFile">mapFile</a></li>
|
|
139
|
-
<li><a href="#method_normalizeEntityName">normalizeEntityName</a></li>
|
|
140
|
-
<li><a href="#method_processFiles">processFiles</a></li>
|
|
141
|
-
<li><a href="#method_processFilesForUninstall">processFilesForUninstall</a></li>
|
|
142
|
-
<li><a href="#method_removePackageFromProject">removePackageFromProject</a></li>
|
|
143
|
-
<li><a href="#method_removePackagesFromProject">removePackagesFromProject</a></li>
|
|
144
|
-
<li><a href="#method_srcPath">srcPath</a></li>
|
|
145
|
-
<li><a href="#method_taskFor">taskFor</a></li>
|
|
146
|
-
<li><a href="#method_uninstall">uninstall</a></li>
|
|
147
|
-
</ul>
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
<div><a href="#private-methods">Private Methods</a></div>
|
|
151
|
-
<ul>
|
|
152
|
-
<li><a href="#method__checkForNoMatch">_checkForNoMatch</a></li>
|
|
153
|
-
<li><a href="#method__checkForPod">_checkForPod</a></li>
|
|
154
|
-
<li><a href="#method__checkInRepoAddonExists">_checkInRepoAddonExists</a></li>
|
|
155
|
-
<li><a href="#method__commit">_commit</a></li>
|
|
156
|
-
<li><a href="#method__fileMapTokens">_fileMapTokens</a></li>
|
|
157
|
-
<li><a href="#method__generateFileMapVariables">_generateFileMapVariables</a></li>
|
|
158
|
-
<li><a href="#method__getFileInfos">_getFileInfos</a></li>
|
|
159
|
-
<li><a href="#method__getFilesForInstall">_getFilesForInstall</a></li>
|
|
160
|
-
<li><a href="#method__ignoreUpdateFiles">_ignoreUpdateFiles</a></li>
|
|
161
|
-
<li><a href="#method__locals">_locals</a></li>
|
|
162
|
-
<li><a href="#method__normalizeEntityName">_normalizeEntityName</a></li>
|
|
163
|
-
<li><a href="#method__process">_process</a></li>
|
|
164
|
-
<li><a href="#method__writeFile">_writeFile</a></li>
|
|
165
|
-
<li><a href="#method__writeStatusToUI">_writeStatusToUI</a></li>
|
|
166
|
-
<li><a href="#method_dir">dir</a></li>
|
|
167
|
-
<li><a href="#method_gatherConfirmationMessages">gatherConfirmationMessages</a></li>
|
|
168
|
-
<li><a href="#method_generateLookupPaths">generateLookupPaths</a></li>
|
|
169
|
-
<li><a href="#method_getDetailedHelpPath">getDetailedHelpPath</a></li>
|
|
170
|
-
<li><a href="#method_hasPathToken">hasPathToken</a></li>
|
|
171
|
-
<li><a href="#method_isFilePath">isFilePath</a></li>
|
|
172
|
-
<li><a href="#method_isIgnored">isIgnored</a></li>
|
|
173
|
-
<li><a href="#method_isValidFile">isValidFile</a></li>
|
|
174
|
-
<li><a href="#method_markIdenticalToBeSkipped">markIdenticalToBeSkipped</a></li>
|
|
175
|
-
<li><a href="#method_markToBeRemoved">markToBeRemoved</a></li>
|
|
176
|
-
<li><a href="#method_prepareConfirm">prepareConfirm</a></li>
|
|
177
|
-
<li><a href="#method_supportsAddon">supportsAddon</a></li>
|
|
178
|
-
</ul>
|
|
179
|
-
</div>
|
|
180
|
-
</div>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
<div class="version-info">
|
|
185
|
-
Version: 4.0.0-release-b4cbb1029f
|
|
186
|
-
</div>
|
|
187
|
-
|
|
188
|
-
</div>
|
|
189
|
-
|
|
190
|
-
<div id="main" class="yui3-u">
|
|
191
|
-
<div class="content"><div class="title">
|
|
192
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l30"><code>lib/models/blueprint.js:30</code></a></span>
|
|
193
|
-
<h1 class="class-name">Blueprint</h1>
|
|
194
|
-
</div>
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
<div class="class-extends">
|
|
199
|
-
<h4>Extends:</h4>
|
|
200
|
-
<div>CoreObject → Blueprint</div>
|
|
201
|
-
</div>
|
|
202
|
-
|
|
203
|
-
<div class="class-description"><p>A blueprint is a bundle of template files with optional install
|
|
204
|
-
logic.</p>
|
|
205
|
-
<p>Blueprints follow a simple structure. Let's take the built-in
|
|
206
|
-
<code>controller</code> blueprint as an example:</p>
|
|
207
|
-
<pre class="code prettyprint"><code>blueprints/controller
|
|
208
|
-
├── files
|
|
209
|
-
│ ├── app
|
|
210
|
-
│ │ └── __path__
|
|
211
|
-
│ │ └── __name__.js
|
|
212
|
-
└── index.js
|
|
213
|
-
|
|
214
|
-
blueprints/controller-test
|
|
215
|
-
├── files
|
|
216
|
-
│ └── tests
|
|
217
|
-
│ └── unit
|
|
218
|
-
│ └── controllers
|
|
219
|
-
│ └── __test__.js
|
|
220
|
-
└── index.js
|
|
221
|
-
</code></pre>
|
|
222
|
-
<h2>Files</h2>
|
|
223
|
-
<p><code>files</code> contains templates for the all the files to be
|
|
224
|
-
installed into the target directory.</p>
|
|
225
|
-
<p>The <code>__name__</code> token is subtituted with the dasherized
|
|
226
|
-
entity name at install time. For example, when the user
|
|
227
|
-
invokes <code>ember generate controller foo</code> then <code>__name__</code> becomes
|
|
228
|
-
<code>foo</code>. When the <code>--pod</code> flag is used, for example <code>ember generate controller foo --pod</code> then <code>__name__</code> becomes
|
|
229
|
-
<code>controller</code>.</p>
|
|
230
|
-
<p>The <code>__path__</code> token is substituted with the blueprint
|
|
231
|
-
name at install time. For example, when the user invokes
|
|
232
|
-
<code>ember generate controller foo</code> then <code>__path__</code> becomes
|
|
233
|
-
<code>controller</code>. When the <code>--pod</code> flag is used, for example
|
|
234
|
-
<code>ember generate controller foo --pod</code> then <code>__path__</code>
|
|
235
|
-
becomes <code>foo</code> (or <code><podModulePrefix>/foo</code> if the
|
|
236
|
-
podModulePrefix is defined). This token is primarily for
|
|
237
|
-
pod support, and is only necessary if the blueprint can be
|
|
238
|
-
used in pod structure. If the blueprint does not require pod
|
|
239
|
-
support, simply use the blueprint name instead of the
|
|
240
|
-
<code>__path__</code> token.</p>
|
|
241
|
-
<p>The <code>__test__</code> token is substituted with the dasherized
|
|
242
|
-
entity name and appended with <code>-test</code> at install time.
|
|
243
|
-
This token is primarily for pod support and only necessary
|
|
244
|
-
if the blueprint requires support for a pod structure. If
|
|
245
|
-
the blueprint does not require pod support, simply use the
|
|
246
|
-
<code>__name__</code> token instead.</p>
|
|
247
|
-
<h2>Template Variables (AKA Locals)</h2>
|
|
248
|
-
<p>Variables can be inserted into templates with
|
|
249
|
-
<code><%= someVariableName %></code>.</p>
|
|
250
|
-
<p>For example, the built-in <code>util</code> blueprint
|
|
251
|
-
<code>files/app/utils/__name__.js</code> looks like this:</p>
|
|
252
|
-
<pre class="code prettyprint"><code class="language-js">export default function <%= camelizedModuleName %>() {
|
|
253
|
-
return true;
|
|
254
|
-
}
|
|
255
|
-
</code></pre>
|
|
256
|
-
<p><code><%= camelizedModuleName %></code> is replaced with the real
|
|
257
|
-
value at install time.</p>
|
|
258
|
-
<p>The following template variables are provided by default:</p>
|
|
259
|
-
<ul>
|
|
260
|
-
<li><code>dasherizedPackageName</code></li>
|
|
261
|
-
<li><code>classifiedPackageName</code></li>
|
|
262
|
-
<li><code>dasherizedModuleName</code></li>
|
|
263
|
-
<li><code>classifiedModuleName</code></li>
|
|
264
|
-
<li><code>camelizedModuleName</code></li>
|
|
265
|
-
</ul>
|
|
266
|
-
<p><code>packageName</code> is the project name as found in the project's
|
|
267
|
-
<code>package.json</code>.</p>
|
|
268
|
-
<p><code>moduleName</code> is the name of the entity being generated.</p>
|
|
269
|
-
<p>The mechanism for providing custom template variables is
|
|
270
|
-
described below.</p>
|
|
271
|
-
<h2>Index.js</h2>
|
|
272
|
-
<p>Custom installation and uninstallation behavior can be added
|
|
273
|
-
by overriding the hooks documented below. <code>index.js</code> should
|
|
274
|
-
export a plain object, which will extend the prototype of the
|
|
275
|
-
<code>Blueprint</code> class. If needed, the original <code>Blueprint</code> prototype
|
|
276
|
-
can be accessed through the <code>_super</code> property.</p>
|
|
277
|
-
<pre class="code prettyprint"><code class="language-js">module.exports = {
|
|
278
|
-
locals(options) {
|
|
279
|
-
// Return custom template variables here.
|
|
280
|
-
return {};
|
|
281
|
-
},
|
|
282
|
-
|
|
283
|
-
normalizeEntityName(entityName) {
|
|
284
|
-
// Normalize and validate entity name here.
|
|
285
|
-
return entityName;
|
|
286
|
-
},
|
|
287
|
-
|
|
288
|
-
fileMapTokens(options) {
|
|
289
|
-
// Return custom tokens to be replaced in your files
|
|
290
|
-
return {
|
|
291
|
-
__token__(options){
|
|
292
|
-
// logic to determine value goes here
|
|
293
|
-
return 'value';
|
|
294
|
-
}
|
|
295
|
-
}
|
|
296
|
-
},
|
|
297
|
-
|
|
298
|
-
filesPath(options) {
|
|
299
|
-
return path.join(this.path, 'files');
|
|
300
|
-
},
|
|
301
|
-
|
|
302
|
-
beforeInstall(options) {},
|
|
303
|
-
afterInstall(options) {},
|
|
304
|
-
beforeUninstall(options) {},
|
|
305
|
-
afterUninstall(options) {}
|
|
306
|
-
|
|
307
|
-
};
|
|
308
|
-
</code></pre>
|
|
309
|
-
<h2>Blueprint Hooks</h2>
|
|
310
|
-
<h3>beforeInstall & beforeUninstall</h3>
|
|
311
|
-
<p>Called before any of the template files are processed and receives
|
|
312
|
-
the <code>options</code> and <code>locals</code> hashes as parameters. Typically used for
|
|
313
|
-
validating any additional command line options or for any asynchronous
|
|
314
|
-
setup that is needed. As an example, the <code>controller</code> blueprint validates
|
|
315
|
-
its <code>--type</code> option in this hook. If you need to run any asynchronous code,
|
|
316
|
-
wrap it in a promise and return that promise from these hooks. This will
|
|
317
|
-
ensure that your code is executed correctly.</p>
|
|
318
|
-
<h3>afterInstall & afterUninstall</h3>
|
|
319
|
-
<p>The <code>afterInstall</code> and <code>afterUninstall</code> hooks receives the same
|
|
320
|
-
arguments as <code>locals</code>. Use it to perform any custom work after the
|
|
321
|
-
files are processed. For example, the built-in <code>route</code> blueprint
|
|
322
|
-
uses these hooks to add and remove relevant route declarations in
|
|
323
|
-
<code>app/router.js</code>.</p>
|
|
324
|
-
<h3>Overriding Install</h3>
|
|
325
|
-
<p>If you don't want your blueprint to install the contents of
|
|
326
|
-
<code>files</code> you can override the <code>install</code> method. It receives the
|
|
327
|
-
same <code>options</code> object described above and must return a promise.
|
|
328
|
-
See the built-in <code>resource</code> blueprint for an example of this.</p>
|
|
329
|
-
</div>
|
|
330
|
-
|
|
331
|
-
<h2 id="static-method-summary">Static Method Summary</h2>
|
|
332
|
-
|
|
333
|
-
<table class="summary">
|
|
334
|
-
<thead>
|
|
335
|
-
<tr>
|
|
336
|
-
<th colspan="2">Static Public Methods</th>
|
|
337
|
-
</tr>
|
|
338
|
-
</thead>
|
|
339
|
-
<tbody>
|
|
340
|
-
<tr>
|
|
341
|
-
<td>
|
|
342
|
-
public
|
|
343
|
-
static
|
|
344
|
-
|
|
345
|
-
</td>
|
|
346
|
-
<td>
|
|
347
|
-
<div class="method-name ">
|
|
348
|
-
<a href="#method_list">list</a>([options]): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
349
|
-
</div>
|
|
350
|
-
<div class="short-description">
|
|
351
|
-
|
|
352
|
-
</div>
|
|
353
|
-
</td>
|
|
354
|
-
</tr>
|
|
355
|
-
<tr>
|
|
356
|
-
<td>
|
|
357
|
-
public
|
|
358
|
-
static
|
|
359
|
-
|
|
360
|
-
</td>
|
|
361
|
-
<td>
|
|
362
|
-
<div class="method-name ">
|
|
363
|
-
<a href="#method_load">load</a>(blueprintPath): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
364
|
-
</div>
|
|
365
|
-
<div class="short-description">
|
|
366
|
-
<p>Loads a blueprint from given path.</p>
|
|
367
|
-
</div>
|
|
368
|
-
</td>
|
|
369
|
-
</tr>
|
|
370
|
-
<tr>
|
|
371
|
-
<td>
|
|
372
|
-
public
|
|
373
|
-
static
|
|
374
|
-
|
|
375
|
-
</td>
|
|
376
|
-
<td>
|
|
377
|
-
<div class="method-name ">
|
|
378
|
-
<a href="#method_lookup">lookup</a>(name, [options]): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
379
|
-
</div>
|
|
380
|
-
<div class="short-description">
|
|
381
|
-
|
|
382
|
-
</div>
|
|
383
|
-
</td>
|
|
384
|
-
</tr>
|
|
385
|
-
</tbody>
|
|
386
|
-
</table>
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
<h2 id="static-property-summary">Static Property Summary</h2>
|
|
391
|
-
|
|
392
|
-
<table class="summary">
|
|
393
|
-
<thead>
|
|
394
|
-
<tr>
|
|
395
|
-
<th colspan="2">Static Public Properties</th>
|
|
396
|
-
</tr>
|
|
397
|
-
</thead>
|
|
398
|
-
<tbody>
|
|
399
|
-
<tr>
|
|
400
|
-
<td>
|
|
401
|
-
public
|
|
402
|
-
static
|
|
403
|
-
|
|
404
|
-
</td>
|
|
405
|
-
<td>
|
|
406
|
-
<div class="property-name ">
|
|
407
|
-
<a href="#props_defaultLookupPaths">defaultLookupPaths</a>: Unknown
|
|
408
|
-
</div>
|
|
409
|
-
<div class="short-description">
|
|
410
|
-
|
|
411
|
-
</div>
|
|
412
|
-
</td>
|
|
413
|
-
</tr>
|
|
414
|
-
<tr>
|
|
415
|
-
<td>
|
|
416
|
-
public
|
|
417
|
-
static
|
|
418
|
-
|
|
419
|
-
</td>
|
|
420
|
-
<td>
|
|
421
|
-
<div class="property-name ">
|
|
422
|
-
<a href="#props_ignoredFiles">ignoredFiles</a>: Unknown
|
|
423
|
-
</div>
|
|
424
|
-
<div class="short-description">
|
|
425
|
-
|
|
426
|
-
</div>
|
|
427
|
-
</td>
|
|
428
|
-
</tr>
|
|
429
|
-
<tr>
|
|
430
|
-
<td>
|
|
431
|
-
public
|
|
432
|
-
static
|
|
433
|
-
|
|
434
|
-
</td>
|
|
435
|
-
<td>
|
|
436
|
-
<div class="property-name ">
|
|
437
|
-
<a href="#props_ignoredUpdateFiles">ignoredUpdateFiles</a>: Unknown
|
|
438
|
-
</div>
|
|
439
|
-
<div class="short-description">
|
|
440
|
-
|
|
441
|
-
</div>
|
|
442
|
-
</td>
|
|
443
|
-
</tr>
|
|
444
|
-
<tr>
|
|
445
|
-
<td>
|
|
446
|
-
public
|
|
447
|
-
static
|
|
448
|
-
|
|
449
|
-
</td>
|
|
450
|
-
<td>
|
|
451
|
-
<div class="property-name ">
|
|
452
|
-
<a href="#props_renamedFiles">renamedFiles</a>: Unknown
|
|
453
|
-
</div>
|
|
454
|
-
<div class="short-description">
|
|
455
|
-
<p>Files that are renamed when installed into the target directory. This allows including files in the blueprint that would have an effect on another process, such as a file named <code>.gitignore</code>.</p>
|
|
456
|
-
</div>
|
|
457
|
-
</td>
|
|
458
|
-
</tr>
|
|
459
|
-
</tbody>
|
|
460
|
-
</table>
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
<h2 id="constructor-summary">Constructor Summary</h2>
|
|
466
|
-
|
|
467
|
-
<table class="summary">
|
|
468
|
-
<thead>
|
|
469
|
-
<tr>
|
|
470
|
-
<th colspan="2">Public Constructors</th>
|
|
471
|
-
</tr>
|
|
472
|
-
</thead>
|
|
473
|
-
<tbody>
|
|
474
|
-
<tr>
|
|
475
|
-
<td>
|
|
476
|
-
public
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
</td>
|
|
480
|
-
<td>
|
|
481
|
-
<div class="method-name ">
|
|
482
|
-
<a href="#method_Blueprint">Blueprint</a>([blueprintPath])
|
|
483
|
-
</div>
|
|
484
|
-
<div class="short-description">
|
|
485
|
-
<p>A blueprint is a bundle of template files with optional install logic.</p>
|
|
486
|
-
</div>
|
|
487
|
-
</td>
|
|
488
|
-
</tr>
|
|
489
|
-
</tbody>
|
|
490
|
-
</table>
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
<h2 id="property-summary">Property Summary</h2>
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
<table class="summary">
|
|
501
|
-
<thead>
|
|
502
|
-
<tr>
|
|
503
|
-
<th colspan="2">Private Properties</th>
|
|
504
|
-
</tr>
|
|
505
|
-
</thead>
|
|
506
|
-
<tbody>
|
|
507
|
-
<tr>
|
|
508
|
-
<td>
|
|
509
|
-
private
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
</td>
|
|
513
|
-
<td>
|
|
514
|
-
<div class="property-name ">
|
|
515
|
-
<a href="#props__actions">_actions</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
516
|
-
</div>
|
|
517
|
-
<div class="short-description">
|
|
518
|
-
<p>Actions lookup</p>
|
|
519
|
-
</div>
|
|
520
|
-
</td>
|
|
521
|
-
</tr>
|
|
522
|
-
</tbody>
|
|
523
|
-
</table>
|
|
524
|
-
|
|
525
|
-
<h2 id="method-summary">Method Summary</h2>
|
|
526
|
-
|
|
527
|
-
<table class="summary">
|
|
528
|
-
<thead>
|
|
529
|
-
<tr>
|
|
530
|
-
<th colspan="2">Public Methods</th>
|
|
531
|
-
</tr>
|
|
532
|
-
</thead>
|
|
533
|
-
<tbody>
|
|
534
|
-
<tr>
|
|
535
|
-
<td>
|
|
536
|
-
public
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
</td>
|
|
540
|
-
<td>
|
|
541
|
-
<div class="method-name ">
|
|
542
|
-
<a href="#method_addAddonsToProject">addAddonsToProject</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
543
|
-
</div>
|
|
544
|
-
<div class="short-description">
|
|
545
|
-
<p>Used to add multiple addons to the project's <code>package.json</code> and run their <code>defaultBlueprint</code> if they provide one.</p>
|
|
546
|
-
</div>
|
|
547
|
-
</td>
|
|
548
|
-
</tr>
|
|
549
|
-
<tr>
|
|
550
|
-
<td>
|
|
551
|
-
public
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
</td>
|
|
555
|
-
<td>
|
|
556
|
-
<div class="method-name ">
|
|
557
|
-
<a href="#method_addAddonToProject">addAddonToProject</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
558
|
-
</div>
|
|
559
|
-
<div class="short-description">
|
|
560
|
-
<p>Used to add an addon to the project's <code>package.json</code> and run it's <code>defaultBlueprint</code> if it provides one.</p>
|
|
561
|
-
</div>
|
|
562
|
-
</td>
|
|
563
|
-
</tr>
|
|
564
|
-
<tr>
|
|
565
|
-
<td>
|
|
566
|
-
public
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
</td>
|
|
570
|
-
<td>
|
|
571
|
-
<div class="method-name ">
|
|
572
|
-
<a href="#method_addBowerPackagesToProject">addBowerPackagesToProject</a>(packages, installOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
573
|
-
</div>
|
|
574
|
-
<div class="short-description">
|
|
575
|
-
<p>Used to add an array of packages to the projects <code>bower.json</code>.</p>
|
|
576
|
-
</div>
|
|
577
|
-
</td>
|
|
578
|
-
</tr>
|
|
579
|
-
<tr>
|
|
580
|
-
<td>
|
|
581
|
-
public
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
</td>
|
|
585
|
-
<td>
|
|
586
|
-
<div class="method-name ">
|
|
587
|
-
<a href="#method_addBowerPackageToProject">addBowerPackageToProject</a>(localPackageName, target, installOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
588
|
-
</div>
|
|
589
|
-
<div class="short-description">
|
|
590
|
-
<p>Used to add a package to the projects <code>bower.json</code>.</p>
|
|
591
|
-
</div>
|
|
592
|
-
</td>
|
|
593
|
-
</tr>
|
|
594
|
-
<tr>
|
|
595
|
-
<td>
|
|
596
|
-
public
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
</td>
|
|
600
|
-
<td>
|
|
601
|
-
<div class="method-name ">
|
|
602
|
-
<a href="#method_addPackagesToProject">addPackagesToProject</a>(packages): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
603
|
-
</div>
|
|
604
|
-
<div class="short-description">
|
|
605
|
-
<p>Used to add multiple packages to the project's <code>package.json</code>.</p>
|
|
606
|
-
</div>
|
|
607
|
-
</td>
|
|
608
|
-
</tr>
|
|
609
|
-
<tr>
|
|
610
|
-
<td>
|
|
611
|
-
public
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
</td>
|
|
615
|
-
<td>
|
|
616
|
-
<div class="method-name ">
|
|
617
|
-
<a href="#method_addPackageToProject">addPackageToProject</a>(packageName, target): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
618
|
-
</div>
|
|
619
|
-
<div class="short-description">
|
|
620
|
-
<p>Used to add a package to the project's <code>package.json</code>.</p>
|
|
621
|
-
</div>
|
|
622
|
-
</td>
|
|
623
|
-
</tr>
|
|
624
|
-
<tr>
|
|
625
|
-
<td>
|
|
626
|
-
public
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
</td>
|
|
630
|
-
<td>
|
|
631
|
-
<div class="method-name ">
|
|
632
|
-
<a href="#method_afterInstall">afterInstall</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
633
|
-
</div>
|
|
634
|
-
<div class="short-description">
|
|
635
|
-
<p>Hook for running operations after install.</p>
|
|
636
|
-
</div>
|
|
637
|
-
</td>
|
|
638
|
-
</tr>
|
|
639
|
-
<tr>
|
|
640
|
-
<td>
|
|
641
|
-
public
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
</td>
|
|
645
|
-
<td>
|
|
646
|
-
<div class="method-name ">
|
|
647
|
-
<a href="#method_afterUninstall">afterUninstall</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
648
|
-
</div>
|
|
649
|
-
<div class="short-description">
|
|
650
|
-
<p>Hook for running operations after uninstall.</p>
|
|
651
|
-
</div>
|
|
652
|
-
</td>
|
|
653
|
-
</tr>
|
|
654
|
-
<tr>
|
|
655
|
-
<td>
|
|
656
|
-
public
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
</td>
|
|
660
|
-
<td>
|
|
661
|
-
<div class="method-name ">
|
|
662
|
-
<a href="#method_beforeInstall">beforeInstall</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
663
|
-
</div>
|
|
664
|
-
<div class="short-description">
|
|
665
|
-
<p>Hook for running operations before install.</p>
|
|
666
|
-
</div>
|
|
667
|
-
</td>
|
|
668
|
-
</tr>
|
|
669
|
-
<tr>
|
|
670
|
-
<td>
|
|
671
|
-
public
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
</td>
|
|
675
|
-
<td>
|
|
676
|
-
<div class="method-name ">
|
|
677
|
-
<a href="#method_beforeUninstall">beforeUninstall</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
678
|
-
</div>
|
|
679
|
-
<div class="short-description">
|
|
680
|
-
<p>Hook for running operations before uninstall.</p>
|
|
681
|
-
</div>
|
|
682
|
-
</td>
|
|
683
|
-
</tr>
|
|
684
|
-
<tr>
|
|
685
|
-
<td>
|
|
686
|
-
public
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
</td>
|
|
690
|
-
<td>
|
|
691
|
-
<div class="method-name ">
|
|
692
|
-
<a href="#method_buildFileInfo">buildFileInfo</a>(destPath, templateVariables, file): FileInfo
|
|
693
|
-
</div>
|
|
694
|
-
<div class="short-description">
|
|
695
|
-
|
|
696
|
-
</div>
|
|
697
|
-
</td>
|
|
698
|
-
</tr>
|
|
699
|
-
<tr>
|
|
700
|
-
<td>
|
|
701
|
-
public
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
</td>
|
|
705
|
-
<td>
|
|
706
|
-
<div class="method-name ">
|
|
707
|
-
<a href="#method_fileMapTokens">fileMapTokens</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | Null
|
|
708
|
-
</div>
|
|
709
|
-
<div class="short-description">
|
|
710
|
-
<p>Hook to add additional or override existing fileMap tokens.</p>
|
|
711
|
-
</div>
|
|
712
|
-
</td>
|
|
713
|
-
</tr>
|
|
714
|
-
<tr>
|
|
715
|
-
<td>
|
|
716
|
-
public
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
</td>
|
|
720
|
-
<td>
|
|
721
|
-
<div class="method-name ">
|
|
722
|
-
<a href="#method_files">files</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
723
|
-
</div>
|
|
724
|
-
<div class="short-description">
|
|
725
|
-
<p>Used to retrieve files for blueprint.</p>
|
|
726
|
-
</div>
|
|
727
|
-
</td>
|
|
728
|
-
</tr>
|
|
729
|
-
<tr>
|
|
730
|
-
<td>
|
|
731
|
-
public
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
</td>
|
|
735
|
-
<td>
|
|
736
|
-
<div class="method-name ">
|
|
737
|
-
<a href="#method_filesPath">filesPath</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
738
|
-
</div>
|
|
739
|
-
<div class="short-description">
|
|
740
|
-
<p>Hook to specify the path to the blueprint's files. By default this is <code>path.join(this.path, 'files)</code>.</p>
|
|
741
|
-
</div>
|
|
742
|
-
</td>
|
|
743
|
-
</tr>
|
|
744
|
-
<tr>
|
|
745
|
-
<td>
|
|
746
|
-
public
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
</td>
|
|
750
|
-
<td>
|
|
751
|
-
<div class="method-name ">
|
|
752
|
-
<a href="#method_generateFileMap">generateFileMap</a>(fileMapVariables): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
753
|
-
</div>
|
|
754
|
-
<div class="short-description">
|
|
755
|
-
<p>Used to generate fileMap tokens for mapFile.</p>
|
|
756
|
-
</div>
|
|
757
|
-
</td>
|
|
758
|
-
</tr>
|
|
759
|
-
<tr>
|
|
760
|
-
<td>
|
|
761
|
-
public
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
</td>
|
|
765
|
-
<td>
|
|
766
|
-
<div class="method-name ">
|
|
767
|
-
<a href="#method_insertIntoFile">insertIntoFile</a>(pathRelativeToProjectRoot, contentsToInsert, providedOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
768
|
-
</div>
|
|
769
|
-
<div class="short-description">
|
|
770
|
-
<p>Inserts the given content into a file. If the <code>contentsToInsert</code> string is already present in the current contents, the file will not be changed unless <code>force</code> option is passed.</p>
|
|
771
|
-
</div>
|
|
772
|
-
</td>
|
|
773
|
-
</tr>
|
|
774
|
-
<tr>
|
|
775
|
-
<td>
|
|
776
|
-
public
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
</td>
|
|
780
|
-
<td>
|
|
781
|
-
<div class="method-name ">
|
|
782
|
-
<a href="#method_install">install</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
783
|
-
</div>
|
|
784
|
-
<div class="short-description">
|
|
785
|
-
|
|
786
|
-
</div>
|
|
787
|
-
</td>
|
|
788
|
-
</tr>
|
|
789
|
-
<tr>
|
|
790
|
-
<td>
|
|
791
|
-
public
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
</td>
|
|
795
|
-
<td>
|
|
796
|
-
<div class="method-name ">
|
|
797
|
-
<a href="#method_isUpdate">isUpdate</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
798
|
-
</div>
|
|
799
|
-
<div class="short-description">
|
|
800
|
-
|
|
801
|
-
</div>
|
|
802
|
-
</td>
|
|
803
|
-
</tr>
|
|
804
|
-
<tr>
|
|
805
|
-
<td>
|
|
806
|
-
public
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
</td>
|
|
810
|
-
<td>
|
|
811
|
-
<div class="method-name ">
|
|
812
|
-
<a href="#method_locals">locals</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
813
|
-
</div>
|
|
814
|
-
<div class="short-description">
|
|
815
|
-
<p>Hook for adding custom template variables.</p>
|
|
816
|
-
</div>
|
|
817
|
-
</td>
|
|
818
|
-
</tr>
|
|
819
|
-
<tr>
|
|
820
|
-
<td>
|
|
821
|
-
public
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
</td>
|
|
825
|
-
<td>
|
|
826
|
-
<div class="method-name ">
|
|
827
|
-
<a href="#method_lookupBlueprint">lookupBlueprint</a>(dasherizedName): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
828
|
-
</div>
|
|
829
|
-
<div class="short-description">
|
|
830
|
-
<p>Used to retrieve a blueprint with the given name.</p>
|
|
831
|
-
</div>
|
|
832
|
-
</td>
|
|
833
|
-
</tr>
|
|
834
|
-
<tr>
|
|
835
|
-
<td>
|
|
836
|
-
public
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
</td>
|
|
840
|
-
<td>
|
|
841
|
-
<div class="method-name ">
|
|
842
|
-
<a href="#method_mapFile">mapFile</a>(file, locals): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
843
|
-
</div>
|
|
844
|
-
<div class="short-description">
|
|
845
|
-
|
|
846
|
-
</div>
|
|
847
|
-
</td>
|
|
848
|
-
</tr>
|
|
849
|
-
<tr>
|
|
850
|
-
<td>
|
|
851
|
-
public
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
</td>
|
|
855
|
-
<td>
|
|
856
|
-
<div class="method-name ">
|
|
857
|
-
<a href="#method_normalizeEntityName">normalizeEntityName</a>(entityName): Null
|
|
858
|
-
</div>
|
|
859
|
-
<div class="short-description">
|
|
860
|
-
<p>Hook for normalizing entity name</p>
|
|
861
|
-
</div>
|
|
862
|
-
</td>
|
|
863
|
-
</tr>
|
|
864
|
-
<tr>
|
|
865
|
-
<td>
|
|
866
|
-
public
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
</td>
|
|
870
|
-
<td>
|
|
871
|
-
<div class="method-name ">
|
|
872
|
-
<a href="#method_processFiles">processFiles</a>(intoDir, templateVariables): Promise<FileInfo>
|
|
873
|
-
</div>
|
|
874
|
-
<div class="short-description">
|
|
875
|
-
|
|
876
|
-
</div>
|
|
877
|
-
</td>
|
|
878
|
-
</tr>
|
|
879
|
-
<tr>
|
|
880
|
-
<td>
|
|
881
|
-
public
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
</td>
|
|
885
|
-
<td>
|
|
886
|
-
<div class="method-name ">
|
|
887
|
-
<a href="#method_processFilesForUninstall">processFilesForUninstall</a>(intoDir, templateVariables)
|
|
888
|
-
</div>
|
|
889
|
-
<div class="short-description">
|
|
890
|
-
|
|
891
|
-
</div>
|
|
892
|
-
</td>
|
|
893
|
-
</tr>
|
|
894
|
-
<tr>
|
|
895
|
-
<td>
|
|
896
|
-
public
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
</td>
|
|
900
|
-
<td>
|
|
901
|
-
<div class="method-name ">
|
|
902
|
-
<a href="#method_removePackageFromProject">removePackageFromProject</a>(packageName): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
903
|
-
</div>
|
|
904
|
-
<div class="short-description">
|
|
905
|
-
<p>Used to remove a package from the project's <code>package.json</code>.</p>
|
|
906
|
-
</div>
|
|
907
|
-
</td>
|
|
908
|
-
</tr>
|
|
909
|
-
<tr>
|
|
910
|
-
<td>
|
|
911
|
-
public
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
</td>
|
|
915
|
-
<td>
|
|
916
|
-
<div class="method-name ">
|
|
917
|
-
<a href="#method_removePackagesFromProject">removePackagesFromProject</a>(packages): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
918
|
-
</div>
|
|
919
|
-
<div class="short-description">
|
|
920
|
-
<p>Used to remove multiple packages from the project's <code>package.json</code>.</p>
|
|
921
|
-
</div>
|
|
922
|
-
</td>
|
|
923
|
-
</tr>
|
|
924
|
-
<tr>
|
|
925
|
-
<td>
|
|
926
|
-
public
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
</td>
|
|
930
|
-
<td>
|
|
931
|
-
<div class="method-name ">
|
|
932
|
-
<a href="#method_srcPath">srcPath</a>(file): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
933
|
-
</div>
|
|
934
|
-
<div class="short-description">
|
|
935
|
-
|
|
936
|
-
</div>
|
|
937
|
-
</td>
|
|
938
|
-
</tr>
|
|
939
|
-
<tr>
|
|
940
|
-
<td>
|
|
941
|
-
public
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
</td>
|
|
945
|
-
<td>
|
|
946
|
-
<div class="method-name ">
|
|
947
|
-
<a href="#method_taskFor">taskFor</a>(dasherizedName)
|
|
948
|
-
</div>
|
|
949
|
-
<div class="short-description">
|
|
950
|
-
<p>Used to retrieve a task with the given name. Passes the new task the standard information available (like <code>ui</code>, <code>analytics</code>, <code>project</code>, etc).</p>
|
|
951
|
-
</div>
|
|
952
|
-
</td>
|
|
953
|
-
</tr>
|
|
954
|
-
<tr>
|
|
955
|
-
<td>
|
|
956
|
-
public
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
</td>
|
|
960
|
-
<td>
|
|
961
|
-
<div class="method-name ">
|
|
962
|
-
<a href="#method_uninstall">uninstall</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
963
|
-
</div>
|
|
964
|
-
<div class="short-description">
|
|
965
|
-
|
|
966
|
-
</div>
|
|
967
|
-
</td>
|
|
968
|
-
</tr>
|
|
969
|
-
</tbody>
|
|
970
|
-
</table>
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
<table class="summary">
|
|
974
|
-
<thead>
|
|
975
|
-
<tr>
|
|
976
|
-
<th colspan="2">Private Methods</th>
|
|
977
|
-
</tr>
|
|
978
|
-
</thead>
|
|
979
|
-
<tbody>
|
|
980
|
-
<tr>
|
|
981
|
-
<td>
|
|
982
|
-
private
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
</td>
|
|
986
|
-
<td>
|
|
987
|
-
<div class="method-name ">
|
|
988
|
-
<a href="#method__checkForNoMatch">_checkForNoMatch</a>(fileInfos, rawArgs)
|
|
989
|
-
</div>
|
|
990
|
-
<div class="short-description">
|
|
991
|
-
|
|
992
|
-
</div>
|
|
993
|
-
</td>
|
|
994
|
-
</tr>
|
|
995
|
-
<tr>
|
|
996
|
-
<td>
|
|
997
|
-
private
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
</td>
|
|
1001
|
-
<td>
|
|
1002
|
-
<div class="method-name ">
|
|
1003
|
-
<a href="#method__checkForPod">_checkForPod</a>( )
|
|
1004
|
-
</div>
|
|
1005
|
-
<div class="short-description">
|
|
1006
|
-
<p>Prints warning for pod unsupported.</p>
|
|
1007
|
-
</div>
|
|
1008
|
-
</td>
|
|
1009
|
-
</tr>
|
|
1010
|
-
<tr>
|
|
1011
|
-
<td>
|
|
1012
|
-
private
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
</td>
|
|
1016
|
-
<td>
|
|
1017
|
-
<div class="method-name ">
|
|
1018
|
-
<a href="#method__checkInRepoAddonExists">_checkInRepoAddonExists</a>(options)
|
|
1019
|
-
</div>
|
|
1020
|
-
<div class="short-description">
|
|
1021
|
-
|
|
1022
|
-
</div>
|
|
1023
|
-
</td>
|
|
1024
|
-
</tr>
|
|
1025
|
-
<tr>
|
|
1026
|
-
<td>
|
|
1027
|
-
private
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
</td>
|
|
1031
|
-
<td>
|
|
1032
|
-
<div class="method-name ">
|
|
1033
|
-
<a href="#method__commit">_commit</a>(result): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1034
|
-
</div>
|
|
1035
|
-
<div class="short-description">
|
|
1036
|
-
<p>Calls an action.</p>
|
|
1037
|
-
</div>
|
|
1038
|
-
</td>
|
|
1039
|
-
</tr>
|
|
1040
|
-
<tr>
|
|
1041
|
-
<td>
|
|
1042
|
-
private
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
</td>
|
|
1046
|
-
<td>
|
|
1047
|
-
<div class="method-name ">
|
|
1048
|
-
<a href="#method__fileMapTokens">_fileMapTokens</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
1049
|
-
</div>
|
|
1050
|
-
<div class="short-description">
|
|
1051
|
-
|
|
1052
|
-
</div>
|
|
1053
|
-
</td>
|
|
1054
|
-
</tr>
|
|
1055
|
-
<tr>
|
|
1056
|
-
<td>
|
|
1057
|
-
private
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
</td>
|
|
1061
|
-
<td>
|
|
1062
|
-
<div class="method-name ">
|
|
1063
|
-
<a href="#method__generateFileMapVariables">_generateFileMapVariables</a>(moduleName, locals, options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
1064
|
-
</div>
|
|
1065
|
-
<div class="short-description">
|
|
1066
|
-
|
|
1067
|
-
</div>
|
|
1068
|
-
</td>
|
|
1069
|
-
</tr>
|
|
1070
|
-
<tr>
|
|
1071
|
-
<td>
|
|
1072
|
-
private
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
</td>
|
|
1076
|
-
<td>
|
|
1077
|
-
<div class="method-name ">
|
|
1078
|
-
<a href="#method__getFileInfos">_getFileInfos</a>(files, intoDir, templateVariables): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1079
|
-
</div>
|
|
1080
|
-
<div class="short-description">
|
|
1081
|
-
|
|
1082
|
-
</div>
|
|
1083
|
-
</td>
|
|
1084
|
-
</tr>
|
|
1085
|
-
<tr>
|
|
1086
|
-
<td>
|
|
1087
|
-
private
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
</td>
|
|
1091
|
-
<td>
|
|
1092
|
-
<div class="method-name ">
|
|
1093
|
-
<a href="#method__getFilesForInstall">_getFilesForInstall</a>(targetFiles): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1094
|
-
</div>
|
|
1095
|
-
<div class="short-description">
|
|
1096
|
-
|
|
1097
|
-
</div>
|
|
1098
|
-
</td>
|
|
1099
|
-
</tr>
|
|
1100
|
-
<tr>
|
|
1101
|
-
<td>
|
|
1102
|
-
private
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
</td>
|
|
1106
|
-
<td>
|
|
1107
|
-
<div class="method-name ">
|
|
1108
|
-
<a href="#method__ignoreUpdateFiles">_ignoreUpdateFiles</a>( )
|
|
1109
|
-
</div>
|
|
1110
|
-
<div class="short-description">
|
|
1111
|
-
<p>Add update files to ignored files or reset them</p>
|
|
1112
|
-
</div>
|
|
1113
|
-
</td>
|
|
1114
|
-
</tr>
|
|
1115
|
-
<tr>
|
|
1116
|
-
<td>
|
|
1117
|
-
private
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
</td>
|
|
1121
|
-
<td>
|
|
1122
|
-
<div class="method-name ">
|
|
1123
|
-
<a href="#method__locals">_locals</a>(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
1124
|
-
</div>
|
|
1125
|
-
<div class="short-description">
|
|
1126
|
-
|
|
1127
|
-
</div>
|
|
1128
|
-
</td>
|
|
1129
|
-
</tr>
|
|
1130
|
-
<tr>
|
|
1131
|
-
<td>
|
|
1132
|
-
private
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
</td>
|
|
1136
|
-
<td>
|
|
1137
|
-
<div class="method-name ">
|
|
1138
|
-
<a href="#method__normalizeEntityName">_normalizeEntityName</a>(entity)
|
|
1139
|
-
</div>
|
|
1140
|
-
<div class="short-description">
|
|
1141
|
-
|
|
1142
|
-
</div>
|
|
1143
|
-
</td>
|
|
1144
|
-
</tr>
|
|
1145
|
-
<tr>
|
|
1146
|
-
<td>
|
|
1147
|
-
private
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
</td>
|
|
1151
|
-
<td>
|
|
1152
|
-
<div class="method-name ">
|
|
1153
|
-
<a href="#method__process">_process</a>(options, beforeHook, process, afterHook)
|
|
1154
|
-
</div>
|
|
1155
|
-
<div class="short-description">
|
|
1156
|
-
|
|
1157
|
-
</div>
|
|
1158
|
-
</td>
|
|
1159
|
-
</tr>
|
|
1160
|
-
<tr>
|
|
1161
|
-
<td>
|
|
1162
|
-
private
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
</td>
|
|
1166
|
-
<td>
|
|
1167
|
-
<div class="method-name ">
|
|
1168
|
-
<a href="#method__writeFile">_writeFile</a>(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1169
|
-
</div>
|
|
1170
|
-
<div class="short-description">
|
|
1171
|
-
|
|
1172
|
-
</div>
|
|
1173
|
-
</td>
|
|
1174
|
-
</tr>
|
|
1175
|
-
<tr>
|
|
1176
|
-
<td>
|
|
1177
|
-
private
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
</td>
|
|
1181
|
-
<td>
|
|
1182
|
-
<div class="method-name ">
|
|
1183
|
-
<a href="#method__writeStatusToUI">_writeStatusToUI</a>(chalkColor, keyword, message)
|
|
1184
|
-
</div>
|
|
1185
|
-
<div class="short-description">
|
|
1186
|
-
<p>Write a status and message to the UI</p>
|
|
1187
|
-
</div>
|
|
1188
|
-
</td>
|
|
1189
|
-
</tr>
|
|
1190
|
-
<tr>
|
|
1191
|
-
<td>
|
|
1192
|
-
private
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
</td>
|
|
1196
|
-
<td>
|
|
1197
|
-
<div class="method-name ">
|
|
1198
|
-
<a href="#method_dir">dir</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1199
|
-
</div>
|
|
1200
|
-
<div class="short-description">
|
|
1201
|
-
|
|
1202
|
-
</div>
|
|
1203
|
-
</td>
|
|
1204
|
-
</tr>
|
|
1205
|
-
<tr>
|
|
1206
|
-
<td>
|
|
1207
|
-
private
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
</td>
|
|
1211
|
-
<td>
|
|
1212
|
-
<div class="method-name ">
|
|
1213
|
-
<a href="#method_gatherConfirmationMessages">gatherConfirmationMessages</a>(collection, info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1214
|
-
</div>
|
|
1215
|
-
<div class="short-description">
|
|
1216
|
-
|
|
1217
|
-
</div>
|
|
1218
|
-
</td>
|
|
1219
|
-
</tr>
|
|
1220
|
-
<tr>
|
|
1221
|
-
<td>
|
|
1222
|
-
private
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
</td>
|
|
1226
|
-
<td>
|
|
1227
|
-
<div class="method-name ">
|
|
1228
|
-
<a href="#method_generateLookupPaths">generateLookupPaths</a>(lookupPaths): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1229
|
-
</div>
|
|
1230
|
-
<div class="short-description">
|
|
1231
|
-
<p>Combines provided lookup paths with defaults and removes duplicates.</p>
|
|
1232
|
-
</div>
|
|
1233
|
-
</td>
|
|
1234
|
-
</tr>
|
|
1235
|
-
<tr>
|
|
1236
|
-
<td>
|
|
1237
|
-
private
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
</td>
|
|
1241
|
-
<td>
|
|
1242
|
-
<div class="method-name ">
|
|
1243
|
-
<a href="#method_getDetailedHelpPath">getDetailedHelpPath</a>(thisPath): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
1244
|
-
</div>
|
|
1245
|
-
<div class="short-description">
|
|
1246
|
-
|
|
1247
|
-
</div>
|
|
1248
|
-
</td>
|
|
1249
|
-
</tr>
|
|
1250
|
-
<tr>
|
|
1251
|
-
<td>
|
|
1252
|
-
private
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
</td>
|
|
1256
|
-
<td>
|
|
1257
|
-
<div class="method-name ">
|
|
1258
|
-
<a href="#method_hasPathToken">hasPathToken</a>(files): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
1259
|
-
</div>
|
|
1260
|
-
<div class="short-description">
|
|
1261
|
-
<p>Looks for a <strong>path</strong> token in the files folder. Must be present for the blueprint to support pod tokens.</p>
|
|
1262
|
-
</div>
|
|
1263
|
-
</td>
|
|
1264
|
-
</tr>
|
|
1265
|
-
<tr>
|
|
1266
|
-
<td>
|
|
1267
|
-
private
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
</td>
|
|
1271
|
-
<td>
|
|
1272
|
-
<div class="method-name ">
|
|
1273
|
-
<a href="#method_isFilePath">isFilePath</a>(fileInfo): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1274
|
-
</div>
|
|
1275
|
-
<div class="short-description">
|
|
1276
|
-
|
|
1277
|
-
</div>
|
|
1278
|
-
</td>
|
|
1279
|
-
</tr>
|
|
1280
|
-
<tr>
|
|
1281
|
-
<td>
|
|
1282
|
-
private
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
</td>
|
|
1286
|
-
<td>
|
|
1287
|
-
<div class="method-name ">
|
|
1288
|
-
<a href="#method_isIgnored">isIgnored</a>(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
1289
|
-
</div>
|
|
1290
|
-
<div class="short-description">
|
|
1291
|
-
|
|
1292
|
-
</div>
|
|
1293
|
-
</td>
|
|
1294
|
-
</tr>
|
|
1295
|
-
<tr>
|
|
1296
|
-
<td>
|
|
1297
|
-
private
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
</td>
|
|
1301
|
-
<td>
|
|
1302
|
-
<div class="method-name ">
|
|
1303
|
-
<a href="#method_isValidFile">isValidFile</a>(fileInfo): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1304
|
-
</div>
|
|
1305
|
-
<div class="short-description">
|
|
1306
|
-
|
|
1307
|
-
</div>
|
|
1308
|
-
</td>
|
|
1309
|
-
</tr>
|
|
1310
|
-
<tr>
|
|
1311
|
-
<td>
|
|
1312
|
-
private
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
</td>
|
|
1316
|
-
<td>
|
|
1317
|
-
<div class="method-name ">
|
|
1318
|
-
<a href="#method_markIdenticalToBeSkipped">markIdenticalToBeSkipped</a>(info)
|
|
1319
|
-
</div>
|
|
1320
|
-
<div class="short-description">
|
|
1321
|
-
|
|
1322
|
-
</div>
|
|
1323
|
-
</td>
|
|
1324
|
-
</tr>
|
|
1325
|
-
<tr>
|
|
1326
|
-
<td>
|
|
1327
|
-
private
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
</td>
|
|
1331
|
-
<td>
|
|
1332
|
-
<div class="method-name ">
|
|
1333
|
-
<a href="#method_markToBeRemoved">markToBeRemoved</a>(info)
|
|
1334
|
-
</div>
|
|
1335
|
-
<div class="short-description">
|
|
1336
|
-
|
|
1337
|
-
</div>
|
|
1338
|
-
</td>
|
|
1339
|
-
</tr>
|
|
1340
|
-
<tr>
|
|
1341
|
-
<td>
|
|
1342
|
-
private
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
</td>
|
|
1346
|
-
<td>
|
|
1347
|
-
<div class="method-name ">
|
|
1348
|
-
<a href="#method_prepareConfirm">prepareConfirm</a>(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1349
|
-
</div>
|
|
1350
|
-
<div class="short-description">
|
|
1351
|
-
|
|
1352
|
-
</div>
|
|
1353
|
-
</td>
|
|
1354
|
-
</tr>
|
|
1355
|
-
<tr>
|
|
1356
|
-
<td>
|
|
1357
|
-
private
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
</td>
|
|
1361
|
-
<td>
|
|
1362
|
-
<div class="method-name ">
|
|
1363
|
-
<a href="#method_supportsAddon">supportsAddon</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
1364
|
-
</div>
|
|
1365
|
-
<div class="short-description">
|
|
1366
|
-
<p>Looks for a <strong>root</strong> token in the files folder. Must be present for the blueprint to support addon tokens. The <code>server</code>, <code>blueprints</code>, and <code>test</code></p>
|
|
1367
|
-
</div>
|
|
1368
|
-
</td>
|
|
1369
|
-
</tr>
|
|
1370
|
-
</tbody>
|
|
1371
|
-
</table>
|
|
1372
|
-
|
|
1373
|
-
<div id="properties public">
|
|
1374
|
-
<h2 id="static-public-properties">Static Public Properties</h2>
|
|
1375
|
-
<div class="property item">
|
|
1376
|
-
<div id="props_defaultLookupPaths" class="title">
|
|
1377
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1401"><code>lib/models/blueprint.js:1401</code></a></span>
|
|
1378
|
-
<h3 class="">
|
|
1379
|
-
public
|
|
1380
|
-
static
|
|
1381
|
-
|
|
1382
|
-
defaultLookupPaths: Unknown
|
|
1383
|
-
</h3>
|
|
1384
|
-
</div>
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
<div class="property-description"></div>
|
|
1388
|
-
|
|
1389
|
-
</div>
|
|
1390
|
-
<div class="property item">
|
|
1391
|
-
<div id="props_ignoredFiles" class="title">
|
|
1392
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1389"><code>lib/models/blueprint.js:1389</code></a></span>
|
|
1393
|
-
<h3 class="">
|
|
1394
|
-
public
|
|
1395
|
-
static
|
|
1396
|
-
|
|
1397
|
-
ignoredFiles: Unknown
|
|
1398
|
-
</h3>
|
|
1399
|
-
</div>
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
<div class="property-description"></div>
|
|
1403
|
-
|
|
1404
|
-
</div>
|
|
1405
|
-
<div class="property item">
|
|
1406
|
-
<div id="props_ignoredUpdateFiles" class="title">
|
|
1407
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1395"><code>lib/models/blueprint.js:1395</code></a></span>
|
|
1408
|
-
<h3 class="">
|
|
1409
|
-
public
|
|
1410
|
-
static
|
|
1411
|
-
|
|
1412
|
-
ignoredUpdateFiles: Unknown
|
|
1413
|
-
</h3>
|
|
1414
|
-
</div>
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
<div class="property-description"></div>
|
|
1418
|
-
|
|
1419
|
-
</div>
|
|
1420
|
-
<div class="property item">
|
|
1421
|
-
<div id="props_renamedFiles" class="title">
|
|
1422
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1374"><code>lib/models/blueprint.js:1374</code></a></span>
|
|
1423
|
-
<h3 class="">
|
|
1424
|
-
public
|
|
1425
|
-
static
|
|
1426
|
-
|
|
1427
|
-
renamedFiles: Unknown
|
|
1428
|
-
</h3>
|
|
1429
|
-
</div>
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
<div class="property-description"><p>Files that are renamed when installed into the target directory.
|
|
1433
|
-
This allows including files in the blueprint that would have an effect
|
|
1434
|
-
on another process, such as a file named <code>.gitignore</code>.</p>
|
|
1435
|
-
<p>The keys are the filenames used in the files folder.
|
|
1436
|
-
The values are the filenames used in the target directory.</p>
|
|
1437
|
-
</div>
|
|
1438
|
-
|
|
1439
|
-
</div>
|
|
1440
|
-
</div>
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
<div id="methods public">
|
|
1445
|
-
<h2 id="static-public-methods">Static Public Methods</h2>
|
|
1446
|
-
<div class="method item">
|
|
1447
|
-
<div id="method_list" class="title">
|
|
1448
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1325"><code>lib/models/blueprint.js:1325</code></a></span>
|
|
1449
|
-
<h3 class="">
|
|
1450
|
-
public
|
|
1451
|
-
static
|
|
1452
|
-
|
|
1453
|
-
list([options]): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
1454
|
-
</h3>
|
|
1455
|
-
</div>
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
<div class="method-description"></div>
|
|
1460
|
-
|
|
1461
|
-
<div class="params">
|
|
1462
|
-
<h4>Parameters:</h4>
|
|
1463
|
-
<table>
|
|
1464
|
-
<thead>
|
|
1465
|
-
<tr>
|
|
1466
|
-
<th>Name</th>
|
|
1467
|
-
<th>Type</th>
|
|
1468
|
-
<th>Attribute</th>
|
|
1469
|
-
<th>Description</th>
|
|
1470
|
-
</tr>
|
|
1471
|
-
</thead>
|
|
1472
|
-
<tbody>
|
|
1473
|
-
<tr>
|
|
1474
|
-
<td>options</td>
|
|
1475
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1476
|
-
<td>
|
|
1477
|
-
<ul>
|
|
1478
|
-
<li>optional</li>
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
</ul>
|
|
1482
|
-
</td>
|
|
1483
|
-
<td> </td>
|
|
1484
|
-
</tr>
|
|
1485
|
-
|
|
1486
|
-
<tr>
|
|
1487
|
-
<td>options.paths</td>
|
|
1488
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
1489
|
-
<td>
|
|
1490
|
-
<ul>
|
|
1491
|
-
<li>optional</li>
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
</ul>
|
|
1495
|
-
</td>
|
|
1496
|
-
<td><p>Extra paths to search for blueprints</p>
|
|
1497
|
-
</td>
|
|
1498
|
-
</tr>
|
|
1499
|
-
</tbody>
|
|
1500
|
-
</table>
|
|
1501
|
-
</div>
|
|
1502
|
-
|
|
1503
|
-
<div class="return">
|
|
1504
|
-
<h4>Return:</h4>
|
|
1505
|
-
<div>
|
|
1506
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
1507
|
-
<span class="return-description"></span>
|
|
1508
|
-
</div>
|
|
1509
|
-
</div>
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
</div>
|
|
1513
|
-
<div class="method item">
|
|
1514
|
-
<div id="method_load" class="title">
|
|
1515
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1298"><code>lib/models/blueprint.js:1298</code></a></span>
|
|
1516
|
-
<h3 class="">
|
|
1517
|
-
public
|
|
1518
|
-
static
|
|
1519
|
-
|
|
1520
|
-
load(blueprintPath): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
1521
|
-
</h3>
|
|
1522
|
-
</div>
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
<div class="method-description"><p>Loads a blueprint from given path.</p>
|
|
1527
|
-
</div>
|
|
1528
|
-
|
|
1529
|
-
<div class="params">
|
|
1530
|
-
<h4>Parameters:</h4>
|
|
1531
|
-
<table>
|
|
1532
|
-
<thead>
|
|
1533
|
-
<tr>
|
|
1534
|
-
<th>Name</th>
|
|
1535
|
-
<th>Type</th>
|
|
1536
|
-
<th>Attribute</th>
|
|
1537
|
-
<th>Description</th>
|
|
1538
|
-
</tr>
|
|
1539
|
-
</thead>
|
|
1540
|
-
<tbody>
|
|
1541
|
-
<tr>
|
|
1542
|
-
<td>blueprintPath</td>
|
|
1543
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
1544
|
-
<td>
|
|
1545
|
-
<ul>
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
</ul>
|
|
1550
|
-
</td>
|
|
1551
|
-
<td> </td>
|
|
1552
|
-
</tr>
|
|
1553
|
-
|
|
1554
|
-
</tbody>
|
|
1555
|
-
</table>
|
|
1556
|
-
</div>
|
|
1557
|
-
|
|
1558
|
-
<div class="return">
|
|
1559
|
-
<h4>Return:</h4>
|
|
1560
|
-
<div>
|
|
1561
|
-
<span class="return-type"><a href="../classes/Blueprint.html" class="crosslink">Blueprint</a></span>
|
|
1562
|
-
<span class="return-description"><p>blueprint instance</p>
|
|
1563
|
-
</span>
|
|
1564
|
-
</div>
|
|
1565
|
-
</div>
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
</div>
|
|
1569
|
-
<div class="method item">
|
|
1570
|
-
<div id="method_lookup" class="title">
|
|
1571
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1268"><code>lib/models/blueprint.js:1268</code></a></span>
|
|
1572
|
-
<h3 class="">
|
|
1573
|
-
public
|
|
1574
|
-
static
|
|
1575
|
-
|
|
1576
|
-
lookup(name, [options]): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
1577
|
-
</h3>
|
|
1578
|
-
</div>
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
<div class="method-description"></div>
|
|
1583
|
-
|
|
1584
|
-
<div class="params">
|
|
1585
|
-
<h4>Parameters:</h4>
|
|
1586
|
-
<table>
|
|
1587
|
-
<thead>
|
|
1588
|
-
<tr>
|
|
1589
|
-
<th>Name</th>
|
|
1590
|
-
<th>Type</th>
|
|
1591
|
-
<th>Attribute</th>
|
|
1592
|
-
<th>Description</th>
|
|
1593
|
-
</tr>
|
|
1594
|
-
</thead>
|
|
1595
|
-
<tbody>
|
|
1596
|
-
<tr>
|
|
1597
|
-
<td>name</td>
|
|
1598
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
1599
|
-
<td>
|
|
1600
|
-
<ul>
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
</ul>
|
|
1605
|
-
</td>
|
|
1606
|
-
<td> </td>
|
|
1607
|
-
</tr>
|
|
1608
|
-
|
|
1609
|
-
<tr>
|
|
1610
|
-
<td>options</td>
|
|
1611
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1612
|
-
<td>
|
|
1613
|
-
<ul>
|
|
1614
|
-
<li>optional</li>
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
</ul>
|
|
1618
|
-
</td>
|
|
1619
|
-
<td> </td>
|
|
1620
|
-
</tr>
|
|
1621
|
-
|
|
1622
|
-
<tr>
|
|
1623
|
-
<td>options.paths</td>
|
|
1624
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
1625
|
-
<td>
|
|
1626
|
-
<ul>
|
|
1627
|
-
<li>optional</li>
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
</ul>
|
|
1631
|
-
</td>
|
|
1632
|
-
<td><p>Extra paths to search for blueprints</p>
|
|
1633
|
-
</td>
|
|
1634
|
-
</tr>
|
|
1635
|
-
<tr>
|
|
1636
|
-
<td>options.ignoreMissing</td>
|
|
1637
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></td>
|
|
1638
|
-
<td>
|
|
1639
|
-
<ul>
|
|
1640
|
-
<li>optional</li>
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
</ul>
|
|
1644
|
-
</td>
|
|
1645
|
-
<td><p>Throw a <code>SilentError</code> if a
|
|
1646
|
-
matching Blueprint could not be found</p>
|
|
1647
|
-
</td>
|
|
1648
|
-
</tr>
|
|
1649
|
-
</tbody>
|
|
1650
|
-
</table>
|
|
1651
|
-
</div>
|
|
1652
|
-
|
|
1653
|
-
<div class="return">
|
|
1654
|
-
<h4>Return:</h4>
|
|
1655
|
-
<div>
|
|
1656
|
-
<span class="return-type"><a href="../classes/Blueprint.html" class="crosslink">Blueprint</a></span>
|
|
1657
|
-
<span class="return-description"></span>
|
|
1658
|
-
</div>
|
|
1659
|
-
</div>
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
</div>
|
|
1663
|
-
</div>
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
<div id="methods public">
|
|
1668
|
-
<h2 id="public-constructors">Public Constructors</h2>
|
|
1669
|
-
<div class="method item">
|
|
1670
|
-
<div id="method_Blueprint" class="title">
|
|
1671
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l30"><code>lib/models/blueprint.js:30</code></a></span>
|
|
1672
|
-
<h3 class="">
|
|
1673
|
-
public
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
Blueprint([blueprintPath])
|
|
1677
|
-
</h3>
|
|
1678
|
-
</div>
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
<div class="method-description"></div>
|
|
1683
|
-
|
|
1684
|
-
<div class="params">
|
|
1685
|
-
<h4>Parameters:</h4>
|
|
1686
|
-
<table>
|
|
1687
|
-
<thead>
|
|
1688
|
-
<tr>
|
|
1689
|
-
<th>Name</th>
|
|
1690
|
-
<th>Type</th>
|
|
1691
|
-
<th>Attribute</th>
|
|
1692
|
-
<th>Description</th>
|
|
1693
|
-
</tr>
|
|
1694
|
-
</thead>
|
|
1695
|
-
<tbody>
|
|
1696
|
-
<tr>
|
|
1697
|
-
<td>blueprintPath</td>
|
|
1698
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
1699
|
-
<td>
|
|
1700
|
-
<ul>
|
|
1701
|
-
<li>optional</li>
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
</ul>
|
|
1705
|
-
</td>
|
|
1706
|
-
<td> </td>
|
|
1707
|
-
</tr>
|
|
1708
|
-
|
|
1709
|
-
</tbody>
|
|
1710
|
-
</table>
|
|
1711
|
-
</div>
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
</div>
|
|
1716
|
-
</div>
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
<div id="properties private">
|
|
1723
|
-
<h2 id="private-properties">Private Properties</h2>
|
|
1724
|
-
<div class="property item private">
|
|
1725
|
-
<div id="props__actions" class="title">
|
|
1726
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l299"><code>lib/models/blueprint.js:299</code></a></span>
|
|
1727
|
-
<h3 class="">
|
|
1728
|
-
private
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
_actions: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
1732
|
-
</h3>
|
|
1733
|
-
</div>
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
<div class="property-description"><p>Actions lookup</p>
|
|
1737
|
-
</div>
|
|
1738
|
-
|
|
1739
|
-
</div>
|
|
1740
|
-
</div>
|
|
1741
|
-
|
|
1742
|
-
<div id="methods public">
|
|
1743
|
-
<h2 id="public-methods">Public Methods</h2>
|
|
1744
|
-
<div class="method item">
|
|
1745
|
-
<div id="method_addAddonsToProject" class="title">
|
|
1746
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1083"><code>lib/models/blueprint.js:1083</code></a></span>
|
|
1747
|
-
<h3 class="">
|
|
1748
|
-
public
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
addAddonsToProject(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1752
|
-
</h3>
|
|
1753
|
-
</div>
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
<div class="method-description"><p>Used to add multiple addons to the project's <code>package.json</code> and run their
|
|
1758
|
-
<code>defaultBlueprint</code> if they provide one.</p>
|
|
1759
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
1760
|
-
ensure that a package that is required by a given blueprint is
|
|
1761
|
-
available.</p>
|
|
1762
|
-
</div>
|
|
1763
|
-
|
|
1764
|
-
<div class="params">
|
|
1765
|
-
<h4>Parameters:</h4>
|
|
1766
|
-
<table>
|
|
1767
|
-
<thead>
|
|
1768
|
-
<tr>
|
|
1769
|
-
<th>Name</th>
|
|
1770
|
-
<th>Type</th>
|
|
1771
|
-
<th>Attribute</th>
|
|
1772
|
-
<th>Description</th>
|
|
1773
|
-
</tr>
|
|
1774
|
-
</thead>
|
|
1775
|
-
<tbody>
|
|
1776
|
-
<tr>
|
|
1777
|
-
<td>options</td>
|
|
1778
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1779
|
-
<td>
|
|
1780
|
-
<ul>
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
</ul>
|
|
1785
|
-
</td>
|
|
1786
|
-
<td> </td>
|
|
1787
|
-
</tr>
|
|
1788
|
-
|
|
1789
|
-
</tbody>
|
|
1790
|
-
</table>
|
|
1791
|
-
</div>
|
|
1792
|
-
|
|
1793
|
-
<div class="return">
|
|
1794
|
-
<h4>Return:</h4>
|
|
1795
|
-
<div>
|
|
1796
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
1797
|
-
<span class="return-description"></span>
|
|
1798
|
-
</div>
|
|
1799
|
-
</div>
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
</div>
|
|
1803
|
-
<div class="method item">
|
|
1804
|
-
<div id="method_addAddonToProject" class="title">
|
|
1805
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1063"><code>lib/models/blueprint.js:1063</code></a></span>
|
|
1806
|
-
<h3 class="">
|
|
1807
|
-
public
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
addAddonToProject(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1811
|
-
</h3>
|
|
1812
|
-
</div>
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
<div class="method-description"><p>Used to add an addon to the project's <code>package.json</code> and run it's
|
|
1817
|
-
<code>defaultBlueprint</code> if it provides one.</p>
|
|
1818
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
1819
|
-
ensure that a package that is required by a given blueprint is
|
|
1820
|
-
available.</p>
|
|
1821
|
-
</div>
|
|
1822
|
-
|
|
1823
|
-
<div class="params">
|
|
1824
|
-
<h4>Parameters:</h4>
|
|
1825
|
-
<table>
|
|
1826
|
-
<thead>
|
|
1827
|
-
<tr>
|
|
1828
|
-
<th>Name</th>
|
|
1829
|
-
<th>Type</th>
|
|
1830
|
-
<th>Attribute</th>
|
|
1831
|
-
<th>Description</th>
|
|
1832
|
-
</tr>
|
|
1833
|
-
</thead>
|
|
1834
|
-
<tbody>
|
|
1835
|
-
<tr>
|
|
1836
|
-
<td>options</td>
|
|
1837
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1838
|
-
<td>
|
|
1839
|
-
<ul>
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
</ul>
|
|
1844
|
-
</td>
|
|
1845
|
-
<td> </td>
|
|
1846
|
-
</tr>
|
|
1847
|
-
|
|
1848
|
-
</tbody>
|
|
1849
|
-
</table>
|
|
1850
|
-
</div>
|
|
1851
|
-
|
|
1852
|
-
<div class="return">
|
|
1853
|
-
<h4>Return:</h4>
|
|
1854
|
-
<div>
|
|
1855
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
1856
|
-
<span class="return-description"></span>
|
|
1857
|
-
</div>
|
|
1858
|
-
</div>
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
</div>
|
|
1862
|
-
<div class="method item">
|
|
1863
|
-
<div id="method_addBowerPackagesToProject" class="title">
|
|
1864
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1026"><code>lib/models/blueprint.js:1026</code></a></span>
|
|
1865
|
-
<h3 class="">
|
|
1866
|
-
public
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
addBowerPackagesToProject(packages, installOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1870
|
-
</h3>
|
|
1871
|
-
</div>
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
<div class="method-description"><p>Used to add an array of packages to the projects <code>bower.json</code>.</p>
|
|
1876
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
1877
|
-
ensure that a package that is required by a given blueprint is
|
|
1878
|
-
available.</p>
|
|
1879
|
-
<p>Expects each array item to be an object with a <code>name</code>. Each object
|
|
1880
|
-
may optionally have a <code>target</code> to specify a specific version, or a
|
|
1881
|
-
<code>source</code> to specify a non-local name to be resolved.</p>
|
|
1882
|
-
</div>
|
|
1883
|
-
|
|
1884
|
-
<div class="params">
|
|
1885
|
-
<h4>Parameters:</h4>
|
|
1886
|
-
<table>
|
|
1887
|
-
<thead>
|
|
1888
|
-
<tr>
|
|
1889
|
-
<th>Name</th>
|
|
1890
|
-
<th>Type</th>
|
|
1891
|
-
<th>Attribute</th>
|
|
1892
|
-
<th>Description</th>
|
|
1893
|
-
</tr>
|
|
1894
|
-
</thead>
|
|
1895
|
-
<tbody>
|
|
1896
|
-
<tr>
|
|
1897
|
-
<td>packages</td>
|
|
1898
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
1899
|
-
<td>
|
|
1900
|
-
<ul>
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
</ul>
|
|
1905
|
-
</td>
|
|
1906
|
-
<td> </td>
|
|
1907
|
-
</tr>
|
|
1908
|
-
|
|
1909
|
-
<tr>
|
|
1910
|
-
<td>installOptions</td>
|
|
1911
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1912
|
-
<td>
|
|
1913
|
-
<ul>
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
</ul>
|
|
1918
|
-
</td>
|
|
1919
|
-
<td> </td>
|
|
1920
|
-
</tr>
|
|
1921
|
-
|
|
1922
|
-
</tbody>
|
|
1923
|
-
</table>
|
|
1924
|
-
</div>
|
|
1925
|
-
|
|
1926
|
-
<div class="return">
|
|
1927
|
-
<h4>Return:</h4>
|
|
1928
|
-
<div>
|
|
1929
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
1930
|
-
<span class="return-description"></span>
|
|
1931
|
-
</div>
|
|
1932
|
-
</div>
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
</div>
|
|
1936
|
-
<div class="method item">
|
|
1937
|
-
<div id="method_addBowerPackageToProject" class="title">
|
|
1938
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l996"><code>lib/models/blueprint.js:996</code></a></span>
|
|
1939
|
-
<h3 class="">
|
|
1940
|
-
public
|
|
1941
|
-
|
|
1942
|
-
|
|
1943
|
-
addBowerPackageToProject(localPackageName, target, installOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
1944
|
-
</h3>
|
|
1945
|
-
</div>
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
<div class="method-description"><p>Used to add a package to the projects <code>bower.json</code>.</p>
|
|
1950
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
1951
|
-
ensure that a package that is required by a given blueprint is
|
|
1952
|
-
available.</p>
|
|
1953
|
-
<p><code>localPackageName</code> and <code>target</code> may be thought of as equivalent
|
|
1954
|
-
to the key-value pairs in the <code>dependency</code> or <code>devDepencency</code>
|
|
1955
|
-
objects contained within a bower.json file.</p>
|
|
1956
|
-
</div>
|
|
1957
|
-
|
|
1958
|
-
<div class="params">
|
|
1959
|
-
<h4>Parameters:</h4>
|
|
1960
|
-
<table>
|
|
1961
|
-
<thead>
|
|
1962
|
-
<tr>
|
|
1963
|
-
<th>Name</th>
|
|
1964
|
-
<th>Type</th>
|
|
1965
|
-
<th>Attribute</th>
|
|
1966
|
-
<th>Description</th>
|
|
1967
|
-
</tr>
|
|
1968
|
-
</thead>
|
|
1969
|
-
<tbody>
|
|
1970
|
-
<tr>
|
|
1971
|
-
<td>localPackageName</td>
|
|
1972
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
1973
|
-
<td>
|
|
1974
|
-
<ul>
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
</ul>
|
|
1979
|
-
</td>
|
|
1980
|
-
<td> </td>
|
|
1981
|
-
</tr>
|
|
1982
|
-
|
|
1983
|
-
<tr>
|
|
1984
|
-
<td>target</td>
|
|
1985
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
1986
|
-
<td>
|
|
1987
|
-
<ul>
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
</ul>
|
|
1992
|
-
</td>
|
|
1993
|
-
<td> </td>
|
|
1994
|
-
</tr>
|
|
1995
|
-
|
|
1996
|
-
<tr>
|
|
1997
|
-
<td>installOptions</td>
|
|
1998
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
1999
|
-
<td>
|
|
2000
|
-
<ul>
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
</ul>
|
|
2005
|
-
</td>
|
|
2006
|
-
<td> </td>
|
|
2007
|
-
</tr>
|
|
2008
|
-
|
|
2009
|
-
</tbody>
|
|
2010
|
-
</table>
|
|
2011
|
-
</div>
|
|
2012
|
-
|
|
2013
|
-
<div class="return">
|
|
2014
|
-
<h4>Return:</h4>
|
|
2015
|
-
<div>
|
|
2016
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
2017
|
-
<span class="return-description"></span>
|
|
2018
|
-
</div>
|
|
2019
|
-
</div>
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
<h4>Example:</h4>
|
|
2023
|
-
<pre class="code prettyprint"><code class="language-js">addBowerPackageToProject('jquery', '~1.11.1');
|
|
2024
|
-
addBowerPackageToProject('old_jquery', 'jquery#~1.9.1');
|
|
2025
|
-
addBowerPackageToProject('bootstrap-3', 'https://twitter.github.io/bootstrap/assets/bootstrap');
|
|
2026
|
-
</code></pre>
|
|
2027
|
-
|
|
2028
|
-
</div>
|
|
2029
|
-
<div class="method item">
|
|
2030
|
-
<div id="method_addPackagesToProject" class="title">
|
|
2031
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l889"><code>lib/models/blueprint.js:889</code></a></span>
|
|
2032
|
-
<h3 class="">
|
|
2033
|
-
public
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
addPackagesToProject(packages): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
2037
|
-
</h3>
|
|
2038
|
-
</div>
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
<div class="method-description"><p>Used to add multiple packages to the project's <code>package.json</code>.</p>
|
|
2043
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
2044
|
-
ensure that a package that is required by a given blueprint is
|
|
2045
|
-
available.</p>
|
|
2046
|
-
<p>Expects each array item to be an object with a <code>name</code>. Each object
|
|
2047
|
-
may optionally have a <code>target</code> to specify a specific version.</p>
|
|
2048
|
-
</div>
|
|
2049
|
-
|
|
2050
|
-
<div class="params">
|
|
2051
|
-
<h4>Parameters:</h4>
|
|
2052
|
-
<table>
|
|
2053
|
-
<thead>
|
|
2054
|
-
<tr>
|
|
2055
|
-
<th>Name</th>
|
|
2056
|
-
<th>Type</th>
|
|
2057
|
-
<th>Attribute</th>
|
|
2058
|
-
<th>Description</th>
|
|
2059
|
-
</tr>
|
|
2060
|
-
</thead>
|
|
2061
|
-
<tbody>
|
|
2062
|
-
<tr>
|
|
2063
|
-
<td>packages</td>
|
|
2064
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
2065
|
-
<td>
|
|
2066
|
-
<ul>
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
</ul>
|
|
2071
|
-
</td>
|
|
2072
|
-
<td> </td>
|
|
2073
|
-
</tr>
|
|
2074
|
-
|
|
2075
|
-
</tbody>
|
|
2076
|
-
</table>
|
|
2077
|
-
</div>
|
|
2078
|
-
|
|
2079
|
-
<div class="return">
|
|
2080
|
-
<h4>Return:</h4>
|
|
2081
|
-
<div>
|
|
2082
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
2083
|
-
<span class="return-description"></span>
|
|
2084
|
-
</div>
|
|
2085
|
-
</div>
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
<h4>Example:</h4>
|
|
2089
|
-
<pre class="code prettyprint"><code class="language-js">this.addPackagesToProject([
|
|
2090
|
-
{ name: 'lodash' },
|
|
2091
|
-
{ name: 'moment', target: '^2.17.0' },
|
|
2092
|
-
]);
|
|
2093
|
-
</code></pre>
|
|
2094
|
-
|
|
2095
|
-
</div>
|
|
2096
|
-
<div class="method item">
|
|
2097
|
-
<div id="method_addPackageToProject" class="title">
|
|
2098
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l867"><code>lib/models/blueprint.js:867</code></a></span>
|
|
2099
|
-
<h3 class="">
|
|
2100
|
-
public
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
addPackageToProject(packageName, target): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
2104
|
-
</h3>
|
|
2105
|
-
</div>
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
<div class="method-description"><p>Used to add a package to the project's <code>package.json</code>.</p>
|
|
2110
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
2111
|
-
ensure that a package that is required by a given blueprint is
|
|
2112
|
-
available.</p>
|
|
2113
|
-
</div>
|
|
2114
|
-
|
|
2115
|
-
<div class="params">
|
|
2116
|
-
<h4>Parameters:</h4>
|
|
2117
|
-
<table>
|
|
2118
|
-
<thead>
|
|
2119
|
-
<tr>
|
|
2120
|
-
<th>Name</th>
|
|
2121
|
-
<th>Type</th>
|
|
2122
|
-
<th>Attribute</th>
|
|
2123
|
-
<th>Description</th>
|
|
2124
|
-
</tr>
|
|
2125
|
-
</thead>
|
|
2126
|
-
<tbody>
|
|
2127
|
-
<tr>
|
|
2128
|
-
<td>packageName</td>
|
|
2129
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2130
|
-
<td>
|
|
2131
|
-
<ul>
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
</ul>
|
|
2136
|
-
</td>
|
|
2137
|
-
<td> </td>
|
|
2138
|
-
</tr>
|
|
2139
|
-
|
|
2140
|
-
<tr>
|
|
2141
|
-
<td>target</td>
|
|
2142
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2143
|
-
<td>
|
|
2144
|
-
<ul>
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
</ul>
|
|
2149
|
-
</td>
|
|
2150
|
-
<td> </td>
|
|
2151
|
-
</tr>
|
|
2152
|
-
|
|
2153
|
-
</tbody>
|
|
2154
|
-
</table>
|
|
2155
|
-
</div>
|
|
2156
|
-
|
|
2157
|
-
<div class="return">
|
|
2158
|
-
<h4>Return:</h4>
|
|
2159
|
-
<div>
|
|
2160
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
2161
|
-
<span class="return-description"></span>
|
|
2162
|
-
</div>
|
|
2163
|
-
</div>
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
</div>
|
|
2167
|
-
<div class="method item">
|
|
2168
|
-
<div id="method_afterInstall" class="title">
|
|
2169
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l500"><code>lib/models/blueprint.js:500</code></a></span>
|
|
2170
|
-
<h3 class="">
|
|
2171
|
-
public
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
afterInstall( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
2175
|
-
</h3>
|
|
2176
|
-
</div>
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
<div class="method-description"><p>Hook for running operations after install.</p>
|
|
2181
|
-
</div>
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
<div class="return">
|
|
2185
|
-
<h4>Return:</h4>
|
|
2186
|
-
<div>
|
|
2187
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null</span>
|
|
2188
|
-
<span class="return-description"></span>
|
|
2189
|
-
</div>
|
|
2190
|
-
</div>
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
</div>
|
|
2194
|
-
<div class="method item">
|
|
2195
|
-
<div id="method_afterUninstall" class="title">
|
|
2196
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l514"><code>lib/models/blueprint.js:514</code></a></span>
|
|
2197
|
-
<h3 class="">
|
|
2198
|
-
public
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
afterUninstall( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
2202
|
-
</h3>
|
|
2203
|
-
</div>
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
<div class="method-description"><p>Hook for running operations after uninstall.</p>
|
|
2208
|
-
</div>
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
<div class="return">
|
|
2212
|
-
<h4>Return:</h4>
|
|
2213
|
-
<div>
|
|
2214
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null</span>
|
|
2215
|
-
<span class="return-description"></span>
|
|
2216
|
-
</div>
|
|
2217
|
-
</div>
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
</div>
|
|
2221
|
-
<div class="method item">
|
|
2222
|
-
<div id="method_beforeInstall" class="title">
|
|
2223
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l493"><code>lib/models/blueprint.js:493</code></a></span>
|
|
2224
|
-
<h3 class="">
|
|
2225
|
-
public
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
beforeInstall( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
2229
|
-
</h3>
|
|
2230
|
-
</div>
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
<div class="method-description"><p>Hook for running operations before install.</p>
|
|
2235
|
-
</div>
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
<div class="return">
|
|
2239
|
-
<h4>Return:</h4>
|
|
2240
|
-
<div>
|
|
2241
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null</span>
|
|
2242
|
-
<span class="return-description"></span>
|
|
2243
|
-
</div>
|
|
2244
|
-
</div>
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
</div>
|
|
2248
|
-
<div class="method item">
|
|
2249
|
-
<div id="method_beforeUninstall" class="title">
|
|
2250
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l507"><code>lib/models/blueprint.js:507</code></a></span>
|
|
2251
|
-
<h3 class="">
|
|
2252
|
-
public
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
beforeUninstall( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
2256
|
-
</h3>
|
|
2257
|
-
</div>
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
<div class="method-description"><p>Hook for running operations before uninstall.</p>
|
|
2262
|
-
</div>
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
<div class="return">
|
|
2266
|
-
<h4>Return:</h4>
|
|
2267
|
-
<div>
|
|
2268
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null</span>
|
|
2269
|
-
<span class="return-description"></span>
|
|
2270
|
-
</div>
|
|
2271
|
-
</div>
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
</div>
|
|
2275
|
-
<div class="method item">
|
|
2276
|
-
<div id="method_buildFileInfo" class="title">
|
|
2277
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l657"><code>lib/models/blueprint.js:657</code></a></span>
|
|
2278
|
-
<h3 class="">
|
|
2279
|
-
public
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
buildFileInfo(destPath, templateVariables, file): FileInfo
|
|
2283
|
-
</h3>
|
|
2284
|
-
</div>
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
<div class="method-description"></div>
|
|
2289
|
-
|
|
2290
|
-
<div class="params">
|
|
2291
|
-
<h4>Parameters:</h4>
|
|
2292
|
-
<table>
|
|
2293
|
-
<thead>
|
|
2294
|
-
<tr>
|
|
2295
|
-
<th>Name</th>
|
|
2296
|
-
<th>Type</th>
|
|
2297
|
-
<th>Attribute</th>
|
|
2298
|
-
<th>Description</th>
|
|
2299
|
-
</tr>
|
|
2300
|
-
</thead>
|
|
2301
|
-
<tbody>
|
|
2302
|
-
<tr>
|
|
2303
|
-
<td>destPath</td>
|
|
2304
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
|
|
2305
|
-
<td>
|
|
2306
|
-
<ul>
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
</ul>
|
|
2311
|
-
</td>
|
|
2312
|
-
<td> </td>
|
|
2313
|
-
</tr>
|
|
2314
|
-
|
|
2315
|
-
<tr>
|
|
2316
|
-
<td>templateVariables</td>
|
|
2317
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2318
|
-
<td>
|
|
2319
|
-
<ul>
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
</ul>
|
|
2324
|
-
</td>
|
|
2325
|
-
<td> </td>
|
|
2326
|
-
</tr>
|
|
2327
|
-
|
|
2328
|
-
<tr>
|
|
2329
|
-
<td>file</td>
|
|
2330
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2331
|
-
<td>
|
|
2332
|
-
<ul>
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
</ul>
|
|
2337
|
-
</td>
|
|
2338
|
-
<td> </td>
|
|
2339
|
-
</tr>
|
|
2340
|
-
|
|
2341
|
-
</tbody>
|
|
2342
|
-
</table>
|
|
2343
|
-
</div>
|
|
2344
|
-
|
|
2345
|
-
<div class="return">
|
|
2346
|
-
<h4>Return:</h4>
|
|
2347
|
-
<div>
|
|
2348
|
-
<span class="return-type">FileInfo</span>
|
|
2349
|
-
<span class="return-description"></span>
|
|
2350
|
-
</div>
|
|
2351
|
-
</div>
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
</div>
|
|
2355
|
-
<div class="method item public">
|
|
2356
|
-
<div id="method_fileMapTokens" class="title">
|
|
2357
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l558"><code>lib/models/blueprint.js:558</code></a></span>
|
|
2358
|
-
<h3 class="">
|
|
2359
|
-
public
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
fileMapTokens( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | Null
|
|
2363
|
-
</h3>
|
|
2364
|
-
</div>
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
<div class="method-description"><p>Hook to add additional or override existing fileMap tokens.</p>
|
|
2369
|
-
<p>Use <code>fileMapTokens</code> to add custom fileMap tokens for use
|
|
2370
|
-
in the <code>mapFile</code> method. The hook must return an object in the
|
|
2371
|
-
following pattern:</p>
|
|
2372
|
-
<pre class="code prettyprint"><code class="language-js">{
|
|
2373
|
-
__token__(options){
|
|
2374
|
-
// logic to determine value goes here
|
|
2375
|
-
return 'value';
|
|
2376
|
-
}
|
|
2377
|
-
}
|
|
2378
|
-
</code></pre>
|
|
2379
|
-
<p>It will be merged with the default <code>fileMapTokens</code>, and can be used
|
|
2380
|
-
to override any of the default tokens.</p>
|
|
2381
|
-
<p>Tokens are used in the files folder (see <code>files</code>), and get replaced with
|
|
2382
|
-
values when the <code>mapFile</code> method is called.</p>
|
|
2383
|
-
</div>
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
<div class="return">
|
|
2387
|
-
<h4>Return:</h4>
|
|
2388
|
-
<div>
|
|
2389
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | Null</span>
|
|
2390
|
-
<span class="return-description"></span>
|
|
2391
|
-
</div>
|
|
2392
|
-
</div>
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
</div>
|
|
2396
|
-
<div class="method item public">
|
|
2397
|
-
<div id="method_files" class="title">
|
|
2398
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l222"><code>lib/models/blueprint.js:222</code></a></span>
|
|
2399
|
-
<h3 class="">
|
|
2400
|
-
public
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
files( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
2404
|
-
</h3>
|
|
2405
|
-
</div>
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
<div class="method-description"><p>Used to retrieve files for blueprint.</p>
|
|
2410
|
-
</div>
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
<div class="return">
|
|
2414
|
-
<h4>Return:</h4>
|
|
2415
|
-
<div>
|
|
2416
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
2417
|
-
<span class="return-description"><p>Contents of the blueprint's files directory</p>
|
|
2418
|
-
</span>
|
|
2419
|
-
</div>
|
|
2420
|
-
</div>
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
</div>
|
|
2424
|
-
<div class="method item public">
|
|
2425
|
-
<div id="method_filesPath" class="title">
|
|
2426
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l205"><code>lib/models/blueprint.js:205</code></a></span>
|
|
2427
|
-
<h3 class="">
|
|
2428
|
-
public
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
filesPath(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
2432
|
-
</h3>
|
|
2433
|
-
</div>
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
<div class="method-description"><p>Hook to specify the path to the blueprint's files. By default this is
|
|
2438
|
-
<code>path.join(this.path, 'files)</code>.</p>
|
|
2439
|
-
<p>This can be used to customize which set of files to install based on options
|
|
2440
|
-
or environmental variables. It defaults to the <code>files</code> directory within the
|
|
2441
|
-
blueprint's folder.</p>
|
|
2442
|
-
</div>
|
|
2443
|
-
|
|
2444
|
-
<div class="params">
|
|
2445
|
-
<h4>Parameters:</h4>
|
|
2446
|
-
<table>
|
|
2447
|
-
<thead>
|
|
2448
|
-
<tr>
|
|
2449
|
-
<th>Name</th>
|
|
2450
|
-
<th>Type</th>
|
|
2451
|
-
<th>Attribute</th>
|
|
2452
|
-
<th>Description</th>
|
|
2453
|
-
</tr>
|
|
2454
|
-
</thead>
|
|
2455
|
-
<tbody>
|
|
2456
|
-
<tr>
|
|
2457
|
-
<td>options</td>
|
|
2458
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2459
|
-
<td>
|
|
2460
|
-
<ul>
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
</ul>
|
|
2465
|
-
</td>
|
|
2466
|
-
<td> </td>
|
|
2467
|
-
</tr>
|
|
2468
|
-
|
|
2469
|
-
</tbody>
|
|
2470
|
-
</table>
|
|
2471
|
-
</div>
|
|
2472
|
-
|
|
2473
|
-
<div class="return">
|
|
2474
|
-
<h4>Return:</h4>
|
|
2475
|
-
<div>
|
|
2476
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
2477
|
-
<span class="return-description"><p>Path to the blueprints files directory.</p>
|
|
2478
|
-
</span>
|
|
2479
|
-
</div>
|
|
2480
|
-
</div>
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
</div>
|
|
2484
|
-
<div class="method item">
|
|
2485
|
-
<div id="method_generateFileMap" class="title">
|
|
2486
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l642"><code>lib/models/blueprint.js:642</code></a></span>
|
|
2487
|
-
<h3 class="">
|
|
2488
|
-
public
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
generateFileMap(fileMapVariables): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
2492
|
-
</h3>
|
|
2493
|
-
</div>
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
<div class="method-description"><p>Used to generate fileMap tokens for mapFile.</p>
|
|
2498
|
-
</div>
|
|
2499
|
-
|
|
2500
|
-
<div class="params">
|
|
2501
|
-
<h4>Parameters:</h4>
|
|
2502
|
-
<table>
|
|
2503
|
-
<thead>
|
|
2504
|
-
<tr>
|
|
2505
|
-
<th>Name</th>
|
|
2506
|
-
<th>Type</th>
|
|
2507
|
-
<th>Attribute</th>
|
|
2508
|
-
<th>Description</th>
|
|
2509
|
-
</tr>
|
|
2510
|
-
</thead>
|
|
2511
|
-
<tbody>
|
|
2512
|
-
<tr>
|
|
2513
|
-
<td>fileMapVariables</td>
|
|
2514
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2515
|
-
<td>
|
|
2516
|
-
<ul>
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
</ul>
|
|
2521
|
-
</td>
|
|
2522
|
-
<td> </td>
|
|
2523
|
-
</tr>
|
|
2524
|
-
|
|
2525
|
-
</tbody>
|
|
2526
|
-
</table>
|
|
2527
|
-
</div>
|
|
2528
|
-
|
|
2529
|
-
<div class="return">
|
|
2530
|
-
<h4>Return:</h4>
|
|
2531
|
-
<div>
|
|
2532
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
|
|
2533
|
-
<span class="return-description"></span>
|
|
2534
|
-
</div>
|
|
2535
|
-
</div>
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
</div>
|
|
2539
|
-
<div class="method item">
|
|
2540
|
-
<div id="method_insertIntoFile" class="title">
|
|
2541
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1147"><code>lib/models/blueprint.js:1147</code></a></span>
|
|
2542
|
-
<h3 class="">
|
|
2543
|
-
public
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
insertIntoFile(pathRelativeToProjectRoot, contentsToInsert, providedOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
2547
|
-
</h3>
|
|
2548
|
-
</div>
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
<div class="method-description"><p>Inserts the given content into a file. If the <code>contentsToInsert</code> string is already
|
|
2553
|
-
present in the current contents, the file will not be changed unless <code>force</code> option
|
|
2554
|
-
is passed.</p>
|
|
2555
|
-
<p>If <code>options.before</code> is specified, <code>contentsToInsert</code> will be inserted before
|
|
2556
|
-
the first instance of that string. If <code>options.after</code> is specified, the
|
|
2557
|
-
contents will be inserted after the first instance of that string.
|
|
2558
|
-
If the string specified by options.before or options.after is not in the file,
|
|
2559
|
-
no change will be made.</p>
|
|
2560
|
-
<p>If neither <code>options.before</code> nor <code>options.after</code> are present, <code>contentsToInsert</code>
|
|
2561
|
-
will be inserted at the end of the file.</p>
|
|
2562
|
-
<p>Example:</p>
|
|
2563
|
-
<pre class="code prettyprint"><code>// app/router.js
|
|
2564
|
-
Router.map(function () {
|
|
2565
|
-
});
|
|
2566
|
-
</code></pre>
|
|
2567
|
-
<pre class="code prettyprint"><code>insertIntoFile('app/router.js', ' this.route("admin");', {
|
|
2568
|
-
after: 'Router.map(function () {' + EOL
|
|
2569
|
-
}).then(function() {
|
|
2570
|
-
// file has been inserted into!
|
|
2571
|
-
});
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
</code></pre>
|
|
2575
|
-
<pre class="code prettyprint"><code>// app/router.js
|
|
2576
|
-
Router.map(function () {
|
|
2577
|
-
this.route("admin");
|
|
2578
|
-
});
|
|
2579
|
-
</code></pre>
|
|
2580
|
-
</div>
|
|
2581
|
-
|
|
2582
|
-
<div class="params">
|
|
2583
|
-
<h4>Parameters:</h4>
|
|
2584
|
-
<table>
|
|
2585
|
-
<thead>
|
|
2586
|
-
<tr>
|
|
2587
|
-
<th>Name</th>
|
|
2588
|
-
<th>Type</th>
|
|
2589
|
-
<th>Attribute</th>
|
|
2590
|
-
<th>Description</th>
|
|
2591
|
-
</tr>
|
|
2592
|
-
</thead>
|
|
2593
|
-
<tbody>
|
|
2594
|
-
<tr>
|
|
2595
|
-
<td>pathRelativeToProjectRoot</td>
|
|
2596
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2597
|
-
<td>
|
|
2598
|
-
<ul>
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
</ul>
|
|
2603
|
-
</td>
|
|
2604
|
-
<td> </td>
|
|
2605
|
-
</tr>
|
|
2606
|
-
|
|
2607
|
-
<tr>
|
|
2608
|
-
<td>contentsToInsert</td>
|
|
2609
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2610
|
-
<td>
|
|
2611
|
-
<ul>
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
|
|
2615
|
-
</ul>
|
|
2616
|
-
</td>
|
|
2617
|
-
<td> </td>
|
|
2618
|
-
</tr>
|
|
2619
|
-
|
|
2620
|
-
<tr>
|
|
2621
|
-
<td>providedOptions</td>
|
|
2622
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2623
|
-
<td>
|
|
2624
|
-
<ul>
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
</ul>
|
|
2629
|
-
</td>
|
|
2630
|
-
<td> </td>
|
|
2631
|
-
</tr>
|
|
2632
|
-
|
|
2633
|
-
</tbody>
|
|
2634
|
-
</table>
|
|
2635
|
-
</div>
|
|
2636
|
-
|
|
2637
|
-
<div class="return">
|
|
2638
|
-
<h4>Return:</h4>
|
|
2639
|
-
<div>
|
|
2640
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
2641
|
-
<span class="return-description"></span>
|
|
2642
|
-
</div>
|
|
2643
|
-
</div>
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
</div>
|
|
2647
|
-
<div class="method item">
|
|
2648
|
-
<div id="method_install" class="title">
|
|
2649
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l438"><code>lib/models/blueprint.js:438</code></a></span>
|
|
2650
|
-
<h3 class="">
|
|
2651
|
-
public
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
install(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
2655
|
-
</h3>
|
|
2656
|
-
</div>
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
<div class="method-description"></div>
|
|
2661
|
-
|
|
2662
|
-
<div class="params">
|
|
2663
|
-
<h4>Parameters:</h4>
|
|
2664
|
-
<table>
|
|
2665
|
-
<thead>
|
|
2666
|
-
<tr>
|
|
2667
|
-
<th>Name</th>
|
|
2668
|
-
<th>Type</th>
|
|
2669
|
-
<th>Attribute</th>
|
|
2670
|
-
<th>Description</th>
|
|
2671
|
-
</tr>
|
|
2672
|
-
</thead>
|
|
2673
|
-
<tbody>
|
|
2674
|
-
<tr>
|
|
2675
|
-
<td>options</td>
|
|
2676
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2677
|
-
<td>
|
|
2678
|
-
<ul>
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
|
|
2682
|
-
</ul>
|
|
2683
|
-
</td>
|
|
2684
|
-
<td> </td>
|
|
2685
|
-
</tr>
|
|
2686
|
-
|
|
2687
|
-
</tbody>
|
|
2688
|
-
</table>
|
|
2689
|
-
</div>
|
|
2690
|
-
|
|
2691
|
-
<div class="return">
|
|
2692
|
-
<h4>Return:</h4>
|
|
2693
|
-
<div>
|
|
2694
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
2695
|
-
<span class="return-description"></span>
|
|
2696
|
-
</div>
|
|
2697
|
-
</div>
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
</div>
|
|
2701
|
-
<div class="method item">
|
|
2702
|
-
<div id="method_isUpdate" class="title">
|
|
2703
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l678"><code>lib/models/blueprint.js:678</code></a></span>
|
|
2704
|
-
<h3 class="">
|
|
2705
|
-
public
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
isUpdate( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
2709
|
-
</h3>
|
|
2710
|
-
</div>
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
<div class="method-description"></div>
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
<div class="return">
|
|
2718
|
-
<h4>Return:</h4>
|
|
2719
|
-
<div>
|
|
2720
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
|
|
2721
|
-
<span class="return-description"></span>
|
|
2722
|
-
</div>
|
|
2723
|
-
</div>
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
</div>
|
|
2727
|
-
<div class="method item public">
|
|
2728
|
-
<div id="method_locals" class="title">
|
|
2729
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l523"><code>lib/models/blueprint.js:523</code></a></span>
|
|
2730
|
-
<h3 class="">
|
|
2731
|
-
public
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
locals(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null
|
|
2735
|
-
</h3>
|
|
2736
|
-
</div>
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
<div class="method-description"><p>Hook for adding custom template variables.</p>
|
|
2741
|
-
<p>When the following is called on the command line:</p>
|
|
2742
|
-
<pre class="code prettyprint"><code class="language-sh">ember generate controller foo --type=array --dry-run isAdmin:true
|
|
2743
|
-
</code></pre>
|
|
2744
|
-
<p>The object passed to <code>locals</code> looks like this:</p>
|
|
2745
|
-
<pre class="code prettyprint"><code class="language-js">{
|
|
2746
|
-
entity: {
|
|
2747
|
-
name: 'foo',
|
|
2748
|
-
options: {
|
|
2749
|
-
isAdmin: true
|
|
2750
|
-
}
|
|
2751
|
-
},
|
|
2752
|
-
dryRun: true
|
|
2753
|
-
type: "array"
|
|
2754
|
-
// more keys
|
|
2755
|
-
}
|
|
2756
|
-
</code></pre>
|
|
2757
|
-
<p>This hook must return an object or a Promise which resolves to an object.
|
|
2758
|
-
The resolved object will be merged with the aforementioned default locals.</p>
|
|
2759
|
-
</div>
|
|
2760
|
-
|
|
2761
|
-
<div class="params">
|
|
2762
|
-
<h4>Parameters:</h4>
|
|
2763
|
-
<table>
|
|
2764
|
-
<thead>
|
|
2765
|
-
<tr>
|
|
2766
|
-
<th>Name</th>
|
|
2767
|
-
<th>Type</th>
|
|
2768
|
-
<th>Attribute</th>
|
|
2769
|
-
<th>Description</th>
|
|
2770
|
-
</tr>
|
|
2771
|
-
</thead>
|
|
2772
|
-
<tbody>
|
|
2773
|
-
<tr>
|
|
2774
|
-
<td>options</td>
|
|
2775
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2776
|
-
<td>
|
|
2777
|
-
<ul>
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
</ul>
|
|
2782
|
-
</td>
|
|
2783
|
-
<td><p>General and entity-specific options</p>
|
|
2784
|
-
</td>
|
|
2785
|
-
</tr>
|
|
2786
|
-
|
|
2787
|
-
</tbody>
|
|
2788
|
-
</table>
|
|
2789
|
-
</div>
|
|
2790
|
-
|
|
2791
|
-
<div class="return">
|
|
2792
|
-
<h4>Return:</h4>
|
|
2793
|
-
<div>
|
|
2794
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a> | Null</span>
|
|
2795
|
-
<span class="return-description"></span>
|
|
2796
|
-
</div>
|
|
2797
|
-
</div>
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
</div>
|
|
2801
|
-
<div class="method item public">
|
|
2802
|
-
<div id="method_lookupBlueprint" class="title">
|
|
2803
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1251"><code>lib/models/blueprint.js:1251</code></a></span>
|
|
2804
|
-
<h3 class="">
|
|
2805
|
-
public
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
lookupBlueprint(dasherizedName): <a href="../classes/Blueprint.html" class="crosslink">Blueprint</a>
|
|
2809
|
-
</h3>
|
|
2810
|
-
</div>
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
<div class="method-description"><p>Used to retrieve a blueprint with the given name.</p>
|
|
2815
|
-
</div>
|
|
2816
|
-
|
|
2817
|
-
<div class="params">
|
|
2818
|
-
<h4>Parameters:</h4>
|
|
2819
|
-
<table>
|
|
2820
|
-
<thead>
|
|
2821
|
-
<tr>
|
|
2822
|
-
<th>Name</th>
|
|
2823
|
-
<th>Type</th>
|
|
2824
|
-
<th>Attribute</th>
|
|
2825
|
-
<th>Description</th>
|
|
2826
|
-
</tr>
|
|
2827
|
-
</thead>
|
|
2828
|
-
<tbody>
|
|
2829
|
-
<tr>
|
|
2830
|
-
<td>dasherizedName</td>
|
|
2831
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2832
|
-
<td>
|
|
2833
|
-
<ul>
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
</ul>
|
|
2838
|
-
</td>
|
|
2839
|
-
<td> </td>
|
|
2840
|
-
</tr>
|
|
2841
|
-
|
|
2842
|
-
</tbody>
|
|
2843
|
-
</table>
|
|
2844
|
-
</div>
|
|
2845
|
-
|
|
2846
|
-
<div class="return">
|
|
2847
|
-
<h4>Return:</h4>
|
|
2848
|
-
<div>
|
|
2849
|
-
<span class="return-type"><a href="../classes/Blueprint.html" class="crosslink">Blueprint</a></span>
|
|
2850
|
-
<span class="return-description"></span>
|
|
2851
|
-
</div>
|
|
2852
|
-
</div>
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
</div>
|
|
2856
|
-
<div class="method item">
|
|
2857
|
-
<div id="method_mapFile" class="title">
|
|
2858
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l775"><code>lib/models/blueprint.js:775</code></a></span>
|
|
2859
|
-
<h3 class="">
|
|
2860
|
-
public
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
mapFile(file, locals): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
2864
|
-
</h3>
|
|
2865
|
-
</div>
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
<div class="method-description"></div>
|
|
2870
|
-
|
|
2871
|
-
<div class="params">
|
|
2872
|
-
<h4>Parameters:</h4>
|
|
2873
|
-
<table>
|
|
2874
|
-
<thead>
|
|
2875
|
-
<tr>
|
|
2876
|
-
<th>Name</th>
|
|
2877
|
-
<th>Type</th>
|
|
2878
|
-
<th>Attribute</th>
|
|
2879
|
-
<th>Description</th>
|
|
2880
|
-
</tr>
|
|
2881
|
-
</thead>
|
|
2882
|
-
<tbody>
|
|
2883
|
-
<tr>
|
|
2884
|
-
<td>file</td>
|
|
2885
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2886
|
-
<td>
|
|
2887
|
-
<ul>
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
</ul>
|
|
2892
|
-
</td>
|
|
2893
|
-
<td> </td>
|
|
2894
|
-
</tr>
|
|
2895
|
-
|
|
2896
|
-
<tr>
|
|
2897
|
-
<td>locals</td>
|
|
2898
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
2899
|
-
<td>
|
|
2900
|
-
<ul>
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
</ul>
|
|
2905
|
-
</td>
|
|
2906
|
-
<td> </td>
|
|
2907
|
-
</tr>
|
|
2908
|
-
|
|
2909
|
-
</tbody>
|
|
2910
|
-
</table>
|
|
2911
|
-
</div>
|
|
2912
|
-
|
|
2913
|
-
<div class="return">
|
|
2914
|
-
<h4>Return:</h4>
|
|
2915
|
-
<div>
|
|
2916
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
2917
|
-
<span class="return-description"></span>
|
|
2918
|
-
</div>
|
|
2919
|
-
</div>
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
</div>
|
|
2923
|
-
<div class="method item public">
|
|
2924
|
-
<div id="method_normalizeEntityName" class="title">
|
|
2925
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l253"><code>lib/models/blueprint.js:253</code></a></span>
|
|
2926
|
-
<h3 class="">
|
|
2927
|
-
public
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
normalizeEntityName(entityName): Null
|
|
2931
|
-
</h3>
|
|
2932
|
-
</div>
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
<div class="method-description"><p>Hook for normalizing entity name</p>
|
|
2937
|
-
<p>Use the <code>normalizeEntityName</code> hook to add custom normalization and
|
|
2938
|
-
validation of the provided entity name. The default hook does not
|
|
2939
|
-
make any changes to the entity name, but makes sure an entity name
|
|
2940
|
-
is present and that it doesn't have a trailing slash.</p>
|
|
2941
|
-
<p>This hook receives the entity name as its first argument. The string
|
|
2942
|
-
returned by this hook will be used as the new entity name.</p>
|
|
2943
|
-
</div>
|
|
2944
|
-
|
|
2945
|
-
<div class="params">
|
|
2946
|
-
<h4>Parameters:</h4>
|
|
2947
|
-
<table>
|
|
2948
|
-
<thead>
|
|
2949
|
-
<tr>
|
|
2950
|
-
<th>Name</th>
|
|
2951
|
-
<th>Type</th>
|
|
2952
|
-
<th>Attribute</th>
|
|
2953
|
-
<th>Description</th>
|
|
2954
|
-
</tr>
|
|
2955
|
-
</thead>
|
|
2956
|
-
<tbody>
|
|
2957
|
-
<tr>
|
|
2958
|
-
<td>entityName</td>
|
|
2959
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
2960
|
-
<td>
|
|
2961
|
-
<ul>
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
</ul>
|
|
2966
|
-
</td>
|
|
2967
|
-
<td> </td>
|
|
2968
|
-
</tr>
|
|
2969
|
-
|
|
2970
|
-
</tbody>
|
|
2971
|
-
</table>
|
|
2972
|
-
</div>
|
|
2973
|
-
|
|
2974
|
-
<div class="return">
|
|
2975
|
-
<h4>Return:</h4>
|
|
2976
|
-
<div>
|
|
2977
|
-
<span class="return-type">Null</span>
|
|
2978
|
-
<span class="return-description"></span>
|
|
2979
|
-
</div>
|
|
2980
|
-
</div>
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
</div>
|
|
2984
|
-
<div class="method item">
|
|
2985
|
-
<div id="method_processFiles" class="title">
|
|
2986
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l740"><code>lib/models/blueprint.js:740</code></a></span>
|
|
2987
|
-
<h3 class="">
|
|
2988
|
-
public
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
processFiles(intoDir, templateVariables): Promise<FileInfo>
|
|
2992
|
-
</h3>
|
|
2993
|
-
</div>
|
|
2994
|
-
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
<div class="method-description"></div>
|
|
2998
|
-
|
|
2999
|
-
<div class="params">
|
|
3000
|
-
<h4>Parameters:</h4>
|
|
3001
|
-
<table>
|
|
3002
|
-
<thead>
|
|
3003
|
-
<tr>
|
|
3004
|
-
<th>Name</th>
|
|
3005
|
-
<th>Type</th>
|
|
3006
|
-
<th>Attribute</th>
|
|
3007
|
-
<th>Description</th>
|
|
3008
|
-
</tr>
|
|
3009
|
-
</thead>
|
|
3010
|
-
<tbody>
|
|
3011
|
-
<tr>
|
|
3012
|
-
<td>intoDir</td>
|
|
3013
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3014
|
-
<td>
|
|
3015
|
-
<ul>
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
</ul>
|
|
3020
|
-
</td>
|
|
3021
|
-
<td> </td>
|
|
3022
|
-
</tr>
|
|
3023
|
-
|
|
3024
|
-
<tr>
|
|
3025
|
-
<td>templateVariables</td>
|
|
3026
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3027
|
-
<td>
|
|
3028
|
-
<ul>
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
|
|
3032
|
-
</ul>
|
|
3033
|
-
</td>
|
|
3034
|
-
<td> </td>
|
|
3035
|
-
</tr>
|
|
3036
|
-
|
|
3037
|
-
</tbody>
|
|
3038
|
-
</table>
|
|
3039
|
-
</div>
|
|
3040
|
-
|
|
3041
|
-
<div class="return">
|
|
3042
|
-
<h4>Return:</h4>
|
|
3043
|
-
<div>
|
|
3044
|
-
<span class="return-type">Promise<FileInfo></span>
|
|
3045
|
-
<span class="return-description"></span>
|
|
3046
|
-
</div>
|
|
3047
|
-
</div>
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
</div>
|
|
3051
|
-
<div class="method item">
|
|
3052
|
-
<div id="method_processFilesForUninstall" class="title">
|
|
3053
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l762"><code>lib/models/blueprint.js:762</code></a></span>
|
|
3054
|
-
<h3 class="">
|
|
3055
|
-
public
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
processFilesForUninstall(intoDir, templateVariables)
|
|
3059
|
-
</h3>
|
|
3060
|
-
</div>
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
<div class="method-description"></div>
|
|
3065
|
-
|
|
3066
|
-
<div class="params">
|
|
3067
|
-
<h4>Parameters:</h4>
|
|
3068
|
-
<table>
|
|
3069
|
-
<thead>
|
|
3070
|
-
<tr>
|
|
3071
|
-
<th>Name</th>
|
|
3072
|
-
<th>Type</th>
|
|
3073
|
-
<th>Attribute</th>
|
|
3074
|
-
<th>Description</th>
|
|
3075
|
-
</tr>
|
|
3076
|
-
</thead>
|
|
3077
|
-
<tbody>
|
|
3078
|
-
<tr>
|
|
3079
|
-
<td>intoDir</td>
|
|
3080
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3081
|
-
<td>
|
|
3082
|
-
<ul>
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
</ul>
|
|
3087
|
-
</td>
|
|
3088
|
-
<td> </td>
|
|
3089
|
-
</tr>
|
|
3090
|
-
|
|
3091
|
-
<tr>
|
|
3092
|
-
<td>templateVariables</td>
|
|
3093
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3094
|
-
<td>
|
|
3095
|
-
<ul>
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
</ul>
|
|
3100
|
-
</td>
|
|
3101
|
-
<td> </td>
|
|
3102
|
-
</tr>
|
|
3103
|
-
|
|
3104
|
-
</tbody>
|
|
3105
|
-
</table>
|
|
3106
|
-
</div>
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
</div>
|
|
3111
|
-
<div class="method item">
|
|
3112
|
-
<div id="method_removePackageFromProject" class="title">
|
|
3113
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l938"><code>lib/models/blueprint.js:938</code></a></span>
|
|
3114
|
-
<h3 class="">
|
|
3115
|
-
public
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
removePackageFromProject(packageName): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
3119
|
-
</h3>
|
|
3120
|
-
</div>
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
<div class="method-description"><p>Used to remove a package from the project's <code>package.json</code>.</p>
|
|
3125
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
3126
|
-
ensure that any package conflicts can be resolved before the
|
|
3127
|
-
addon is used.</p>
|
|
3128
|
-
</div>
|
|
3129
|
-
|
|
3130
|
-
<div class="params">
|
|
3131
|
-
<h4>Parameters:</h4>
|
|
3132
|
-
<table>
|
|
3133
|
-
<thead>
|
|
3134
|
-
<tr>
|
|
3135
|
-
<th>Name</th>
|
|
3136
|
-
<th>Type</th>
|
|
3137
|
-
<th>Attribute</th>
|
|
3138
|
-
<th>Description</th>
|
|
3139
|
-
</tr>
|
|
3140
|
-
</thead>
|
|
3141
|
-
<tbody>
|
|
3142
|
-
<tr>
|
|
3143
|
-
<td>packageName</td>
|
|
3144
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3145
|
-
<td>
|
|
3146
|
-
<ul>
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
</ul>
|
|
3151
|
-
</td>
|
|
3152
|
-
<td> </td>
|
|
3153
|
-
</tr>
|
|
3154
|
-
|
|
3155
|
-
</tbody>
|
|
3156
|
-
</table>
|
|
3157
|
-
</div>
|
|
3158
|
-
|
|
3159
|
-
<div class="return">
|
|
3160
|
-
<h4>Return:</h4>
|
|
3161
|
-
<div>
|
|
3162
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
3163
|
-
<span class="return-description"></span>
|
|
3164
|
-
</div>
|
|
3165
|
-
</div>
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
</div>
|
|
3169
|
-
<div class="method item">
|
|
3170
|
-
<div id="method_removePackagesFromProject" class="title">
|
|
3171
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l955"><code>lib/models/blueprint.js:955</code></a></span>
|
|
3172
|
-
<h3 class="">
|
|
3173
|
-
public
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
removePackagesFromProject(packages): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
3177
|
-
</h3>
|
|
3178
|
-
</div>
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
<div class="method-description"><p>Used to remove multiple packages from the project's <code>package.json</code>.</p>
|
|
3183
|
-
<p>Generally, this would be done from the <code>afterInstall</code> hook, to
|
|
3184
|
-
ensure that any package conflicts can be resolved before the
|
|
3185
|
-
addon is used.</p>
|
|
3186
|
-
<p>Expects each array item to be an object with a <code>name</code> property.</p>
|
|
3187
|
-
</div>
|
|
3188
|
-
|
|
3189
|
-
<div class="params">
|
|
3190
|
-
<h4>Parameters:</h4>
|
|
3191
|
-
<table>
|
|
3192
|
-
<thead>
|
|
3193
|
-
<tr>
|
|
3194
|
-
<th>Name</th>
|
|
3195
|
-
<th>Type</th>
|
|
3196
|
-
<th>Attribute</th>
|
|
3197
|
-
<th>Description</th>
|
|
3198
|
-
</tr>
|
|
3199
|
-
</thead>
|
|
3200
|
-
<tbody>
|
|
3201
|
-
<tr>
|
|
3202
|
-
<td>packages</td>
|
|
3203
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
3204
|
-
<td>
|
|
3205
|
-
<ul>
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
</ul>
|
|
3210
|
-
</td>
|
|
3211
|
-
<td> </td>
|
|
3212
|
-
</tr>
|
|
3213
|
-
|
|
3214
|
-
</tbody>
|
|
3215
|
-
</table>
|
|
3216
|
-
</div>
|
|
3217
|
-
|
|
3218
|
-
<div class="return">
|
|
3219
|
-
<h4>Return:</h4>
|
|
3220
|
-
<div>
|
|
3221
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
3222
|
-
<span class="return-description"></span>
|
|
3223
|
-
</div>
|
|
3224
|
-
</div>
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
</div>
|
|
3228
|
-
<div class="method item">
|
|
3229
|
-
<div id="method_srcPath" class="title">
|
|
3230
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l244"><code>lib/models/blueprint.js:244</code></a></span>
|
|
3231
|
-
<h3 class="">
|
|
3232
|
-
public
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
srcPath(file): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
3236
|
-
</h3>
|
|
3237
|
-
</div>
|
|
3238
|
-
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
<div class="method-description"></div>
|
|
3242
|
-
|
|
3243
|
-
<div class="params">
|
|
3244
|
-
<h4>Parameters:</h4>
|
|
3245
|
-
<table>
|
|
3246
|
-
<thead>
|
|
3247
|
-
<tr>
|
|
3248
|
-
<th>Name</th>
|
|
3249
|
-
<th>Type</th>
|
|
3250
|
-
<th>Attribute</th>
|
|
3251
|
-
<th>Description</th>
|
|
3252
|
-
</tr>
|
|
3253
|
-
</thead>
|
|
3254
|
-
<tbody>
|
|
3255
|
-
<tr>
|
|
3256
|
-
<td>file</td>
|
|
3257
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3258
|
-
<td>
|
|
3259
|
-
<ul>
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
|
-
</ul>
|
|
3264
|
-
</td>
|
|
3265
|
-
<td> </td>
|
|
3266
|
-
</tr>
|
|
3267
|
-
|
|
3268
|
-
</tbody>
|
|
3269
|
-
</table>
|
|
3270
|
-
</div>
|
|
3271
|
-
|
|
3272
|
-
<div class="return">
|
|
3273
|
-
<h4>Return:</h4>
|
|
3274
|
-
<div>
|
|
3275
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
3276
|
-
<span class="return-description"><p>Resolved path to the file</p>
|
|
3277
|
-
</span>
|
|
3278
|
-
</div>
|
|
3279
|
-
</div>
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
</div>
|
|
3283
|
-
<div class="method item public">
|
|
3284
|
-
<div id="method_taskFor" class="title">
|
|
3285
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1129"><code>lib/models/blueprint.js:1129</code></a></span>
|
|
3286
|
-
<h3 class="">
|
|
3287
|
-
public
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
taskFor(dasherizedName)
|
|
3291
|
-
</h3>
|
|
3292
|
-
</div>
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
|
|
3296
|
-
<div class="method-description"><p>Used to retrieve a task with the given name. Passes the new task
|
|
3297
|
-
the standard information available (like <code>ui</code>, <code>analytics</code>, <code>project</code>, etc).</p>
|
|
3298
|
-
</div>
|
|
3299
|
-
|
|
3300
|
-
<div class="params">
|
|
3301
|
-
<h4>Parameters:</h4>
|
|
3302
|
-
<table>
|
|
3303
|
-
<thead>
|
|
3304
|
-
<tr>
|
|
3305
|
-
<th>Name</th>
|
|
3306
|
-
<th>Type</th>
|
|
3307
|
-
<th>Attribute</th>
|
|
3308
|
-
<th>Description</th>
|
|
3309
|
-
</tr>
|
|
3310
|
-
</thead>
|
|
3311
|
-
<tbody>
|
|
3312
|
-
<tr>
|
|
3313
|
-
<td>dasherizedName</td>
|
|
3314
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3315
|
-
<td>
|
|
3316
|
-
<ul>
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
</ul>
|
|
3321
|
-
</td>
|
|
3322
|
-
<td> </td>
|
|
3323
|
-
</tr>
|
|
3324
|
-
|
|
3325
|
-
</tbody>
|
|
3326
|
-
</table>
|
|
3327
|
-
</div>
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
</div>
|
|
3332
|
-
<div class="method item">
|
|
3333
|
-
<div id="method_uninstall" class="title">
|
|
3334
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l468"><code>lib/models/blueprint.js:468</code></a></span>
|
|
3335
|
-
<h3 class="">
|
|
3336
|
-
public
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
uninstall(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
3340
|
-
</h3>
|
|
3341
|
-
</div>
|
|
3342
|
-
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
<div class="method-description"></div>
|
|
3346
|
-
|
|
3347
|
-
<div class="params">
|
|
3348
|
-
<h4>Parameters:</h4>
|
|
3349
|
-
<table>
|
|
3350
|
-
<thead>
|
|
3351
|
-
<tr>
|
|
3352
|
-
<th>Name</th>
|
|
3353
|
-
<th>Type</th>
|
|
3354
|
-
<th>Attribute</th>
|
|
3355
|
-
<th>Description</th>
|
|
3356
|
-
</tr>
|
|
3357
|
-
</thead>
|
|
3358
|
-
<tbody>
|
|
3359
|
-
<tr>
|
|
3360
|
-
<td>options</td>
|
|
3361
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3362
|
-
<td>
|
|
3363
|
-
<ul>
|
|
3364
|
-
|
|
3365
|
-
|
|
3366
|
-
|
|
3367
|
-
</ul>
|
|
3368
|
-
</td>
|
|
3369
|
-
<td> </td>
|
|
3370
|
-
</tr>
|
|
3371
|
-
|
|
3372
|
-
</tbody>
|
|
3373
|
-
</table>
|
|
3374
|
-
</div>
|
|
3375
|
-
|
|
3376
|
-
<div class="return">
|
|
3377
|
-
<h4>Return:</h4>
|
|
3378
|
-
<div>
|
|
3379
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
3380
|
-
<span class="return-description"></span>
|
|
3381
|
-
</div>
|
|
3382
|
-
</div>
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
</div>
|
|
3386
|
-
</div>
|
|
3387
|
-
|
|
3388
|
-
|
|
3389
|
-
<div id="methods private">
|
|
3390
|
-
<h2 id="private-methods">Private Methods</h2>
|
|
3391
|
-
<div class="method item private">
|
|
3392
|
-
<div id="method__checkForNoMatch" class="title">
|
|
3393
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l726"><code>lib/models/blueprint.js:726</code></a></span>
|
|
3394
|
-
<h3 class="">
|
|
3395
|
-
private
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
_checkForNoMatch(fileInfos, rawArgs)
|
|
3399
|
-
</h3>
|
|
3400
|
-
</div>
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
<div class="method-description"></div>
|
|
3405
|
-
|
|
3406
|
-
<div class="params">
|
|
3407
|
-
<h4>Parameters:</h4>
|
|
3408
|
-
<table>
|
|
3409
|
-
<thead>
|
|
3410
|
-
<tr>
|
|
3411
|
-
<th>Name</th>
|
|
3412
|
-
<th>Type</th>
|
|
3413
|
-
<th>Attribute</th>
|
|
3414
|
-
<th>Description</th>
|
|
3415
|
-
</tr>
|
|
3416
|
-
</thead>
|
|
3417
|
-
<tbody>
|
|
3418
|
-
<tr>
|
|
3419
|
-
<td>fileInfos</td>
|
|
3420
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
3421
|
-
<td>
|
|
3422
|
-
<ul>
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
</ul>
|
|
3427
|
-
</td>
|
|
3428
|
-
<td> </td>
|
|
3429
|
-
</tr>
|
|
3430
|
-
|
|
3431
|
-
<tr>
|
|
3432
|
-
<td>rawArgs</td>
|
|
3433
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3434
|
-
<td>
|
|
3435
|
-
<ul>
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
</ul>
|
|
3440
|
-
</td>
|
|
3441
|
-
<td> </td>
|
|
3442
|
-
</tr>
|
|
3443
|
-
|
|
3444
|
-
</tbody>
|
|
3445
|
-
</table>
|
|
3446
|
-
</div>
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
|
-
</div>
|
|
3451
|
-
<div class="method item private">
|
|
3452
|
-
<div id="method__checkForPod" class="title">
|
|
3453
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l355"><code>lib/models/blueprint.js:355</code></a></span>
|
|
3454
|
-
<h3 class="">
|
|
3455
|
-
private
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
_checkForPod( )
|
|
3459
|
-
</h3>
|
|
3460
|
-
</div>
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
<div class="method-description"><p>Prints warning for pod unsupported.</p>
|
|
3465
|
-
</div>
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
</div>
|
|
3471
|
-
<div class="method item private">
|
|
3472
|
-
<div id="method__checkInRepoAddonExists" class="title">
|
|
3473
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l383"><code>lib/models/blueprint.js:383</code></a></span>
|
|
3474
|
-
<h3 class="">
|
|
3475
|
-
private
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
_checkInRepoAddonExists(options)
|
|
3479
|
-
</h3>
|
|
3480
|
-
</div>
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
<div class="method-description"></div>
|
|
3485
|
-
|
|
3486
|
-
<div class="params">
|
|
3487
|
-
<h4>Parameters:</h4>
|
|
3488
|
-
<table>
|
|
3489
|
-
<thead>
|
|
3490
|
-
<tr>
|
|
3491
|
-
<th>Name</th>
|
|
3492
|
-
<th>Type</th>
|
|
3493
|
-
<th>Attribute</th>
|
|
3494
|
-
<th>Description</th>
|
|
3495
|
-
</tr>
|
|
3496
|
-
</thead>
|
|
3497
|
-
<tbody>
|
|
3498
|
-
<tr>
|
|
3499
|
-
<td>options</td>
|
|
3500
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3501
|
-
<td>
|
|
3502
|
-
<ul>
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
</ul>
|
|
3507
|
-
</td>
|
|
3508
|
-
<td> </td>
|
|
3509
|
-
</tr>
|
|
3510
|
-
|
|
3511
|
-
</tbody>
|
|
3512
|
-
</table>
|
|
3513
|
-
</div>
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
</div>
|
|
3518
|
-
<div class="method item private">
|
|
3519
|
-
<div id="method__commit" class="title">
|
|
3520
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l337"><code>lib/models/blueprint.js:337</code></a></span>
|
|
3521
|
-
<h3 class="">
|
|
3522
|
-
private
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
_commit(result): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
3526
|
-
</h3>
|
|
3527
|
-
</div>
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
<div class="method-description"><p>Calls an action.</p>
|
|
3532
|
-
</div>
|
|
3533
|
-
|
|
3534
|
-
<div class="params">
|
|
3535
|
-
<h4>Parameters:</h4>
|
|
3536
|
-
<table>
|
|
3537
|
-
<thead>
|
|
3538
|
-
<tr>
|
|
3539
|
-
<th>Name</th>
|
|
3540
|
-
<th>Type</th>
|
|
3541
|
-
<th>Attribute</th>
|
|
3542
|
-
<th>Description</th>
|
|
3543
|
-
</tr>
|
|
3544
|
-
</thead>
|
|
3545
|
-
<tbody>
|
|
3546
|
-
<tr>
|
|
3547
|
-
<td>result</td>
|
|
3548
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3549
|
-
<td>
|
|
3550
|
-
<ul>
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
</ul>
|
|
3555
|
-
</td>
|
|
3556
|
-
<td> </td>
|
|
3557
|
-
</tr>
|
|
3558
|
-
|
|
3559
|
-
</tbody>
|
|
3560
|
-
</table>
|
|
3561
|
-
</div>
|
|
3562
|
-
|
|
3563
|
-
<div class="return">
|
|
3564
|
-
<h4>Return:</h4>
|
|
3565
|
-
<div>
|
|
3566
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
3567
|
-
<span class="return-description"></span>
|
|
3568
|
-
</div>
|
|
3569
|
-
</div>
|
|
3570
|
-
|
|
3571
|
-
<div class="throws">
|
|
3572
|
-
<h4>Throws:</h4>
|
|
3573
|
-
<div>
|
|
3574
|
-
<span class="throws-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a></span>
|
|
3575
|
-
<span class="throws-description"><p>Action doesn't exist.</p>
|
|
3576
|
-
</span>
|
|
3577
|
-
</div>
|
|
3578
|
-
</div>
|
|
3579
|
-
|
|
3580
|
-
</div>
|
|
3581
|
-
<div class="method item private">
|
|
3582
|
-
<div id="method__fileMapTokens" class="title">
|
|
3583
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l586"><code>lib/models/blueprint.js:586</code></a></span>
|
|
3584
|
-
<h3 class="">
|
|
3585
|
-
private
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
_fileMapTokens(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
3589
|
-
</h3>
|
|
3590
|
-
</div>
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
<div class="method-description"></div>
|
|
3595
|
-
|
|
3596
|
-
<div class="params">
|
|
3597
|
-
<h4>Parameters:</h4>
|
|
3598
|
-
<table>
|
|
3599
|
-
<thead>
|
|
3600
|
-
<tr>
|
|
3601
|
-
<th>Name</th>
|
|
3602
|
-
<th>Type</th>
|
|
3603
|
-
<th>Attribute</th>
|
|
3604
|
-
<th>Description</th>
|
|
3605
|
-
</tr>
|
|
3606
|
-
</thead>
|
|
3607
|
-
<tbody>
|
|
3608
|
-
<tr>
|
|
3609
|
-
<td>options</td>
|
|
3610
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3611
|
-
<td>
|
|
3612
|
-
<ul>
|
|
3613
|
-
|
|
3614
|
-
|
|
3615
|
-
|
|
3616
|
-
</ul>
|
|
3617
|
-
</td>
|
|
3618
|
-
<td> </td>
|
|
3619
|
-
</tr>
|
|
3620
|
-
|
|
3621
|
-
</tbody>
|
|
3622
|
-
</table>
|
|
3623
|
-
</div>
|
|
3624
|
-
|
|
3625
|
-
<div class="return">
|
|
3626
|
-
<h4>Return:</h4>
|
|
3627
|
-
<div>
|
|
3628
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
|
|
3629
|
-
<span class="return-description"></span>
|
|
3630
|
-
</div>
|
|
3631
|
-
</div>
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
</div>
|
|
3635
|
-
<div class="method item private">
|
|
3636
|
-
<div id="method__generateFileMapVariables" class="title">
|
|
3637
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l804"><code>lib/models/blueprint.js:804</code></a></span>
|
|
3638
|
-
<h3 class="">
|
|
3639
|
-
private
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
_generateFileMapVariables(moduleName, locals, options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
3643
|
-
</h3>
|
|
3644
|
-
</div>
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
<div class="method-description"></div>
|
|
3649
|
-
|
|
3650
|
-
<div class="params">
|
|
3651
|
-
<h4>Parameters:</h4>
|
|
3652
|
-
<table>
|
|
3653
|
-
<thead>
|
|
3654
|
-
<tr>
|
|
3655
|
-
<th>Name</th>
|
|
3656
|
-
<th>Type</th>
|
|
3657
|
-
<th>Attribute</th>
|
|
3658
|
-
<th>Description</th>
|
|
3659
|
-
</tr>
|
|
3660
|
-
</thead>
|
|
3661
|
-
<tbody>
|
|
3662
|
-
<tr>
|
|
3663
|
-
<td>moduleName</td>
|
|
3664
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3665
|
-
<td>
|
|
3666
|
-
<ul>
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
</ul>
|
|
3671
|
-
</td>
|
|
3672
|
-
<td> </td>
|
|
3673
|
-
</tr>
|
|
3674
|
-
|
|
3675
|
-
<tr>
|
|
3676
|
-
<td>locals</td>
|
|
3677
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3678
|
-
<td>
|
|
3679
|
-
<ul>
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
</ul>
|
|
3684
|
-
</td>
|
|
3685
|
-
<td> </td>
|
|
3686
|
-
</tr>
|
|
3687
|
-
|
|
3688
|
-
<tr>
|
|
3689
|
-
<td>options</td>
|
|
3690
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3691
|
-
<td>
|
|
3692
|
-
<ul>
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
</ul>
|
|
3697
|
-
</td>
|
|
3698
|
-
<td> </td>
|
|
3699
|
-
</tr>
|
|
3700
|
-
|
|
3701
|
-
</tbody>
|
|
3702
|
-
</table>
|
|
3703
|
-
</div>
|
|
3704
|
-
|
|
3705
|
-
<div class="return">
|
|
3706
|
-
<h4>Return:</h4>
|
|
3707
|
-
<div>
|
|
3708
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
|
|
3709
|
-
<span class="return-description"></span>
|
|
3710
|
-
</div>
|
|
3711
|
-
</div>
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
</div>
|
|
3715
|
-
<div class="method item private">
|
|
3716
|
-
<div id="method__getFileInfos" class="title">
|
|
3717
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l688"><code>lib/models/blueprint.js:688</code></a></span>
|
|
3718
|
-
<h3 class="">
|
|
3719
|
-
private
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
_getFileInfos(files, intoDir, templateVariables): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
3723
|
-
</h3>
|
|
3724
|
-
</div>
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
<div class="method-description"></div>
|
|
3729
|
-
|
|
3730
|
-
<div class="params">
|
|
3731
|
-
<h4>Parameters:</h4>
|
|
3732
|
-
<table>
|
|
3733
|
-
<thead>
|
|
3734
|
-
<tr>
|
|
3735
|
-
<th>Name</th>
|
|
3736
|
-
<th>Type</th>
|
|
3737
|
-
<th>Attribute</th>
|
|
3738
|
-
<th>Description</th>
|
|
3739
|
-
</tr>
|
|
3740
|
-
</thead>
|
|
3741
|
-
<tbody>
|
|
3742
|
-
<tr>
|
|
3743
|
-
<td>files</td>
|
|
3744
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
3745
|
-
<td>
|
|
3746
|
-
<ul>
|
|
3747
|
-
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
</ul>
|
|
3751
|
-
</td>
|
|
3752
|
-
<td> </td>
|
|
3753
|
-
</tr>
|
|
3754
|
-
|
|
3755
|
-
<tr>
|
|
3756
|
-
<td>intoDir</td>
|
|
3757
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
3758
|
-
<td>
|
|
3759
|
-
<ul>
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
|
|
3763
|
-
</ul>
|
|
3764
|
-
</td>
|
|
3765
|
-
<td> </td>
|
|
3766
|
-
</tr>
|
|
3767
|
-
|
|
3768
|
-
<tr>
|
|
3769
|
-
<td>templateVariables</td>
|
|
3770
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3771
|
-
<td>
|
|
3772
|
-
<ul>
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
</ul>
|
|
3777
|
-
</td>
|
|
3778
|
-
<td> </td>
|
|
3779
|
-
</tr>
|
|
3780
|
-
|
|
3781
|
-
</tbody>
|
|
3782
|
-
</table>
|
|
3783
|
-
</div>
|
|
3784
|
-
|
|
3785
|
-
<div class="return">
|
|
3786
|
-
<h4>Return:</h4>
|
|
3787
|
-
<div>
|
|
3788
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
3789
|
-
<span class="return-description"><p>file infos</p>
|
|
3790
|
-
</span>
|
|
3791
|
-
</div>
|
|
3792
|
-
</div>
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
</div>
|
|
3796
|
-
<div class="method item private">
|
|
3797
|
-
<div id="method__getFilesForInstall" class="title">
|
|
3798
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l713"><code>lib/models/blueprint.js:713</code></a></span>
|
|
3799
|
-
<h3 class="">
|
|
3800
|
-
private
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
_getFilesForInstall(targetFiles): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
3804
|
-
</h3>
|
|
3805
|
-
</div>
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
<div class="method-description"></div>
|
|
3810
|
-
|
|
3811
|
-
<div class="params">
|
|
3812
|
-
<h4>Parameters:</h4>
|
|
3813
|
-
<table>
|
|
3814
|
-
<thead>
|
|
3815
|
-
<tr>
|
|
3816
|
-
<th>Name</th>
|
|
3817
|
-
<th>Type</th>
|
|
3818
|
-
<th>Attribute</th>
|
|
3819
|
-
<th>Description</th>
|
|
3820
|
-
</tr>
|
|
3821
|
-
</thead>
|
|
3822
|
-
<tbody>
|
|
3823
|
-
<tr>
|
|
3824
|
-
<td>targetFiles</td>
|
|
3825
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
3826
|
-
<td>
|
|
3827
|
-
<ul>
|
|
3828
|
-
|
|
3829
|
-
|
|
3830
|
-
|
|
3831
|
-
</ul>
|
|
3832
|
-
</td>
|
|
3833
|
-
<td> </td>
|
|
3834
|
-
</tr>
|
|
3835
|
-
|
|
3836
|
-
</tbody>
|
|
3837
|
-
</table>
|
|
3838
|
-
</div>
|
|
3839
|
-
|
|
3840
|
-
<div class="return">
|
|
3841
|
-
<h4>Return:</h4>
|
|
3842
|
-
<div>
|
|
3843
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
3844
|
-
<span class="return-description"><p>files</p>
|
|
3845
|
-
</span>
|
|
3846
|
-
</div>
|
|
3847
|
-
</div>
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
</div>
|
|
3851
|
-
<div class="method item private">
|
|
3852
|
-
<div id="method__ignoreUpdateFiles" class="title">
|
|
3853
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l700"><code>lib/models/blueprint.js:700</code></a></span>
|
|
3854
|
-
<h3 class="">
|
|
3855
|
-
private
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
_ignoreUpdateFiles( )
|
|
3859
|
-
</h3>
|
|
3860
|
-
</div>
|
|
3861
|
-
|
|
3862
|
-
|
|
3863
|
-
|
|
3864
|
-
<div class="method-description"><p>Add update files to ignored files or reset them</p>
|
|
3865
|
-
</div>
|
|
3866
|
-
|
|
3867
|
-
|
|
3868
|
-
|
|
3869
|
-
|
|
3870
|
-
</div>
|
|
3871
|
-
<div class="method item private">
|
|
3872
|
-
<div id="method__locals" class="title">
|
|
3873
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l834"><code>lib/models/blueprint.js:834</code></a></span>
|
|
3874
|
-
<h3 class="">
|
|
3875
|
-
private
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
_locals(options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
|
|
3879
|
-
</h3>
|
|
3880
|
-
</div>
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
<div class="method-description"></div>
|
|
3885
|
-
|
|
3886
|
-
<div class="params">
|
|
3887
|
-
<h4>Parameters:</h4>
|
|
3888
|
-
<table>
|
|
3889
|
-
<thead>
|
|
3890
|
-
<tr>
|
|
3891
|
-
<th>Name</th>
|
|
3892
|
-
<th>Type</th>
|
|
3893
|
-
<th>Attribute</th>
|
|
3894
|
-
<th>Description</th>
|
|
3895
|
-
</tr>
|
|
3896
|
-
</thead>
|
|
3897
|
-
<tbody>
|
|
3898
|
-
<tr>
|
|
3899
|
-
<td>options</td>
|
|
3900
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3901
|
-
<td>
|
|
3902
|
-
<ul>
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
</ul>
|
|
3907
|
-
</td>
|
|
3908
|
-
<td> </td>
|
|
3909
|
-
</tr>
|
|
3910
|
-
|
|
3911
|
-
</tbody>
|
|
3912
|
-
</table>
|
|
3913
|
-
</div>
|
|
3914
|
-
|
|
3915
|
-
<div class="return">
|
|
3916
|
-
<h4>Return:</h4>
|
|
3917
|
-
<div>
|
|
3918
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
|
|
3919
|
-
<span class="return-description"></span>
|
|
3920
|
-
</div>
|
|
3921
|
-
</div>
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
</div>
|
|
3925
|
-
<div class="method item private">
|
|
3926
|
-
<div id="method__normalizeEntityName" class="title">
|
|
3927
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l372"><code>lib/models/blueprint.js:372</code></a></span>
|
|
3928
|
-
<h3 class="">
|
|
3929
|
-
private
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
_normalizeEntityName(entity)
|
|
3933
|
-
</h3>
|
|
3934
|
-
</div>
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
|
|
3938
|
-
<div class="method-description"></div>
|
|
3939
|
-
|
|
3940
|
-
<div class="params">
|
|
3941
|
-
<h4>Parameters:</h4>
|
|
3942
|
-
<table>
|
|
3943
|
-
<thead>
|
|
3944
|
-
<tr>
|
|
3945
|
-
<th>Name</th>
|
|
3946
|
-
<th>Type</th>
|
|
3947
|
-
<th>Attribute</th>
|
|
3948
|
-
<th>Description</th>
|
|
3949
|
-
</tr>
|
|
3950
|
-
</thead>
|
|
3951
|
-
<tbody>
|
|
3952
|
-
<tr>
|
|
3953
|
-
<td>entity</td>
|
|
3954
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
3955
|
-
<td>
|
|
3956
|
-
<ul>
|
|
3957
|
-
|
|
3958
|
-
|
|
3959
|
-
|
|
3960
|
-
</ul>
|
|
3961
|
-
</td>
|
|
3962
|
-
<td> </td>
|
|
3963
|
-
</tr>
|
|
3964
|
-
|
|
3965
|
-
</tbody>
|
|
3966
|
-
</table>
|
|
3967
|
-
</div>
|
|
3968
|
-
|
|
3969
|
-
|
|
3970
|
-
|
|
3971
|
-
</div>
|
|
3972
|
-
<div class="method item private">
|
|
3973
|
-
<div id="method__process" class="title">
|
|
3974
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l412"><code>lib/models/blueprint.js:412</code></a></span>
|
|
3975
|
-
<h3 class="">
|
|
3976
|
-
private
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
_process(options, beforeHook, process, afterHook)
|
|
3980
|
-
</h3>
|
|
3981
|
-
</div>
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
<div class="method-description"></div>
|
|
3986
|
-
|
|
3987
|
-
<div class="params">
|
|
3988
|
-
<h4>Parameters:</h4>
|
|
3989
|
-
<table>
|
|
3990
|
-
<thead>
|
|
3991
|
-
<tr>
|
|
3992
|
-
<th>Name</th>
|
|
3993
|
-
<th>Type</th>
|
|
3994
|
-
<th>Attribute</th>
|
|
3995
|
-
<th>Description</th>
|
|
3996
|
-
</tr>
|
|
3997
|
-
</thead>
|
|
3998
|
-
<tbody>
|
|
3999
|
-
<tr>
|
|
4000
|
-
<td>options</td>
|
|
4001
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
4002
|
-
<td>
|
|
4003
|
-
<ul>
|
|
4004
|
-
|
|
4005
|
-
|
|
4006
|
-
|
|
4007
|
-
</ul>
|
|
4008
|
-
</td>
|
|
4009
|
-
<td> </td>
|
|
4010
|
-
</tr>
|
|
4011
|
-
|
|
4012
|
-
<tr>
|
|
4013
|
-
<td>beforeHook</td>
|
|
4014
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
|
|
4015
|
-
<td>
|
|
4016
|
-
<ul>
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4020
|
-
</ul>
|
|
4021
|
-
</td>
|
|
4022
|
-
<td> </td>
|
|
4023
|
-
</tr>
|
|
4024
|
-
|
|
4025
|
-
<tr>
|
|
4026
|
-
<td>process</td>
|
|
4027
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
|
|
4028
|
-
<td>
|
|
4029
|
-
<ul>
|
|
4030
|
-
|
|
4031
|
-
|
|
4032
|
-
|
|
4033
|
-
</ul>
|
|
4034
|
-
</td>
|
|
4035
|
-
<td> </td>
|
|
4036
|
-
</tr>
|
|
4037
|
-
|
|
4038
|
-
<tr>
|
|
4039
|
-
<td>afterHook</td>
|
|
4040
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
|
|
4041
|
-
<td>
|
|
4042
|
-
<ul>
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
</ul>
|
|
4047
|
-
</td>
|
|
4048
|
-
<td> </td>
|
|
4049
|
-
</tr>
|
|
4050
|
-
|
|
4051
|
-
</tbody>
|
|
4052
|
-
</table>
|
|
4053
|
-
</div>
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
|
-
|
|
4057
|
-
</div>
|
|
4058
|
-
<div class="method item private">
|
|
4059
|
-
<div id="method__writeFile" class="title">
|
|
4060
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l287"><code>lib/models/blueprint.js:287</code></a></span>
|
|
4061
|
-
<h3 class="">
|
|
4062
|
-
private
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
_writeFile(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
4066
|
-
</h3>
|
|
4067
|
-
</div>
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
<div class="method-description"></div>
|
|
4072
|
-
|
|
4073
|
-
<div class="params">
|
|
4074
|
-
<h4>Parameters:</h4>
|
|
4075
|
-
<table>
|
|
4076
|
-
<thead>
|
|
4077
|
-
<tr>
|
|
4078
|
-
<th>Name</th>
|
|
4079
|
-
<th>Type</th>
|
|
4080
|
-
<th>Attribute</th>
|
|
4081
|
-
<th>Description</th>
|
|
4082
|
-
</tr>
|
|
4083
|
-
</thead>
|
|
4084
|
-
<tbody>
|
|
4085
|
-
<tr>
|
|
4086
|
-
<td>info</td>
|
|
4087
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
4088
|
-
<td>
|
|
4089
|
-
<ul>
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
</ul>
|
|
4094
|
-
</td>
|
|
4095
|
-
<td> </td>
|
|
4096
|
-
</tr>
|
|
4097
|
-
|
|
4098
|
-
</tbody>
|
|
4099
|
-
</table>
|
|
4100
|
-
</div>
|
|
4101
|
-
|
|
4102
|
-
<div class="return">
|
|
4103
|
-
<h4>Return:</h4>
|
|
4104
|
-
<div>
|
|
4105
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
4106
|
-
<span class="return-description"></span>
|
|
4107
|
-
</div>
|
|
4108
|
-
</div>
|
|
4109
|
-
|
|
4110
|
-
|
|
4111
|
-
</div>
|
|
4112
|
-
<div class="method item private">
|
|
4113
|
-
<div id="method__writeStatusToUI" class="title">
|
|
4114
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l273"><code>lib/models/blueprint.js:273</code></a></span>
|
|
4115
|
-
<h3 class="">
|
|
4116
|
-
private
|
|
4117
|
-
|
|
4118
|
-
|
|
4119
|
-
_writeStatusToUI(chalkColor, keyword, message)
|
|
4120
|
-
</h3>
|
|
4121
|
-
</div>
|
|
4122
|
-
|
|
4123
|
-
|
|
4124
|
-
|
|
4125
|
-
<div class="method-description"><p>Write a status and message to the UI</p>
|
|
4126
|
-
</div>
|
|
4127
|
-
|
|
4128
|
-
<div class="params">
|
|
4129
|
-
<h4>Parameters:</h4>
|
|
4130
|
-
<table>
|
|
4131
|
-
<thead>
|
|
4132
|
-
<tr>
|
|
4133
|
-
<th>Name</th>
|
|
4134
|
-
<th>Type</th>
|
|
4135
|
-
<th>Attribute</th>
|
|
4136
|
-
<th>Description</th>
|
|
4137
|
-
</tr>
|
|
4138
|
-
</thead>
|
|
4139
|
-
<tbody>
|
|
4140
|
-
<tr>
|
|
4141
|
-
<td>chalkColor</td>
|
|
4142
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
|
|
4143
|
-
<td>
|
|
4144
|
-
<ul>
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
</ul>
|
|
4149
|
-
</td>
|
|
4150
|
-
<td> </td>
|
|
4151
|
-
</tr>
|
|
4152
|
-
|
|
4153
|
-
<tr>
|
|
4154
|
-
<td>keyword</td>
|
|
4155
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
4156
|
-
<td>
|
|
4157
|
-
<ul>
|
|
4158
|
-
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
</ul>
|
|
4162
|
-
</td>
|
|
4163
|
-
<td> </td>
|
|
4164
|
-
</tr>
|
|
4165
|
-
|
|
4166
|
-
<tr>
|
|
4167
|
-
<td>message</td>
|
|
4168
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
4169
|
-
<td>
|
|
4170
|
-
<ul>
|
|
4171
|
-
|
|
4172
|
-
|
|
4173
|
-
|
|
4174
|
-
</ul>
|
|
4175
|
-
</td>
|
|
4176
|
-
<td> </td>
|
|
4177
|
-
</tr>
|
|
4178
|
-
|
|
4179
|
-
</tbody>
|
|
4180
|
-
</table>
|
|
4181
|
-
</div>
|
|
4182
|
-
|
|
4183
|
-
|
|
4184
|
-
|
|
4185
|
-
</div>
|
|
4186
|
-
<div class="method item private">
|
|
4187
|
-
<div id="method_dir" class="title">
|
|
4188
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1546"><code>lib/models/blueprint.js:1546</code></a></span>
|
|
4189
|
-
<h3 class="">
|
|
4190
|
-
private
|
|
4191
|
-
|
|
4192
|
-
|
|
4193
|
-
dir( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
4194
|
-
</h3>
|
|
4195
|
-
</div>
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
<div class="method-description"></div>
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
<div class="return">
|
|
4203
|
-
<h4>Return:</h4>
|
|
4204
|
-
<div>
|
|
4205
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
4206
|
-
<span class="return-description"><p>list of files in the given directory or and empty array if no directory exists</p>
|
|
4207
|
-
</span>
|
|
4208
|
-
</div>
|
|
4209
|
-
</div>
|
|
4210
|
-
|
|
4211
|
-
|
|
4212
|
-
</div>
|
|
4213
|
-
<div class="method item private">
|
|
4214
|
-
<div id="method_gatherConfirmationMessages" class="title">
|
|
4215
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1442"><code>lib/models/blueprint.js:1442</code></a></span>
|
|
4216
|
-
<h3 class="">
|
|
4217
|
-
private
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
gatherConfirmationMessages(collection, info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
4221
|
-
</h3>
|
|
4222
|
-
</div>
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
<div class="method-description"></div>
|
|
4227
|
-
|
|
4228
|
-
<div class="params">
|
|
4229
|
-
<h4>Parameters:</h4>
|
|
4230
|
-
<table>
|
|
4231
|
-
<thead>
|
|
4232
|
-
<tr>
|
|
4233
|
-
<th>Name</th>
|
|
4234
|
-
<th>Type</th>
|
|
4235
|
-
<th>Attribute</th>
|
|
4236
|
-
<th>Description</th>
|
|
4237
|
-
</tr>
|
|
4238
|
-
</thead>
|
|
4239
|
-
<tbody>
|
|
4240
|
-
<tr>
|
|
4241
|
-
<td>collection</td>
|
|
4242
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
4243
|
-
<td>
|
|
4244
|
-
<ul>
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
</ul>
|
|
4249
|
-
</td>
|
|
4250
|
-
<td> </td>
|
|
4251
|
-
</tr>
|
|
4252
|
-
|
|
4253
|
-
<tr>
|
|
4254
|
-
<td>info</td>
|
|
4255
|
-
<td>FileInfo</td>
|
|
4256
|
-
<td>
|
|
4257
|
-
<ul>
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
</ul>
|
|
4262
|
-
</td>
|
|
4263
|
-
<td> </td>
|
|
4264
|
-
</tr>
|
|
4265
|
-
|
|
4266
|
-
</tbody>
|
|
4267
|
-
</table>
|
|
4268
|
-
</div>
|
|
4269
|
-
|
|
4270
|
-
<div class="return">
|
|
4271
|
-
<h4>Return:</h4>
|
|
4272
|
-
<div>
|
|
4273
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
4274
|
-
<span class="return-description"></span>
|
|
4275
|
-
</div>
|
|
4276
|
-
</div>
|
|
4277
|
-
|
|
4278
|
-
|
|
4279
|
-
</div>
|
|
4280
|
-
<div class="method item private">
|
|
4281
|
-
<div id="method_generateLookupPaths" class="title">
|
|
4282
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1468"><code>lib/models/blueprint.js:1468</code></a></span>
|
|
4283
|
-
<h3 class="">
|
|
4284
|
-
private
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
generateLookupPaths(lookupPaths): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a>
|
|
4288
|
-
</h3>
|
|
4289
|
-
</div>
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
<div class="method-description"><p>Combines provided lookup paths with defaults and removes
|
|
4294
|
-
duplicates.</p>
|
|
4295
|
-
</div>
|
|
4296
|
-
|
|
4297
|
-
<div class="params">
|
|
4298
|
-
<h4>Parameters:</h4>
|
|
4299
|
-
<table>
|
|
4300
|
-
<thead>
|
|
4301
|
-
<tr>
|
|
4302
|
-
<th>Name</th>
|
|
4303
|
-
<th>Type</th>
|
|
4304
|
-
<th>Attribute</th>
|
|
4305
|
-
<th>Description</th>
|
|
4306
|
-
</tr>
|
|
4307
|
-
</thead>
|
|
4308
|
-
<tbody>
|
|
4309
|
-
<tr>
|
|
4310
|
-
<td>lookupPaths</td>
|
|
4311
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></td>
|
|
4312
|
-
<td>
|
|
4313
|
-
<ul>
|
|
4314
|
-
|
|
4315
|
-
|
|
4316
|
-
|
|
4317
|
-
</ul>
|
|
4318
|
-
</td>
|
|
4319
|
-
<td> </td>
|
|
4320
|
-
</tr>
|
|
4321
|
-
|
|
4322
|
-
</tbody>
|
|
4323
|
-
</table>
|
|
4324
|
-
</div>
|
|
4325
|
-
|
|
4326
|
-
<div class="return">
|
|
4327
|
-
<h4>Return:</h4>
|
|
4328
|
-
<div>
|
|
4329
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
4330
|
-
<span class="return-description"></span>
|
|
4331
|
-
</div>
|
|
4332
|
-
</div>
|
|
4333
|
-
|
|
4334
|
-
|
|
4335
|
-
</div>
|
|
4336
|
-
<div class="method item private">
|
|
4337
|
-
<div id="method_getDetailedHelpPath" class="title">
|
|
4338
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1559"><code>lib/models/blueprint.js:1559</code></a></span>
|
|
4339
|
-
<h3 class="">
|
|
4340
|
-
private
|
|
4341
|
-
|
|
4342
|
-
|
|
4343
|
-
getDetailedHelpPath(thisPath): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
|
|
4344
|
-
</h3>
|
|
4345
|
-
</div>
|
|
4346
|
-
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
<div class="method-description"></div>
|
|
4350
|
-
|
|
4351
|
-
<div class="params">
|
|
4352
|
-
<h4>Parameters:</h4>
|
|
4353
|
-
<table>
|
|
4354
|
-
<thead>
|
|
4355
|
-
<tr>
|
|
4356
|
-
<th>Name</th>
|
|
4357
|
-
<th>Type</th>
|
|
4358
|
-
<th>Attribute</th>
|
|
4359
|
-
<th>Description</th>
|
|
4360
|
-
</tr>
|
|
4361
|
-
</thead>
|
|
4362
|
-
<tbody>
|
|
4363
|
-
<tr>
|
|
4364
|
-
<td>thisPath</td>
|
|
4365
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
|
|
4366
|
-
<td>
|
|
4367
|
-
<ul>
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
</ul>
|
|
4372
|
-
</td>
|
|
4373
|
-
<td> </td>
|
|
4374
|
-
</tr>
|
|
4375
|
-
|
|
4376
|
-
</tbody>
|
|
4377
|
-
</table>
|
|
4378
|
-
</div>
|
|
4379
|
-
|
|
4380
|
-
<div class="return">
|
|
4381
|
-
<h4>Return:</h4>
|
|
4382
|
-
<div>
|
|
4383
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
4384
|
-
<span class="return-description"><p>help path</p>
|
|
4385
|
-
</span>
|
|
4386
|
-
</div>
|
|
4387
|
-
</div>
|
|
4388
|
-
|
|
4389
|
-
|
|
4390
|
-
</div>
|
|
4391
|
-
<div class="method item private">
|
|
4392
|
-
<div id="method_hasPathToken" class="title">
|
|
4393
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1483"><code>lib/models/blueprint.js:1483</code></a></span>
|
|
4394
|
-
<h3 class="">
|
|
4395
|
-
private
|
|
4396
|
-
|
|
4397
|
-
|
|
4398
|
-
hasPathToken(files): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
4399
|
-
</h3>
|
|
4400
|
-
</div>
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
4404
|
-
<div class="method-description"><p>Looks for a <strong>path</strong> token in the files folder. Must be present for
|
|
4405
|
-
the blueprint to support pod tokens.</p>
|
|
4406
|
-
</div>
|
|
4407
|
-
|
|
4408
|
-
<div class="params">
|
|
4409
|
-
<h4>Parameters:</h4>
|
|
4410
|
-
<table>
|
|
4411
|
-
<thead>
|
|
4412
|
-
<tr>
|
|
4413
|
-
<th>Name</th>
|
|
4414
|
-
<th>Type</th>
|
|
4415
|
-
<th>Attribute</th>
|
|
4416
|
-
<th>Description</th>
|
|
4417
|
-
</tr>
|
|
4418
|
-
</thead>
|
|
4419
|
-
<tbody>
|
|
4420
|
-
<tr>
|
|
4421
|
-
<td>files</td>
|
|
4422
|
-
<td>Files</td>
|
|
4423
|
-
<td>
|
|
4424
|
-
<ul>
|
|
4425
|
-
|
|
4426
|
-
|
|
4427
|
-
|
|
4428
|
-
</ul>
|
|
4429
|
-
</td>
|
|
4430
|
-
<td> </td>
|
|
4431
|
-
</tr>
|
|
4432
|
-
|
|
4433
|
-
</tbody>
|
|
4434
|
-
</table>
|
|
4435
|
-
</div>
|
|
4436
|
-
|
|
4437
|
-
<div class="return">
|
|
4438
|
-
<h4>Return:</h4>
|
|
4439
|
-
<div>
|
|
4440
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
|
|
4441
|
-
<span class="return-description"></span>
|
|
4442
|
-
</div>
|
|
4443
|
-
</div>
|
|
4444
|
-
|
|
4445
|
-
|
|
4446
|
-
</div>
|
|
4447
|
-
<div class="method item private">
|
|
4448
|
-
<div id="method_isFilePath" class="title">
|
|
4449
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1536"><code>lib/models/blueprint.js:1536</code></a></span>
|
|
4450
|
-
<h3 class="">
|
|
4451
|
-
private
|
|
4452
|
-
|
|
4453
|
-
|
|
4454
|
-
isFilePath(fileInfo): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
4455
|
-
</h3>
|
|
4456
|
-
</div>
|
|
4457
|
-
|
|
4458
|
-
|
|
4459
|
-
|
|
4460
|
-
<div class="method-description"></div>
|
|
4461
|
-
|
|
4462
|
-
<div class="params">
|
|
4463
|
-
<h4>Parameters:</h4>
|
|
4464
|
-
<table>
|
|
4465
|
-
<thead>
|
|
4466
|
-
<tr>
|
|
4467
|
-
<th>Name</th>
|
|
4468
|
-
<th>Type</th>
|
|
4469
|
-
<th>Attribute</th>
|
|
4470
|
-
<th>Description</th>
|
|
4471
|
-
</tr>
|
|
4472
|
-
</thead>
|
|
4473
|
-
<tbody>
|
|
4474
|
-
<tr>
|
|
4475
|
-
<td>fileInfo</td>
|
|
4476
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
4477
|
-
<td>
|
|
4478
|
-
<ul>
|
|
4479
|
-
|
|
4480
|
-
|
|
4481
|
-
|
|
4482
|
-
</ul>
|
|
4483
|
-
</td>
|
|
4484
|
-
<td> </td>
|
|
4485
|
-
</tr>
|
|
4486
|
-
|
|
4487
|
-
</tbody>
|
|
4488
|
-
</table>
|
|
4489
|
-
</div>
|
|
4490
|
-
|
|
4491
|
-
<div class="return">
|
|
4492
|
-
<h4>Return:</h4>
|
|
4493
|
-
<div>
|
|
4494
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
4495
|
-
<span class="return-description"></span>
|
|
4496
|
-
</div>
|
|
4497
|
-
</div>
|
|
4498
|
-
|
|
4499
|
-
|
|
4500
|
-
</div>
|
|
4501
|
-
<div class="method item private">
|
|
4502
|
-
<div id="method_isIgnored" class="title">
|
|
4503
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1456"><code>lib/models/blueprint.js:1456</code></a></span>
|
|
4504
|
-
<h3 class="">
|
|
4505
|
-
private
|
|
4506
|
-
|
|
4507
|
-
|
|
4508
|
-
isIgnored(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
4509
|
-
</h3>
|
|
4510
|
-
</div>
|
|
4511
|
-
|
|
4512
|
-
|
|
4513
|
-
|
|
4514
|
-
<div class="method-description"></div>
|
|
4515
|
-
|
|
4516
|
-
<div class="params">
|
|
4517
|
-
<h4>Parameters:</h4>
|
|
4518
|
-
<table>
|
|
4519
|
-
<thead>
|
|
4520
|
-
<tr>
|
|
4521
|
-
<th>Name</th>
|
|
4522
|
-
<th>Type</th>
|
|
4523
|
-
<th>Attribute</th>
|
|
4524
|
-
<th>Description</th>
|
|
4525
|
-
</tr>
|
|
4526
|
-
</thead>
|
|
4527
|
-
<tbody>
|
|
4528
|
-
<tr>
|
|
4529
|
-
<td>info</td>
|
|
4530
|
-
<td>FileInfo</td>
|
|
4531
|
-
<td>
|
|
4532
|
-
<ul>
|
|
4533
|
-
|
|
4534
|
-
|
|
4535
|
-
|
|
4536
|
-
</ul>
|
|
4537
|
-
</td>
|
|
4538
|
-
<td> </td>
|
|
4539
|
-
</tr>
|
|
4540
|
-
|
|
4541
|
-
</tbody>
|
|
4542
|
-
</table>
|
|
4543
|
-
</div>
|
|
4544
|
-
|
|
4545
|
-
<div class="return">
|
|
4546
|
-
<h4>Return:</h4>
|
|
4547
|
-
<div>
|
|
4548
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
|
|
4549
|
-
<span class="return-description"></span>
|
|
4550
|
-
</div>
|
|
4551
|
-
</div>
|
|
4552
|
-
|
|
4553
|
-
|
|
4554
|
-
</div>
|
|
4555
|
-
<div class="method item private">
|
|
4556
|
-
<div id="method_isValidFile" class="title">
|
|
4557
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1522"><code>lib/models/blueprint.js:1522</code></a></span>
|
|
4558
|
-
<h3 class="">
|
|
4559
|
-
private
|
|
4560
|
-
|
|
4561
|
-
|
|
4562
|
-
isValidFile(fileInfo): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
4563
|
-
</h3>
|
|
4564
|
-
</div>
|
|
4565
|
-
|
|
4566
|
-
|
|
4567
|
-
|
|
4568
|
-
<div class="method-description"></div>
|
|
4569
|
-
|
|
4570
|
-
<div class="params">
|
|
4571
|
-
<h4>Parameters:</h4>
|
|
4572
|
-
<table>
|
|
4573
|
-
<thead>
|
|
4574
|
-
<tr>
|
|
4575
|
-
<th>Name</th>
|
|
4576
|
-
<th>Type</th>
|
|
4577
|
-
<th>Attribute</th>
|
|
4578
|
-
<th>Description</th>
|
|
4579
|
-
</tr>
|
|
4580
|
-
</thead>
|
|
4581
|
-
<tbody>
|
|
4582
|
-
<tr>
|
|
4583
|
-
<td>fileInfo</td>
|
|
4584
|
-
<td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
|
|
4585
|
-
<td>
|
|
4586
|
-
<ul>
|
|
4587
|
-
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
</ul>
|
|
4591
|
-
</td>
|
|
4592
|
-
<td> </td>
|
|
4593
|
-
</tr>
|
|
4594
|
-
|
|
4595
|
-
</tbody>
|
|
4596
|
-
</table>
|
|
4597
|
-
</div>
|
|
4598
|
-
|
|
4599
|
-
<div class="return">
|
|
4600
|
-
<h4>Return:</h4>
|
|
4601
|
-
<div>
|
|
4602
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
4603
|
-
<span class="return-description"></span>
|
|
4604
|
-
</div>
|
|
4605
|
-
</div>
|
|
4606
|
-
|
|
4607
|
-
|
|
4608
|
-
</div>
|
|
4609
|
-
<div class="method item private">
|
|
4610
|
-
<div id="method_markIdenticalToBeSkipped" class="title">
|
|
4611
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1422"><code>lib/models/blueprint.js:1422</code></a></span>
|
|
4612
|
-
<h3 class="">
|
|
4613
|
-
private
|
|
4614
|
-
|
|
4615
|
-
|
|
4616
|
-
markIdenticalToBeSkipped(info)
|
|
4617
|
-
</h3>
|
|
4618
|
-
</div>
|
|
4619
|
-
|
|
4620
|
-
|
|
4621
|
-
|
|
4622
|
-
<div class="method-description"></div>
|
|
4623
|
-
|
|
4624
|
-
<div class="params">
|
|
4625
|
-
<h4>Parameters:</h4>
|
|
4626
|
-
<table>
|
|
4627
|
-
<thead>
|
|
4628
|
-
<tr>
|
|
4629
|
-
<th>Name</th>
|
|
4630
|
-
<th>Type</th>
|
|
4631
|
-
<th>Attribute</th>
|
|
4632
|
-
<th>Description</th>
|
|
4633
|
-
</tr>
|
|
4634
|
-
</thead>
|
|
4635
|
-
<tbody>
|
|
4636
|
-
<tr>
|
|
4637
|
-
<td>info</td>
|
|
4638
|
-
<td>FileInfo</td>
|
|
4639
|
-
<td>
|
|
4640
|
-
<ul>
|
|
4641
|
-
|
|
4642
|
-
|
|
4643
|
-
|
|
4644
|
-
</ul>
|
|
4645
|
-
</td>
|
|
4646
|
-
<td> </td>
|
|
4647
|
-
</tr>
|
|
4648
|
-
|
|
4649
|
-
</tbody>
|
|
4650
|
-
</table>
|
|
4651
|
-
</div>
|
|
4652
|
-
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
</div>
|
|
4656
|
-
<div class="method item private">
|
|
4657
|
-
<div id="method_markToBeRemoved" class="title">
|
|
4658
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1433"><code>lib/models/blueprint.js:1433</code></a></span>
|
|
4659
|
-
<h3 class="">
|
|
4660
|
-
private
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
markToBeRemoved(info)
|
|
4664
|
-
</h3>
|
|
4665
|
-
</div>
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
<div class="method-description"></div>
|
|
4670
|
-
|
|
4671
|
-
<div class="params">
|
|
4672
|
-
<h4>Parameters:</h4>
|
|
4673
|
-
<table>
|
|
4674
|
-
<thead>
|
|
4675
|
-
<tr>
|
|
4676
|
-
<th>Name</th>
|
|
4677
|
-
<th>Type</th>
|
|
4678
|
-
<th>Attribute</th>
|
|
4679
|
-
<th>Description</th>
|
|
4680
|
-
</tr>
|
|
4681
|
-
</thead>
|
|
4682
|
-
<tbody>
|
|
4683
|
-
<tr>
|
|
4684
|
-
<td>info</td>
|
|
4685
|
-
<td>FileInfo</td>
|
|
4686
|
-
<td>
|
|
4687
|
-
<ul>
|
|
4688
|
-
|
|
4689
|
-
|
|
4690
|
-
|
|
4691
|
-
</ul>
|
|
4692
|
-
</td>
|
|
4693
|
-
<td> </td>
|
|
4694
|
-
</tr>
|
|
4695
|
-
|
|
4696
|
-
</tbody>
|
|
4697
|
-
</table>
|
|
4698
|
-
</div>
|
|
4699
|
-
|
|
4700
|
-
|
|
4701
|
-
|
|
4702
|
-
</div>
|
|
4703
|
-
<div class="method item private">
|
|
4704
|
-
<div id="method_prepareConfirm" class="title">
|
|
4705
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l1409"><code>lib/models/blueprint.js:1409</code></a></span>
|
|
4706
|
-
<h3 class="">
|
|
4707
|
-
private
|
|
4708
|
-
|
|
4709
|
-
|
|
4710
|
-
prepareConfirm(info): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
|
|
4711
|
-
</h3>
|
|
4712
|
-
</div>
|
|
4713
|
-
|
|
4714
|
-
|
|
4715
|
-
|
|
4716
|
-
<div class="method-description"></div>
|
|
4717
|
-
|
|
4718
|
-
<div class="params">
|
|
4719
|
-
<h4>Parameters:</h4>
|
|
4720
|
-
<table>
|
|
4721
|
-
<thead>
|
|
4722
|
-
<tr>
|
|
4723
|
-
<th>Name</th>
|
|
4724
|
-
<th>Type</th>
|
|
4725
|
-
<th>Attribute</th>
|
|
4726
|
-
<th>Description</th>
|
|
4727
|
-
</tr>
|
|
4728
|
-
</thead>
|
|
4729
|
-
<tbody>
|
|
4730
|
-
<tr>
|
|
4731
|
-
<td>info</td>
|
|
4732
|
-
<td>FileInfo</td>
|
|
4733
|
-
<td>
|
|
4734
|
-
<ul>
|
|
4735
|
-
|
|
4736
|
-
|
|
4737
|
-
|
|
4738
|
-
</ul>
|
|
4739
|
-
</td>
|
|
4740
|
-
<td> </td>
|
|
4741
|
-
</tr>
|
|
4742
|
-
|
|
4743
|
-
</tbody>
|
|
4744
|
-
</table>
|
|
4745
|
-
</div>
|
|
4746
|
-
|
|
4747
|
-
<div class="return">
|
|
4748
|
-
<h4>Return:</h4>
|
|
4749
|
-
<div>
|
|
4750
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
|
|
4751
|
-
<span class="return-description"></span>
|
|
4752
|
-
</div>
|
|
4753
|
-
</div>
|
|
4754
|
-
|
|
4755
|
-
|
|
4756
|
-
</div>
|
|
4757
|
-
<div class="method item private">
|
|
4758
|
-
<div id="method_supportsAddon" class="title">
|
|
4759
|
-
<span class="source-link"><a href="../files/lib_models_blueprint.js.html#l792"><code>lib/models/blueprint.js:792</code></a></span>
|
|
4760
|
-
<h3 class="">
|
|
4761
|
-
private
|
|
4762
|
-
|
|
4763
|
-
|
|
4764
|
-
supportsAddon( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
|
|
4765
|
-
</h3>
|
|
4766
|
-
</div>
|
|
4767
|
-
|
|
4768
|
-
|
|
4769
|
-
|
|
4770
|
-
<div class="method-description"><p>Looks for a <strong>root</strong> token in the files folder. Must be present for
|
|
4771
|
-
the blueprint to support addon tokens. The <code>server</code>, <code>blueprints</code>, and <code>test</code></p>
|
|
4772
|
-
</div>
|
|
4773
|
-
|
|
4774
|
-
|
|
4775
|
-
<div class="return">
|
|
4776
|
-
<h4>Return:</h4>
|
|
4777
|
-
<div>
|
|
4778
|
-
<span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
|
|
4779
|
-
<span class="return-description"></span>
|
|
4780
|
-
</div>
|
|
4781
|
-
</div>
|
|
4782
|
-
|
|
4783
|
-
|
|
4784
|
-
</div>
|
|
4785
|
-
</div>
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
</div>
|
|
4789
|
-
</div>
|
|
4790
|
-
</div>
|
|
4791
|
-
</div>
|
|
4792
|
-
<script src="../assets/vendor/prettify/prettify-min.js"></script>
|
|
4793
|
-
<script>prettyPrint();</script>
|
|
4794
|
-
<script src="../assets/js/yui-prettify.js"></script>
|
|
4795
|
-
</body>
|
|
4796
|
-
</html>
|