Skip to content

Commit da5ab38

Browse files
isoosisoos
authored
CSS refactoring: dartdoc.scss, separation of third_party and customization (#7790)
1 parent 2ff0bf7 commit da5ab38

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+113
-155
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ build/
1212
*.sum
1313

1414
# Ignore files built when the server is started
15+
/static/css/dartdoc.css
16+
/static/css/dartdoc.css.map
1517
/static/css/style.css
1618
/static/css/style.css.map
1719
/static/js/script.dart.js

‎app/lib/dartdoc/dartdoc_page.dart‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -110,21 +110,6 @@ extension DartDocPageRender on DartDocPage {
110110
if (!options.isLatestStable)
111111
d.meta(rel: 'alternate', href: options.latestStableDocumentationUrl),
112112
d.link(rel: 'preconnect', href: 'https://fonts.gstatic.com'),
113-
// HACK: This is not part of dartdoc
114-
d.link(
115-
rel: 'stylesheet',
116-
type: 'text/css',
117-
href: staticUrls.githubMarkdownCss),
118-
// TODO: Consider using same github.css we use on pub.dev
119-
d.link(
120-
rel: 'stylesheet',
121-
type: 'text/css',
122-
href: staticUrls.dartdocGithubCss),
123-
if (activeConfiguration.isStaging)
124-
d.link(
125-
rel: 'stylesheet',
126-
type: 'text/css',
127-
href: staticUrls.getAssetUrl('/static/css/staging-ribbon.css')),
128113
d.link(
129114
rel: 'stylesheet',
130115
href:
@@ -136,7 +121,7 @@ extension DartDocPageRender on DartDocPage {
136121
'https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0',
137122
),
138123

139-
d.link(rel: 'stylesheet', href: staticUrls.dartdocStylesCss),
124+
d.link(rel: 'stylesheet', href: staticUrls.dartdocCss),
140125
d.link(rel: 'icon', href: staticUrls.smallDartFavicon),
141126
]);
142127

‎app/lib/frontend/static_files.dart‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ class StaticFileCache {
118118
// deployment process. Normally page rendering checks their existence,
119119
// and fails when they are missing. By listing these here, the build
120120
// is no longer a strict requirement, and tests can be run without it.
121+
'/static/css/dartdoc.css',
121122
'/static/css/style.css',
122123
'/static/js/script.dart.js',
123124
};
@@ -240,11 +241,7 @@ class StaticUrls {
240241
late final pubDevLogoSvg = getAssetUrl('/static/img/pub-dev-logo.svg');
241242
late final defaultProfilePng = getAssetUrl(
242243
'/static/img/material-icon-twotone-account-circle-white-24dp.png');
243-
late final githubMarkdownCss = getAssetUrl('/static/css/github-markdown.css');
244-
late final dartdocGithubCss =
245-
getAssetUrl('/static/dartdoc/resources/github.css');
246-
late final dartdocStylesCss =
247-
getAssetUrl('/static/dartdoc/resources/styles.css');
244+
late final dartdocCss = getAssetUrl('/static/css/dartdoc.css');
248245
late final dartdocScriptJs =
249246
getAssetUrl('/static/dartdoc/resources/docs.dart.js');
250247
late final dartdochighlightJs =
@@ -331,11 +328,19 @@ Future updateLocalBuiltFilesIfNeeded() async {
331328

332329
final webCssDir = Directory(resolveWebCssDirPath());
333330
final webCssLastModified = await _detectLastModified(webCssDir);
334-
final styleCss = File(path.join(staticDir.path, 'css', 'style.css'));
335-
final styleCssExists = await styleCss.exists();
336-
final styleCssLastModified =
337-
styleCssExists ? await styleCss.lastModified() : null;
338-
if (!styleCssExists || (styleCssLastModified!.isBefore(webCssLastModified))) {
331+
332+
Future<bool> cssNeedsUpdate(String filename) async {
333+
final styleCss = File(path.join(staticDir.path, 'css', filename));
334+
final styleCssExists = await styleCss.exists();
335+
final styleCssLastModified =
336+
styleCssExists ? await styleCss.lastModified() : null;
337+
return !styleCssExists ||
338+
(styleCssLastModified!.isBefore(webCssLastModified));
339+
}
340+
341+
final needsCssBuild = (await cssNeedsUpdate('style.css')) ||
342+
(await cssNeedsUpdate('dartdoc.css'));
343+
if (needsCssBuild) {
339344
_logger.info('Building pkg/web_css');
340345
await updateWebCssBuild();
341346
}

‎app/test/dartdoc/dartdoc_page_test.dart‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ void main() {
6262
scopedTest(
6363
'run dartdoc',
6464
() async {
65+
registerStaticFileCacheForTest(StaticFileCache.forTests());
6566
final pr = await toolEnv.dartdoc(pkgDir, docDir, usesFlutter: false);
6667
expect(pr.exitCode, 0);
6768

@@ -134,7 +135,7 @@ void main() {
134135
_removeSharedXmlNodes(fileXmlRoot, renderedXmlDoc);
135136

136137
// cleanup <head> differences
137-
for (final link in ['/styles.css', '/favicon.png']) {
138+
for (final link in ['/styles.css', '/github.css', '/favicon.png']) {
138139
fileXmlRoot.descendantElements
139140
.firstWhere((e) =>
140141
e.localName == 'link' &&
@@ -149,7 +150,7 @@ void main() {
149150
renderedHead.childElements
150151
.firstWhereOrNull((e) => e.getAttribute('content') == 'noindex')
151152
?.remove();
152-
expect(renderedHead.children, hasLength(7));
153+
expect(renderedHead.children, hasLength(6));
153154
for (final c in [...renderedHead.childElements]) {
154155
c.remove();
155156
}

‎app/test/frontend/static_files_test.dart‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ void main() {
130130
..remove('/static/js/survey-helper.js')
131131
// debug-helper files are served, but not referenced
132132
..removeAll([
133+
'/static/css/dartdoc.css.map',
133134
'/static/css/style.css.map',
134135
'/static/js/script.dart.js.deps',
135136
'/static/js/script.dart.js.info.json',
@@ -161,6 +162,11 @@ void main() {
161162
'/static/css/github-markdown.css',
162163
'/static/highlight/github.css',
163164
])
165+
// dartdoc files included through dartdoc.scss
166+
..removeAll([
167+
'/static/dartdoc/resources/github.css',
168+
'/static/dartdoc/resources/styles.css',
169+
])
164170
// dartdoc files not used, or included through javascript
165171
..removeAll([
166172
'/static/dartdoc/resources/favicon.png',

‎app/test/task/testdata/goldens/documentation/oxygen/1.0.0/index.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
<link rel="canonical" href="https://pub.dev/documentation/oxygen/1.0.0/"/>
1414
<meta rel="alternate" href="/documentation/oxygen/latest/"/>
1515
<link rel="preconnect" href="https://fonts.gstatic.com"/>
16-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/css/github-markdown.css"/>
17-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/dartdoc/resources/github.css"/>
1816
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&amp;display=swap"/>
1917
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/>
20-
<link rel="stylesheet" href="/static/hash-%%etag%%/dartdoc/resources/styles.css"/>
18+
<link rel="stylesheet" href="/static/hash-%%etag%%/css/dartdoc.css"/>
2119
<link rel="icon" href="/favicon.ico?hash=mocked_hash_985685822"/>
2220
</head>
2321
<body class="light-theme" data-base-href="" data-using-base-href="false">

‎app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass-class.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
<link rel="canonical" href="https://pub.dev/documentation/oxygen/1.0.0/oxygen/MainClass-class.html"/>
1414
<meta rel="alternate" href="/documentation/oxygen/latest/"/>
1515
<link rel="preconnect" href="https://fonts.gstatic.com"/>
16-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/css/github-markdown.css"/>
17-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/dartdoc/resources/github.css"/>
1816
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&amp;display=swap"/>
1917
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/>
20-
<link rel="stylesheet" href="/static/hash-%%etag%%/dartdoc/resources/styles.css"/>
18+
<link rel="stylesheet" href="/static/hash-%%etag%%/css/dartdoc.css"/>
2119
<link rel="icon" href="/favicon.ico?hash=mocked_hash_985685822"/>
2220
</head>
2321
<body class="light-theme" data-base-href="../" data-using-base-href="false">

‎app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/MainClass.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
<link rel="canonical" href="https://pub.dev/documentation/oxygen/1.0.0/oxygen/MainClass/MainClass.html"/>
1414
<meta rel="alternate" href="/documentation/oxygen/latest/"/>
1515
<link rel="preconnect" href="https://fonts.gstatic.com"/>
16-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/css/github-markdown.css"/>
17-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/dartdoc/resources/github.css"/>
1816
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&amp;display=swap"/>
1917
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/>
20-
<link rel="stylesheet" href="/static/hash-%%etag%%/dartdoc/resources/styles.css"/>
18+
<link rel="stylesheet" href="/static/hash-%%etag%%/css/dartdoc.css"/>
2119
<link rel="icon" href="/favicon.ico?hash=mocked_hash_985685822"/>
2220
</head>
2321
<body class="light-theme" data-base-href="../../" data-using-base-href="false">

‎app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/text.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
<link rel="canonical" href="https://pub.dev/documentation/oxygen/1.0.0/oxygen/MainClass/text.html"/>
1414
<meta rel="alternate" href="/documentation/oxygen/latest/"/>
1515
<link rel="preconnect" href="https://fonts.gstatic.com"/>
16-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/css/github-markdown.css"/>
17-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/dartdoc/resources/github.css"/>
1816
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&amp;display=swap"/>
1917
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/>
20-
<link rel="stylesheet" href="/static/hash-%%etag%%/dartdoc/resources/styles.css"/>
18+
<link rel="stylesheet" href="/static/hash-%%etag%%/css/dartdoc.css"/>
2119
<link rel="icon" href="/favicon.ico?hash=mocked_hash_985685822"/>
2220
</head>
2321
<body class="light-theme" data-base-href="../../" data-using-base-href="false">

‎app/test/task/testdata/goldens/documentation/oxygen/1.0.0/oxygen/MainClass/toLowerCase.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
<link rel="canonical" href="https://pub.dev/documentation/oxygen/1.0.0/oxygen/MainClass/toLowerCase.html"/>
1414
<meta rel="alternate" href="/documentation/oxygen/latest/"/>
1515
<link rel="preconnect" href="https://fonts.gstatic.com"/>
16-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/css/github-markdown.css"/>
17-
<link rel="stylesheet" type="text/css" href="/static/hash-%%etag%%/dartdoc/resources/github.css"/>
1816
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&amp;display=swap"/>
1917
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0"/>
20-
<link rel="stylesheet" href="/static/hash-%%etag%%/dartdoc/resources/styles.css"/>
18+
<link rel="stylesheet" href="/static/hash-%%etag%%/css/dartdoc.css"/>
2119
<link rel="icon" href="/favicon.ico?hash=mocked_hash_985685822"/>
2220
</head>
2321
<body class="light-theme" data-base-href="../../" data-using-base-href="false">

0 commit comments

Comments
 (0)