Skip to content

Commit 70bb3c6

Browse files
authored
feat: add a "LICENSE" file to Dart packages. (#1977)
pub.dev requires that packages have a LICENSE file in their root. The file was named "LICENSE.txt.mustache" because `WalkTemplatesDir` elides files without an extension (after ".mustache" is removed). `generatedFiles` renames this file to "LICENSE". There were a few other approaches that we could use: 1. `WalkTemplatesDir` could use a different naming convention for elided files (e.g. "internal_<name>.mustache") 2. `generatedFiles` could walk the template directory itself.
1 parent 7e955a3 commit 70bb3c6

File tree

4 files changed

+230
-1
lines changed

4 files changed

+230
-1
lines changed

internal/sidekick/internal/dart/generate.go

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,19 @@ func generatedFiles(model *api.API) []language.GeneratedFile {
6262

6363
files := language.WalkTemplatesDir(dartTemplates, "templates")
6464

65-
// Look for and replace 'main.dart' with '{servicename}.dart'
6665
for index, fileInfo := range files {
66+
// Replace 'main.dart' with '{servicename}.dart'
6767
if filepath.Base(fileInfo.TemplatePath) == "main.dart.mustache" {
6868
outDir := filepath.Dir(fileInfo.OutputPath)
6969
fileInfo.OutputPath = filepath.Join(outDir, mainFileName+".dart")
7070

71+
files[index] = fileInfo
72+
}
73+
// Remove the extension from "LICENSE.txt".
74+
if filepath.Base(fileInfo.OutputPath) == "LICENSE.txt" {
75+
outDir := filepath.Dir(fileInfo.OutputPath)
76+
fileInfo.OutputPath = filepath.Join(outDir, "LICENSE")
77+
7178
files[index] = fileInfo
7279
}
7380
}

internal/sidekick/internal/dart/generate_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ func TestGeneratedFiles(t *testing.T) {
8787
if filepath.Base(fileInfo.OutputPath) == "main.dart" {
8888
t.Errorf("expected the main.dart template to be generated as {servicename}.dart")
8989
}
90+
if filepath.Base(fileInfo.OutputPath) == "LICENSE.txt" {
91+
t.Errorf("expected the LICENSE.txt template to be generated as LICENSE")
92+
}
9093
}
9194
}
9295

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

internal/sidekick/internal/language/walk_templates_dir.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ import (
3232
//
3333
// Even in Rust, we may want to skip some files if the crate does not have
3434
// any services.
35+
//
36+
// Files whose output names would do not have an extension (e.g. `enum.mustache`) are
37+
// assumed to be used internally and are skipped.
3538
func WalkTemplatesDir(fsys fs.FS, root string) []GeneratedFile {
3639
var result []GeneratedFile
3740
fs.WalkDir(fsys, root, func(path string, d fs.DirEntry, err error) error {

0 commit comments

Comments
 (0)