Skip to content

Commit 2eba6e6

Browse files
AllanZhengYPAllanZhengYP
committed
chore: generate package static components from templates
1 parent e08b134 commit 2eba6e6

File tree

10 files changed

+504
-39
lines changed

10 files changed

+504
-39
lines changed

‎package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"cucumber": "0.5.x",
4242
"fs-extra": "^8.1.0",
4343
"generate-changelog": "^1.7.1",
44+
"handlebars": "^4.5.3",
4445
"husky": "^3.0.0",
4546
"jest": "^24.7.1",
4647
"jmespath": "^0.15.0",

‎scripts/generate-clients/copy-to-clients.js

Lines changed: 70 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
const path = require("path");
1+
const { join, normalize } = require("path");
22
const { copySync, ensureDirSync } = require("fs-extra");
3+
const handlebars = require("handlebars");
34
const {
45
readdirSync,
56
lstatSync,
@@ -8,8 +9,8 @@ const {
89
writeFileSync
910
} = require("fs");
1011

11-
const CODE_GEN_OUTPUT_DIR = path.normalize(
12-
path.join(
12+
const CODE_GEN_OUTPUT_DIR = normalize(
13+
join(
1314
__dirname,
1415
"..",
1516
"..",
@@ -21,69 +22,101 @@ const CODE_GEN_OUTPUT_DIR = path.normalize(
2122
)
2223
);
2324

24-
const unOverridables = [
25-
"package.json",
26-
"tsconfig.es.json",
27-
"tsconfig.json",
28-
"tsconfig.test.json"
29-
];
25+
/**
26+
* templates are a black list of files we don't want codegen artifact
27+
* to override in the clients folder
28+
*/
29+
const templates = readdirSync(join(__dirname, "templates"))
30+
.filter(name => /.sample$/.test(name))
31+
.reduce((accumulator, curr) => {
32+
const templatePath = join(__dirname, "templates", curr);
33+
const template = readFileSync(templatePath).toString();
34+
accumulator[curr.replace(/.sample$/, "")] = template;
35+
return accumulator;
36+
}, {});
3037

3138
async function copyToClients(clientsDir) {
3239
for (const modelName of readdirSync(CODE_GEN_OUTPUT_DIR)) {
3340
if (modelName === "source") continue;
34-
const artifactPath = path.join(
41+
const artifactPath = join(
3542
CODE_GEN_OUTPUT_DIR,
3643
modelName,
3744
"typescript-codegen"
3845
);
39-
const packageManifestPath = path.join(artifactPath, "package.json");
46+
const packageManifestPath = join(artifactPath, "package.json");
4047
if (!existsSync(packageManifestPath)) {
4148
console.error(`${modelName} generates empty client, skip.`);
4249
continue;
4350
}
51+
4452
const packageManifest = JSON.parse(
4553
readFileSync(packageManifestPath).toString()
4654
);
47-
const packageName = packageManifest.name.replace("@aws-sdk/", "");
55+
const packageName = packageManifest.name;
4856
console.log(`copying ${packageName} from ${artifactPath} to ${clientsDir}`);
49-
const destPath = path.join(clientsDir, packageName);
50-
for (const packageSub of readdirSync(artifactPath)) {
51-
const packageSubPath = path.join(artifactPath, packageSub);
52-
const destSubPath = path.join(destPath, packageSub);
53-
if (unOverridables.indexOf(packageSub) >= 0) {
54-
if (!existsSync(destSubPath))
55-
copySync(packageSubPath, destSubPath, { overwrite: true });
56-
else if (packageSub === "package.json") {
57+
const destPath = join(clientsDir, packageName.replace("@aws-sdk/", ""));
58+
59+
//Data used to generate files from template
60+
const templateData = {
61+
year: new Date().getFullYear(),
62+
packageName
63+
};
64+
65+
for (const packageSub of [
66+
...readdirSync(artifactPath),
67+
...Object.keys(templates)
68+
]) {
69+
const packageSubPath = join(artifactPath, packageSub);
70+
const destSubPath = join(destPath, packageSub);
71+
72+
if (Object.keys(templates).indexOf(packageSub) >= 0) {
73+
if (packageSub === "package.json") {
5774
/**
5875
* Copy package.json content in detail.
5976
* Basically merge the generated package.json and dest package.json
6077
* but prefer the values from dest when they contain the same key
6178
* */
62-
const destManifest = JSON.parse(readFileSync(destSubPath).toString());
63-
const updatedManifest = {
64-
...packageManifest,
65-
...destManifest,
66-
scripts: {
67-
...packageManifest.scripts,
68-
...destManifest.scripts
69-
},
70-
dependencies: {
71-
...packageManifest.dependencies,
72-
...destManifest.dependencies
73-
},
74-
devDependencies: {
75-
...packageManifest.devDependencies,
76-
...destManifest.devDependencies
77-
}
78-
};
79+
const destManifest = JSON.parse(
80+
existsSync(destSubPath)
81+
? readFileSync(destSubPath).toString()
82+
: handlebars.compile(templates[packageSub])(templateData)
83+
);
84+
const updatedManifest = mergeManifest(packageManifest, destManifest);
7985
writeFileSync(destSubPath, JSON.stringify(updatedManifest, null, 2));
86+
} else if (!existsSync(destSubPath)) {
87+
//for files not yet exists and we have a template for it; generate from template
88+
const file = handlebars.compile(templates[packageSub])(templateData);
89+
writeFileSync(destSubPath, file);
90+
} else {
91+
//for files we have template but we already have a new version in clients folder, always prefer current one
92+
//PASS
8093
}
8194
} else {
95+
//For things not in codegen artifact black list, overwrite the existing ones.
8296
if (lstatSync(packageSubPath).isDirectory()) ensureDirSync(destSubPath);
8397
copySync(packageSubPath, destSubPath, { overwrite: true });
8498
}
8599
}
86100
}
87101
}
88102

103+
const mergeManifest = (source, dest) => {
104+
return {
105+
...source,
106+
...dest,
107+
scripts: {
108+
...source.scripts,
109+
...dest.scripts
110+
},
111+
dependencies: {
112+
...source.dependencies,
113+
...dest.dependencies
114+
},
115+
devDependencies: {
116+
...source.devDependencies,
117+
...dest.devDependencies
118+
}
119+
};
120+
};
121+
89122
module.exports = { copyToClients, CODE_GEN_OUTPUT_DIR };

‎scripts/generate-clients/templates/.gitignore.sample

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/node_modules/
2+
/build/
3+
/coverage/
4+
/docs/
5+
/types/
6+
/dist/
7+
*.tsbuildinfo
8+
*.tgz
9+
*.log
10+
package-lock.json
11+
12+
*.d.ts
13+
*.js
14+
*.js.map

‎scripts/generate-clients/templates/.npmignore.sample

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/coverage/
2+
/docs/
3+
tsconfig.test.json
4+
*.tsbuildinfo

‎scripts/generate-clients/templates/LICENSE.sample

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

‎scripts/generate-clients/templates/README.md.sample

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{packageName}}
2+
3+
[![NPM version](https://img.shields.io/npm/v/{{packageName}}/preview.svg)](https://www.npmjs.com/package/{{packageName}})
4+
[![NPM downloads](https://img.shields.io/npm/dm/{{packageName}}.svg)](https://www.npmjs.com/package/{{packageName}})
5+
6+
For SDK usage, please step to [SDK reademe](https://github.com/aws/aws-sdk-js-v3).

0 commit comments

Comments
 (0)