Skip to content

Fix color_expression_test.dart #8259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Fix color_expression_test.dart #8259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac340c9
Revert comments.
isoos Nov 8, 2024
6d2d858
Fix color_expression_test.dart
isoos Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 85 additions & 86 deletions pkg/web_css/test/color_expressions_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,98 +2,97 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// import 'dart:io';
import 'dart:io';

import 'package:test/test.dart';

// final _whitespace = RegExp(r'\s+');
final _whitespace = RegExp(r'\s+');

// const _colors = {
// 'black',
// 'red',
// 'white',
// };
const _colors = {
'black',
'red',
'white',
};

void main() {
group('Color restrictions and rules', () {
// TODO(https://github.com/dart-lang/pub-dev/issues/8248): comment in once issue is resolved.
// test('text and bg colors are only defined in _variables.scss',
// skip: 'https://github.com/dart-lang/pub-dev/issues/8248', () {
// final files = Directory('lib')
// .listSync(recursive: true)
// .whereType<File>()
// .where((f) => f.path.endsWith('.scss'))
// // _variables.scss is not checked, this should be the place for all color definitions
// .where((f) => !f.path.endsWith('/_variables.scss'))

// // _staging_ribbon.scss is only used on staging
// .where((f) => !f.path.endsWith('/_staging_ribbon.scss'))

// // _footer.scss has only one color theme, skipping for now
// // TODO: migrate the variables in this file
// .where((f) => !f.path.endsWith('/_footer.scss'))

// // dartdoc files are not checked
// .where((f) => !f.path.endsWith('/dartdoc.scss'))
// .toList();

// final badExpressions = <String>[];

// for (final file in files) {
// var content = file.readAsStringSync();
// // remove multi-line comment blocks
// content =
// content.replaceAll(RegExp(r'\/\*.*\*/', multiLine: true), ' ');
// final lines = content.split('\n');
// for (var i = 0; i < lines.length; i++) {
// final line = lines[i];
// // remove single-line comment
// final expr =
// line.split('//').first.replaceAll(_whitespace, ' ').trim();
// if (expr.isEmpty) continue;

// // minimal parsing and sanity check
// final parts = expr.split(':');
// if (parts.length != 2) continue;
// final name = parts[0].trim();
// var value = parts[1].trim();

// // remove known overlapping variable names from checking
// value =
// value.replaceAll('--pub-badge-red-color', '--pub-badge-color');

// if (name.isEmpty || value.isEmpty) continue;

// // local mdc overrides are exempted for now
// // TODO: move these values to _variables.scss
// if (name.startsWith('--mdc-theme-')) {
// continue;
// }

// // border colors, box shadows and text-decorations are exempted for now
// // TODO: move these values to _variables.scss
// if (name == 'border' ||
// name.startsWith('border-') ||
// name == 'box-shadow' ||
// name == 'text-decoration') {
// continue;
// }

// // detect color patterns
// final hasColor = value.contains('#') ||
// // TODO: also migrate color- variables
// // value.contains(r'$color-') ||
// value.contains('rgb(') ||
// value.contains('rgba(') ||
// value.contains('hsl(') ||
// _colors.any((c) => value.contains(c));
// if (!hasColor) continue;

// badExpressions.add('${file.path} line #${i + 1}: `${expr.trim()}`');
// }
// }

// expect(badExpressions, isEmpty);
// });
test('text and bg colors are only defined in _variables.scss', () {
final files = Directory('lib')
.listSync(recursive: true)
.whereType<File>()
.where((f) => f.path.endsWith('.scss'))
// _variables.scss is not checked, this should be the place for all color definitions
.where((f) => !f.path.endsWith('/_variables.scss'))

// _staging_ribbon.scss is only used on staging
.where((f) => !f.path.endsWith('/_staging_ribbon.scss'))

// _footer.scss has only one color theme, skipping for now
// TODO: migrate the variables in this file
.where((f) => !f.path.endsWith('/_footer.scss'))

// dartdoc files are not checked
.where((f) => !f.path.endsWith('/dartdoc.scss'))
.toList();

final badExpressions = <String>[];

for (final file in files) {
var content = file.readAsStringSync();
// remove multi-line comment blocks
content =
content.replaceAll(RegExp(r'\/\*.*\*/', multiLine: true), ' ');
final lines = content.split('\n');
for (var i = 0; i < lines.length; i++) {
final line = lines[i];
// remove single-line comment
final expr =
line.split('//').first.replaceAll(_whitespace, ' ').trim();
if (expr.isEmpty) continue;

// minimal parsing and sanity check
final parts = expr.split(':');
if (parts.length != 2) continue;
final name = parts[0].trim();
var value = parts[1].trim();

// remove known overlapping variable names from checking
value =
value.replaceAll('--pub-badge-red-color', '--pub-badge-color');

if (name.isEmpty || value.isEmpty) continue;

// local mdc overrides are exempted for now
// TODO: move these values to _variables.scss
if (name.startsWith('--mdc-theme-')) {
continue;
}

// border colors, box shadows and text-decorations are exempted for now
// TODO: move these values to _variables.scss
if (name == 'border' ||
name.startsWith('border-') ||
name == 'box-shadow' ||
name == 'text-decoration') {
continue;
}

// detect color patterns
final hasColor = value.contains('#') ||
// TODO: also migrate color- variables
// value.contains(r'$color-') ||
value.contains('rgb(') ||
value.contains('rgba(') ||
value.contains('hsl(') ||
(_colors.any((c) => value.contains(c)) &&
!value.contains('var(--pub-color-'));
if (!hasColor) continue;

badExpressions.add('${file.path} line #${i + 1}: `${expr.trim()}`');
}
}

expect(badExpressions, isEmpty);
});
});
}
Loading