Skip to content

Commit 7c92595

Browse files
web-padawanweb-padawan
authored
feat: initialize aura package, modify web-dev-server config (#9883)
1 parent d5b02e8 commit 7c92595

File tree

8 files changed

+259
-6
lines changed

8 files changed

+259
-6
lines changed

‎package.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,18 @@
2020
"serve:dist": "web-dev-server --app-index dist/index.html --open",
2121
"start": "web-dev-server --node-resolve --open /dev",
2222
"start:base": "web-dev-server --node-resolve --open /dev --theme=base",
23+
"start:aura": "web-dev-server --node-resolve --open /dev --theme=aura",
2324
"check-releases": "node ./scripts/check-releases.js && web-dev-server --node-resolve --open /scripts/check-releases.html",
2425
"test": "web-test-runner",
26+
"test:aura": "yarn test --config web-test-runner-aura.config.js",
2527
"test:base": "yarn test --config web-test-runner-base.config.js",
2628
"test:firefox": "yarn test --config web-test-runner-firefox.config.js",
2729
"test:it": "yarn test --config web-test-runner-it.config.js",
2830
"test:lumo": "yarn test --config web-test-runner-lumo.config.js",
2931
"test:local:lumo": "yarn test --config web-test-runner-lumo.config.js --local",
3032
"test:snapshots": "yarn test --config web-test-runner-snapshots.config.js",
3133
"test:webkit": "yarn test --config web-test-runner-webkit.config.js",
34+
"update:aura": "TEST_ENV=update yarn test --config web-test-runner-aura.config.js",
3235
"update:base": "TEST_ENV=update yarn test --config web-test-runner-base.config.js",
3336
"update:local:lumo": "TEST_ENV=update yarn test --config web-test-runner-lumo.config.js --local",
3437
"update:lumo": "TEST_ENV=update yarn test --config web-test-runner-lumo.config.js",

‎packages/aura/LICENSE‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
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+
Copyright 2025 Vaadin
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

‎packages/aura/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Aura
2+
3+
Aura theme for Vaadin components.
4+
5+
## License
6+
7+
Apache License 2.0

‎packages/aura/aura.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
html {
2+
/* Global custom properties */
3+
}

‎packages/aura/package.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "@vaadin/aura",
3+
"version": "25.0.0-alpha10",
4+
"publishConfig": {
5+
"access": "public"
6+
},
7+
"description": "Aura is a theme used by Vaadin components",
8+
"license": "Apache-2.0",
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/vaadin/web-components.git",
12+
"directory": "packages/aura"
13+
},
14+
"author": "Vaadin Ltd",
15+
"homepage": "https://vaadin.com/components",
16+
"bugs": {
17+
"url": "https://github.com/vaadin/web-components/issues"
18+
},
19+
"main": "aura.css",
20+
"type": "module",
21+
"files": [
22+
"*.css"
23+
],
24+
"keywords": [
25+
"vaadin",
26+
"aura",
27+
"design-system",
28+
"web-components",
29+
"web-component"
30+
]
31+
}

‎web-dev-server.config.js‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,23 @@ export function enforceThemePlugin(theme) {
5555
body = body.replace('../../global.css', '../autoload.js');
5656
}
5757

58-
if (['base', 'legacy-lumo'].includes(theme) && context.response.is('html', 'js')) {
58+
if (theme === 'aura' && context.response.is('html')) {
59+
// For dev pages: replace link to CSS stylesheet with JS autoload script
60+
body = body.replace(
61+
'<link rel="stylesheet" href="/packages/vaadin-lumo-styles/lumo.css" />',
62+
'<link rel="stylesheet" href="/packages/aura/aura.css" />',
63+
);
64+
}
65+
66+
if (['base', 'legacy-lumo', 'aura'].includes(theme) && context.response.is('html', 'js')) {
5967
// Remove all not transformed CSS imports
6068
body = body.replaceAll(/^.+(vaadin-lumo-styles|\.\.)\/.+\.css.+$/gmu, '');
6169
}
6270

6371
return body;
6472
},
6573
transformImport({ source, context }) {
66-
if (theme === 'base' || theme === 'ported-lumo') {
74+
if (theme === 'base' || theme === 'ported-lumo' || theme === 'aura') {
6775
source = source.replace('/theme/lumo/', '/src/');
6876

6977
const baseStylesResolvedPath = path.resolve(
@@ -138,5 +146,9 @@ export default {
138146
// yarn start --theme=lumo --ported (uses base styles and lumo styles defined in css files)
139147
theme === 'lumo' && hasPortedParam && enforceThemePlugin('ported-lumo'),
140148
theme === 'lumo' && hasPortedParam && cssImportPlugin(),
149+
150+
// yarn start --theme=aura
151+
theme === 'aura' && enforceThemePlugin('aura'),
152+
theme === 'aura' && cssImportPlugin(),
141153
].filter(Boolean),
142154
};

‎web-test-runner-aura.config.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { createVisualTestsConfig } from './wtr-utils.js';
2+
3+
export default createVisualTestsConfig('aura', '138');

‎wtr-utils.js‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,14 @@ const getAllVisualPackages = () => {
9999
};
100100

101101
/**
102-
* Get all available packages with visual tests for base styles.
102+
* Get all available packages with visual tests for given theme.
103103
*/
104-
const getAllBasePackages = () => {
104+
const getAllThemePackages = (theme) => {
105105
return fs
106106
.readdirSync('packages')
107-
.filter((dir) => fs.statSync(`packages/${dir}`).isDirectory() && fs.existsSync(`packages/${dir}/test/visual/base`));
107+
.filter(
108+
(dir) => fs.statSync(`packages/${dir}`).isDirectory() && fs.existsSync(`packages/${dir}/test/visual/${theme}`),
109+
);
108110
};
109111

110112
/**
@@ -266,7 +268,9 @@ const createUnitTestsConfig = (config) => {
266268
const createVisualTestsConfig = (theme, browserVersion) => {
267269
let visualPackages = [];
268270
if (theme === 'base') {
269-
visualPackages = getAllBasePackages();
271+
visualPackages = getAllThemePackages('base');
272+
} else if (theme === 'aura') {
273+
visualPackages = getAllThemePackages('aura');
270274
} else {
271275
visualPackages = getAllVisualPackages();
272276
}

0 commit comments

Comments
 (0)