Skip to content

Commit cd2c4ab

Browse files
haoqunjianghaoqunjiang
authored
refactor: use ejs templates for vite.config.* (vuejs#292)
The base template has a `vite.config.js.ejs` template file, which reads data from a corresponding `vite.config.js.data.mjs` file. The data file has a default export called `getData()`. Other templates can also have data files that can be chained together so that they can modify the data fed into the template. They don't have to define the template again, though. This fixes the issue mentioned in vuejs#257 (comment) As we don't support plugins or extensions for this tool, I didn't choose to design the feature in an extensible way, but only considered ease of implementation and ease of modification.
1 parent 3aa4161 commit cd2c4ab

13 files changed

+331
-59
lines changed

Diff for: ‎LICENSE

+211-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ SOFTWARE.
2727
## Licenses of bundled dependencies
2828

2929
The published create-vue artifact additionally contains code with the following licenses:
30-
MIT
30+
MIT, Apache-2.0
3131

3232
## Bundled dependencies
3333

@@ -60,6 +60,216 @@ Repository: git+https://github.com/vuejs/create-eslint-config.git
6060
> SOFTWARE.
6161
>
6262

63+
## ejs
64+
65+
License: Apache-2.0
66+
By: Matthew Eernisse
67+
Repository: git://github.com/mde/ejs.git
68+
69+
>
70+
> Apache License
71+
> Version 2.0, January 2004
72+
> http://www.apache.org/licenses/
73+
>
74+
> TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
75+
>
76+
> 1. Definitions.
77+
>
78+
> "License" shall mean the terms and conditions for use, reproduction,
79+
> and distribution as defined by Sections 1 through 9 of this document.
80+
>
81+
> "Licensor" shall mean the copyright owner or entity authorized by
82+
> the copyright owner that is granting the License.
83+
>
84+
> "Legal Entity" shall mean the union of the acting entity and all
85+
> other entities that control, are controlled by, or are under common
86+
> control with that entity. For the purposes of this definition,
87+
> "control" means (i) the power, direct or indirect, to cause the
88+
> direction or management of such entity, whether by contract or
89+
> otherwise, or (ii) ownership of fifty percent (50%) or more of the
90+
> outstanding shares, or (iii) beneficial ownership of such entity.
91+
>
92+
> "You" (or "Your") shall mean an individual or Legal Entity
93+
> exercising permissions granted by this License.
94+
>
95+
> "Source" form shall mean the preferred form for making modifications,
96+
> including but not limited to software source code, documentation
97+
> source, and configuration files.
98+
>
99+
> "Object" form shall mean any form resulting from mechanical
100+
> transformation or translation of a Source form, including but
101+
> not limited to compiled object code, generated documentation,
102+
> and conversions to other media types.
103+
>
104+
> "Work" shall mean the work of authorship, whether in Source or
105+
> Object form, made available under the License, as indicated by a
106+
> copyright notice that is included in or attached to the work
107+
> (an example is provided in the Appendix below).
108+
>
109+
> "Derivative Works" shall mean any work, whether in Source or Object
110+
> form, that is based on (or derived from) the Work and for which the
111+
> editorial revisions, annotations, elaborations, or other modifications
112+
> represent, as a whole, an original work of authorship. For the purposes
113+
> of this License, Derivative Works shall not include works that remain
114+
> separable from, or merely link (or bind by name) to the interfaces of,
115+
> the Work and Derivative Works thereof.
116+
>
117+
> "Contribution" shall mean any work of authorship, including
118+
> the original version of the Work and any modifications or additions
119+
> to that Work or Derivative Works thereof, that is intentionally
120+
> submitted to Licensor for inclusion in the Work by the copyright owner
121+
> or by an individual or Legal Entity authorized to submit on behalf of
122+
> the copyright owner. For the purposes of this definition, "submitted"
123+
> means any form of electronic, verbal, or written communication sent
124+
> to the Licensor or its representatives, including but not limited to
125+
> communication on electronic mailing lists, source code control systems,
126+
> and issue tracking systems that are managed by, or on behalf of, the
127+
> Licensor for the purpose of discussing and improving the Work, but
128+
> excluding communication that is conspicuously marked or otherwise
129+
> designated in writing by the copyright owner as "Not a Contribution."
130+
>
131+
> "Contributor" shall mean Licensor and any individual or Legal Entity
132+
> on behalf of whom a Contribution has been received by Licensor and
133+
> subsequently incorporated within the Work.
134+
>
135+
> 2. Grant of Copyright License. Subject to the terms and conditions of
136+
> this License, each Contributor hereby grants to You a perpetual,
137+
> worldwide, non-exclusive, no-charge, royalty-free, irrevocable
138+
> copyright license to reproduce, prepare Derivative Works of,
139+
> publicly display, publicly perform, sublicense, and distribute the
140+
> Work and such Derivative Works in Source or Object form.
141+
>
142+
> 3. Grant of Patent License. Subject to the terms and conditions of
143+
> this License, each Contributor hereby grants to You a perpetual,
144+
> worldwide, non-exclusive, no-charge, royalty-free, irrevocable
145+
> (except as stated in this section) patent license to make, have made,
146+
> use, offer to sell, sell, import, and otherwise transfer the Work,
147+
> where such license applies only to those patent claims licensable
148+
> by such Contributor that are necessarily infringed by their
149+
> Contribution(s) alone or by combination of their Contribution(s)
150+
> with the Work to which such Contribution(s) was submitted. If You
151+
> institute patent litigation against any entity (including a
152+
> cross-claim or counterclaim in a lawsuit) alleging that the Work
153+
> or a Contribution incorporated within the Work constitutes direct
154+
> or contributory patent infringement, then any patent licenses
155+
> granted to You under this License for that Work shall terminate
156+
> as of the date such litigation is filed.
157+
>
158+
> 4. Redistribution. You may reproduce and distribute copies of the
159+
> Work or Derivative Works thereof in any medium, with or without
160+
> modifications, and in Source or Object form, provided that You
161+
> meet the following conditions:
162+
>
163+
> (a) You must give any other recipients of the Work or
164+
> Derivative Works a copy of this License; and
165+
>
166+
> (b) You must cause any modified files to carry prominent notices
167+
> stating that You changed the files; and
168+
>
169+
> (c) You must retain, in the Source form of any Derivative Works
170+
> that You distribute, all copyright, patent, trademark, and
171+
> attribution notices from the Source form of the Work,
172+
> excluding those notices that do not pertain to any part of
173+
> the Derivative Works; and
174+
>
175+
> (d) If the Work includes a "NOTICE" text file as part of its
176+
> distribution, then any Derivative Works that You distribute must
177+
> include a readable copy of the attribution notices contained
178+
> within such NOTICE file, excluding those notices that do not
179+
> pertain to any part of the Derivative Works, in at least one
180+
> of the following places: within a NOTICE text file distributed
181+
> as part of the Derivative Works; within the Source form or
182+
> documentation, if provided along with the Derivative Works; or,
183+
> within a display generated by the Derivative Works, if and
184+
> wherever such third-party notices normally appear. The contents
185+
> of the NOTICE file are for informational purposes only and
186+
> do not modify the License. You may add Your own attribution
187+
> notices within Derivative Works that You distribute, alongside
188+
> or as an addendum to the NOTICE text from the Work, provided
189+
> that such additional attribution notices cannot be construed
190+
> as modifying the License.
191+
>
192+
> You may add Your own copyright statement to Your modifications and
193+
> may provide additional or different license terms and conditions
194+
> for use, reproduction, or distribution of Your modifications, or
195+
> for any such Derivative Works as a whole, provided Your use,
196+
> reproduction, and distribution of the Work otherwise complies with
197+
> the conditions stated in this License.
198+
>
199+
> 5. Submission of Contributions. Unless You explicitly state otherwise,
200+
> any Contribution intentionally submitted for inclusion in the Work
201+
> by You to the Licensor shall be under the terms and conditions of
202+
> this License, without any additional terms or conditions.
203+
> Notwithstanding the above, nothing herein shall supersede or modify
204+
> the terms of any separate license agreement you may have executed
205+
> with Licensor regarding such Contributions.
206+
>
207+
> 6. Trademarks. This License does not grant permission to use the trade
208+
> names, trademarks, service marks, or product names of the Licensor,
209+
> except as required for reasonable and customary use in describing the
210+
> origin of the Work and reproducing the content of the NOTICE file.
211+
>
212+
> 7. Disclaimer of Warranty. Unless required by applicable law or
213+
> agreed to in writing, Licensor provides the Work (and each
214+
> Contributor provides its Contributions) on an "AS IS" BASIS,
215+
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
216+
> implied, including, without limitation, any warranties or conditions
217+
> of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
218+
> PARTICULAR PURPOSE. You are solely responsible for determining the
219+
> appropriateness of using or redistributing the Work and assume any
220+
> risks associated with Your exercise of permissions under this License.
221+
>
222+
> 8. Limitation of Liability. In no event and under no legal theory,
223+
> whether in tort (including negligence), contract, or otherwise,
224+
> unless required by applicable law (such as deliberate and grossly
225+
> negligent acts) or agreed to in writing, shall any Contributor be
226+
> liable to You for damages, including any direct, indirect, special,
227+
> incidental, or consequential damages of any character arising as a
228+
> result of this License or out of the use or inability to use the
229+
> Work (including but not limited to damages for loss of goodwill,
230+
> work stoppage, computer failure or malfunction, or any and all
231+
> other commercial damages or losses), even if such Contributor
232+
> has been advised of the possibility of such damages.
233+
>
234+
> 9. Accepting Warranty or Additional Liability. While redistributing
235+
> the Work or Derivative Works thereof, You may choose to offer,
236+
> and charge a fee for, acceptance of support, warranty, indemnity,
237+
> or other liability obligations and/or rights consistent with this
238+
> License. However, in accepting such obligations, You may act only
239+
> on Your own behalf and on Your sole responsibility, not on behalf
240+
> of any other Contributor, and only if You agree to indemnify,
241+
> defend, and hold each Contributor harmless for any liability
242+
> incurred by, or claims asserted against, such Contributor by reason
243+
> of your accepting any such warranty or additional liability.
244+
>
245+
> END OF TERMS AND CONDITIONS
246+
>
247+
> APPENDIX: How to apply the Apache License to your work.
248+
>
249+
> To apply the Apache License to your work, attach the following
250+
> boilerplate notice, with the fields enclosed by brackets "[]"
251+
> replaced with your own identifying information. (Don't include
252+
> the brackets!) The text should be enclosed in the appropriate
253+
> comment syntax for the file format. We also recommend that a
254+
> file or class name and description of purpose be included on the
255+
> same "printed page" as the copyright notice for easier
256+
> identification within third-party archives.
257+
>
258+
> Copyright [yyyy] [name of copyright owner]
259+
>
260+
> Licensed under the Apache License, Version 2.0 (the "License");
261+
> you may not use this file except in compliance with the License.
262+
> You may obtain a copy of the License at
263+
>
264+
> http://www.apache.org/licenses/LICENSE-2.0
265+
>
266+
> Unless required by applicable law or agreed to in writing, software
267+
> distributed under the License is distributed on an "AS IS" BASIS,
268+
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
269+
> See the License for the specific language governing permissions and
270+
> limitations under the License.
271+
>
272+
63273
## javascript-stringify
64274

65275
License: MIT

Diff for: ‎index.ts

+27-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import minimist from 'minimist'
77
import prompts from 'prompts'
88
import { red, green, bold } from 'kolorist'
99

10+
import ejs from 'ejs'
11+
1012
import * as banners from './utils/banners'
1113

1214
import renderTemplate from './utils/renderTemplate'
@@ -316,9 +318,10 @@ async function init() {
316318
// when bundling for node and the format is cjs
317319
// const templateRoot = new URL('./template', import.meta.url).pathname
318320
const templateRoot = path.resolve(__dirname, 'template')
321+
const callbacks = []
319322
const render = function render(templateName) {
320323
const templateDir = path.resolve(templateRoot, templateName)
321-
renderTemplate(templateDir, root)
324+
renderTemplate(templateDir, root, callbacks)
322325
}
323326
// Render base template
324327
render('base')
@@ -399,6 +402,29 @@ async function init() {
399402
render('entry/default')
400403
}
401404

405+
// An external data store for callbacks to share data
406+
const dataStore = {}
407+
// Process callbacks
408+
for (const cb of callbacks) {
409+
await cb(dataStore)
410+
}
411+
412+
// EJS template rendering
413+
preOrderDirectoryTraverse(
414+
root,
415+
() => {},
416+
(filepath) => {
417+
if (filepath.endsWith('.ejs')) {
418+
const template = fs.readFileSync(filepath, 'utf-8')
419+
const dest = filepath.replace(/\.ejs$/, '')
420+
const content = ejs.render(template, dataStore[dest])
421+
422+
fs.writeFileSync(dest, content)
423+
fs.unlinkSync(filepath)
424+
}
425+
}
426+
)
427+
402428
// Cleanup.
403429

404430
// We try to share as many files between TypeScript and JavaScript as possible.

Diff for: ‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"@types/prompts": "^2.4.4",
4141
"@vue/create-eslint-config": "^0.2.1",
4242
"@vue/tsconfig": "^0.4.0",
43+
"ejs": "^3.1.9",
4344
"esbuild": "^0.17.18",
4445
"esbuild-plugin-license": "^1.2.2",
4546
"husky": "^8.0.3",

Diff for: ‎pnpm-lock.yaml

+11
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎template/base/vite.config.js.data.mjs

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
export default function getData() {
2+
return {
3+
plugins: [{
4+
id: 'vue',
5+
importer: "import vue from '@vitejs/plugin-vue'",
6+
initializer: 'vue()'
7+
}]
8+
}
9+
}

Diff for: ‎template/base/vite.config.js renamed to ‎template/base/vite.config.js.ejs

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
import { fileURLToPath, URL } from 'node:url'
22

33
import { defineConfig } from 'vite'
4-
import vue from '@vitejs/plugin-vue'
4+
<%_ for (const { importer } of plugins) { _%>
5+
<%- importer %>
6+
<%_ } _%>
57

68
// https://vitejs.dev/config/
79
export default defineConfig({
8-
plugins: [vue()],
10+
plugins: [
11+
<%_ for (const { initializer } of plugins) { _%>
12+
<%- initializer _%>,
13+
<%_ } _%>
14+
],
915
resolve: {
1016
alias: {
1117
'@': fileURLToPath(new URL('./src', import.meta.url))

Diff for: ‎template/config/jsx/vite.config.js

-15
This file was deleted.

Diff for: ‎template/config/jsx/vite.config.js.data.mjs

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
export default function getData({ oldData }) {
2+
const vueJsxPlugin = {
3+
name: 'vueJsx',
4+
importer: "import vueJsx from '@vitejs/plugin-vue-jsx'",
5+
initializer: 'vueJsx()'
6+
}
7+
8+
return {
9+
...oldData,
10+
// Append the vueJsx plugin right after the vue plugin
11+
plugins: oldData.plugins.flatMap((plugin) =>
12+
plugin.id === 'vue' ? [plugin, vueJsxPlugin] : plugin
13+
)
14+
}
15+
}

Diff for: ‎template/config/nightwatch-ct/vite.config.js

-22
This file was deleted.

0 commit comments

Comments
 (0)