danog/dart-sass
1
0
Fork 0
mirror of https://github.com/danog/dart-sass.git synced 2024-11-27 04:34:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into windows-path-separator

Browse Source
This commit is contained in:
Natalie Weizenbaum 2018-12-26 14:17:45 -08:00 committed by GitHub
commit 06b9fbd812
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 436 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGELOG.md
View File

@ -7,11 +7,21 @@
* Match Ruby Sass's behavior in some edge-cases involving numbers with many
significant digits.
### Command-Line Interface
* The source map generated for a stylesheet read from standard input now uses a
`data:` URL to include that stylesheet's contents in the source map.
### Node JS API
* `this.includePaths` for a running importer is now a `;`-separated string on
Windows, rather than `:`-separated. This matches Node Sass's behavior.
### Dart API
* The URL used in a source map to refer to a stylesheet loaded from an importer
is now `ImportResult.sourceMapUrl` as documented.
## 1.15.2
### Node JS API

10
lib/src/ast/sass/statement/callable_declaration.dart
View File

@ -7,6 +7,7 @@ import 'package:source_span/source_span.dart';
import '../argument_declaration.dart';
import '../statement.dart';
import 'parent.dart';
import 'silent_comment.dart';
/// An abstract class for callables (functions or mixins) that are declared in
/// user code.
@ -16,12 +17,17 @@ abstract class CallableDeclaration extends ParentStatement {
/// This may be `null` for callables without names.
final String name;
/// The comment immediately preceding this declaration.
final SilentComment comment;
/// The declared arguments this callable accepts.
final ArgumentDeclaration arguments;
final FileSpan span;
CallableDeclaration(
this.name, this.arguments, Iterable<Statement> children, this.span)
: super(List.unmodifiable(children));
this.name, this.arguments, Iterable<Statement> children, this.span,
{SilentComment comment})
: comment = comment,
super(List.unmodifiable(children));
}

6
lib/src/ast/sass/statement/function_rule.dart
View File

@ -8,14 +8,16 @@ import '../../../visitor/interface/statement.dart';
import '../argument_declaration.dart';
import '../statement.dart';
import 'callable_declaration.dart';
import 'silent_comment.dart';
/// A function declaration.
///
/// This declares a function that's invoked using normal CSS function syntax.
class FunctionRule extends CallableDeclaration {
FunctionRule(String name, ArgumentDeclaration arguments,
Iterable<Statement> children, FileSpan span)
: super(name, arguments, children, span);
Iterable<Statement> children, FileSpan span,
{SilentComment comment})
: super(name, arguments, children, span, comment: comment);
T accept<T>(StatementVisitor<T> visitor) => visitor.visitFunctionRule(this);

5
lib/src/ast/sass/statement/mixin_rule.dart
View File

@ -8,6 +8,7 @@ import '../../../visitor/interface/statement.dart';
import '../argument_declaration.dart';
import '../statement.dart';
import 'callable_declaration.dart';
import 'silent_comment.dart';
/// A mixin declaration.
///
@ -23,8 +24,8 @@ class MixinRule extends CallableDeclaration {
/// won't work correctly.
MixinRule(String name, ArgumentDeclaration arguments,
Iterable<Statement> children, FileSpan span,
{this.hasContent = false})
: super(name, arguments, children, span);
{this.hasContent = false, SilentComment comment})
: super(name, arguments, children, span, comment: comment);
T accept<T>(StatementVisitor<T> visitor) => visitor.visitMixinRule(this);

21
lib/src/ast/sass/statement/silent_comment.dart
View File

@ -2,7 +2,10 @@
// MIT-style license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.
import 'dart:math' as math;
import 'package:source_span/source_span.dart';
import 'package:string_scanner/string_scanner.dart';
import '../../../visitor/interface/statement.dart';
import '../statement.dart';
@ -12,6 +15,24 @@ class SilentComment implements Statement {
/// The text of this comment, including comment characters.
final String text;
/// The subset of lines in text that are marked as part of the documentation
/// comments by beginning with '///'.
///
/// The leading slashes and space on each line is removed. Returns `null` when
/// there is no documentation comment.
String get docComment {
var buffer = StringBuffer();
for (var line in text.split('\n')) {
var scanner = StringScanner(line.trim());
if (!scanner.scan('///')) continue;
scanner.scan(' ');
buffer.writeln(scanner.rest);
}
var comment = buffer.toString().trimRight();
return comment.isNotEmpty ? comment : null;
}
final FileSpan span;
SilentComment(this.text, this.span);

9
lib/src/ast/sass/statement/variable_declaration.dart
View File

@ -9,6 +9,7 @@ import '../../../parse/scss.dart';
import '../../../visitor/interface/statement.dart';
import '../expression.dart';
import '../statement.dart';
import 'silent_comment.dart';
/// A variable declaration.
///
@ -17,6 +18,9 @@ class VariableDeclaration implements Statement {
/// The name of the variable.
final String name;
/// The comment immediatly preceding this declaration.
SilentComment comment;
/// The value the variable is being assigned to.
final Expression expression;
@ -33,9 +37,10 @@ class VariableDeclaration implements Statement {
final FileSpan span;
VariableDeclaration(this.name, this.expression, this.span,
{bool guarded = false, bool global = false})
{bool guarded = false, bool global = false, SilentComment comment})
: isGuarded = guarded,
isGlobal = global;
isGlobal = global,
comment = comment;
/// Parses a variable declaration from [contents].
///

14
lib/src/async_compile.dart
View File

@ -3,6 +3,7 @@
// https://opensource.org/licenses/MIT.
import 'dart:async';
import 'dart:convert';
import 'package:path/path.dart' as p;
import 'package:source_maps/source_maps.dart';
@ -17,6 +18,7 @@ import 'io.dart';
import 'logger.dart';
import 'sync_package_resolver.dart';
import 'syntax.dart';
import 'utils.dart';
import 'visitor/async_evaluate.dart';
import 'visitor/serialize.dart';
@ -130,6 +132,18 @@ Future<CompileResult> _compileStylesheet(
lineFeed: lineFeed,
sourceMap: sourceMap);
if (serializeResult.sourceMap != null && importCache != null) {
// TODO(nweiz): Don't explicitly use a type parameter when dart-lang/sdk#25490
// is fixed.
mapInPlace<String>(
serializeResult.sourceMap.urls,
(url) => url == ''
? Uri.dataFromString(stylesheet.span.file.getText(0),
encoding: utf8)
.toString()
: importCache.sourceMapUrl(Uri.parse(url)).toString());
}
return CompileResult(evaluateResult, serializeResult);
}

25
lib/src/async_import_cache.dart
View File

@ -10,6 +10,7 @@ import 'package:tuple/tuple.dart';
import 'ast/sass.dart';
import 'importer.dart';
import 'importer/result.dart';
import 'io.dart';
import 'logger.dart';
import 'sync_package_resolver.dart';
@ -34,6 +35,9 @@ class AsyncImportCache {
/// The parsed stylesheets for each canonicalized import URL.
final Map<Uri, Stylesheet> _importCache;
/// The import results for each canonicalized import URL.
final Map<Uri, ImporterResult> _resultsCache;
/// Creates an import cache that resolves imports using [importers].
///
/// Imports are resolved by trying, in order:
@ -58,14 +62,16 @@ class AsyncImportCache {
: _importers = _toImporters(importers, loadPaths, packageResolver),
_logger = logger ?? const Logger.stderr(),
_canonicalizeCache = {},
_importCache = {};
_importCache = {},
_resultsCache = {};
/// Creates an import cache without any globally-avaiable importers.
AsyncImportCache.none({Logger logger})
: _importers = const [],
_logger = logger ?? const Logger.stderr(),
_canonicalizeCache = {},
_importCache = {};
_importCache = {},
_resultsCache = {};
/// Converts the user's [importers], [loadPaths], and [packageResolver]
/// options into a single list of importers.
@ -96,7 +102,8 @@ class AsyncImportCache {
: _importers = const [],
_logger = const Logger.stderr(),
_canonicalizeCache = const {},
_importCache = const {};
_importCache = const {},
_resultsCache = const {};
/// Canonicalizes [url] according to one of this cache's importers.
///
@ -177,6 +184,8 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
return await putIfAbsentAsync(_importCache, canonicalUrl, () async {
var result = await importer.load(canonicalUrl);
if (result == null) return null;
_resultsCache[canonicalUrl] = result;
return Stylesheet.parse(result.contents, result.syntax,
// For backwards-compatibility, relative canonical URLs are resolved
// relative to [originalUrl].
@ -189,8 +198,7 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
/// Return a human-friendly URL for [canonicalUrl] to use in a stack trace.
///
/// Throws a [StateError] if the stylesheet for [canonicalUrl] hasn't been
/// loaded by this cache.
/// Returns [canonicalUrl] as-is if it hasn't been loaded by this cache.
Uri humanize(Uri canonicalUrl) {
// Display the URL with the shortest path length.
var url = minBy(
@ -206,6 +214,12 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
return url.resolve(p.url.basename(canonicalUrl.path));
}
/// Returns the URL to use in the source map to refer to [canonicalUrl].
///
/// Returns [canonicalUrl] as-is if it hasn't been loaded by this cache.
Uri sourceMapUrl(Uri canonicalUrl) =>
_resultsCache[canonicalUrl]?.sourceMapUrl ?? canonicalUrl;
/// Clears the cached canonical version of the given [url].
///
/// Has no effect if the canonical version of [url] has not been cached.
@ -218,6 +232,7 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
///
/// Has no effect if the imported file at [canonicalUrl] has not been cached.
void clearImport(Uri canonicalUrl) {
_resultsCache.remove(canonicalUrl);
_importCache.remove(canonicalUrl);
}
}

17
lib/src/compile.dart
View File

@ -5,13 +5,15 @@
// DO NOT EDIT. This file was generated from async_compile.dart.
// See tool/synchronize.dart for details.
//
// Checksum: e6de63e581c0f4da96756b9e2904bd81a090dc5b
// Checksum: 2bb00947655b3add16335253802a82188d730595
//
// ignore_for_file: unused_import
import 'async_compile.dart';
export 'async_compile.dart';
import 'dart:convert';
import 'package:path/path.dart' as p;
import 'package:source_maps/source_maps.dart';
import 'package:source_span/source_span.dart';
@ -25,6 +27,7 @@ import 'io.dart';
import 'logger.dart';
import 'sync_package_resolver.dart';
import 'syntax.dart';
import 'utils.dart';
import 'visitor/evaluate.dart';
import 'visitor/serialize.dart';
@ -138,5 +141,17 @@ CompileResult _compileStylesheet(
lineFeed: lineFeed,
sourceMap: sourceMap);
if (serializeResult.sourceMap != null && importCache != null) {
// TODO(nweiz): Don't explicitly use a type parameter when dart-lang/sdk#25490
// is fixed.
mapInPlace<String>(
serializeResult.sourceMap.urls,
(url) => url == ''
? Uri.dataFromString(stylesheet.span.file.getText(0),
encoding: utf8)
.toString()
: importCache.sourceMapUrl(Uri.parse(url)).toString());
}
return CompileResult(evaluateResult, serializeResult);
}

14
lib/src/executable/compile_stylesheet.dart
View File

@ -15,6 +15,7 @@ import '../importer/filesystem.dart';
import '../io.dart';
import '../stylesheet_graph.dart';
import '../syntax.dart';
import '../utils.dart';
import 'options.dart';
/// Compiles the stylesheet at [source] to [destination].
@ -126,15 +127,10 @@ String _writeSourceMap(
sourceMap.targetUrl = p.toUri(p.basename(destination)).toString();
}
for (var i = 0; i < sourceMap.urls.length; i++) {
var url = sourceMap.urls[i];
// The special URL "" indicates a file that came from stdin.
if (url == "") continue;
sourceMap.urls[i] =
options.sourceMapUrl(Uri.parse(url), destination).toString();
}
// TODO(nweiz): Don't explicitly use a type parameter when dart-lang/sdk#25490
// is fixed.
mapInPlace<String>(sourceMap.urls,
(url) => options.sourceMapUrl(Uri.parse(url), destination).toString());
var sourceMapText =
jsonEncode(sourceMap.toJson(includeSourceContents: options.embedSources));

4
lib/src/executable/options.dart
View File

@ -402,7 +402,11 @@ class ExecutableOptions {
/// Makes [url] absolute or relative (to the directory containing
/// [destination]) according to the `source-map-urls` option.
///
/// If [url] isn't a `file:` URL, returns it as-is.
Uri sourceMapUrl(Uri url, String destination) {
if (url.scheme.isNotEmpty && url.scheme != 'file') return url;
var path = p.canonicalize(p.fromUri(url));
return p.toUri(_options['source-map-urls'] == 'relative'
? p.relative(path, from: p.dirname(destination))

27
lib/src/import_cache.dart
View File

@ -5,7 +5,7 @@
// DO NOT EDIT. This file was generated from async_import_cache.dart.
// See tool/synchronize.dart for details.
//
// Checksum: 4989811a7b432e181ccc42004e91f4fe54a786ca
// Checksum: 291afac7e0d5edc6610685b28741786f667f83e8
//
// ignore_for_file: unused_import
@ -15,6 +15,7 @@ import 'package:tuple/tuple.dart';
import 'ast/sass.dart';
import 'importer.dart';
import 'importer/result.dart';
import 'io.dart';
import 'logger.dart';
import 'sync_package_resolver.dart';
@ -39,6 +40,9 @@ class ImportCache {
/// The parsed stylesheets for each canonicalized import URL.
final Map<Uri, Stylesheet> _importCache;
/// The import results for each canonicalized import URL.
final Map<Uri, ImporterResult> _resultsCache;
/// Creates an import cache that resolves imports using [importers].
///
/// Imports are resolved by trying, in order:
@ -63,14 +67,16 @@ class ImportCache {
: _importers = _toImporters(importers, loadPaths, packageResolver),
_logger = logger ?? const Logger.stderr(),
_canonicalizeCache = {},
_importCache = {};
_importCache = {},
_resultsCache = {};
/// Creates an import cache without any globally-avaiable importers.
ImportCache.none({Logger logger})
: _importers = const [],
_logger = logger ?? const Logger.stderr(),
_canonicalizeCache = {},
_importCache = {};
_importCache = {},
_resultsCache = {};
/// Converts the user's [importers], [loadPaths], and [packageResolver]
/// options into a single list of importers.
@ -101,7 +107,8 @@ class ImportCache {
: _importers = const [],
_logger = const Logger.stderr(),
_canonicalizeCache = const {},
_importCache = const {};
_importCache = const {},
_resultsCache = const {};
/// Canonicalizes [url] according to one of this cache's importers.
///
@ -181,6 +188,8 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
return _importCache.putIfAbsent(canonicalUrl, () {
var result = importer.load(canonicalUrl);
if (result == null) return null;
_resultsCache[canonicalUrl] = result;
return Stylesheet.parse(result.contents, result.syntax,
// For backwards-compatibility, relative canonical URLs are resolved
// relative to [originalUrl].
@ -193,8 +202,7 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
/// Return a human-friendly URL for [canonicalUrl] to use in a stack trace.
///
/// Throws a [StateError] if the stylesheet for [canonicalUrl] hasn't been
/// loaded by this cache.
/// Returns [canonicalUrl] as-is if it hasn't been loaded by this cache.
Uri humanize(Uri canonicalUrl) {
// Display the URL with the shortest path length.
var url = minBy(
@ -210,6 +218,12 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
return url.resolve(p.url.basename(canonicalUrl.path));
}
/// Returns the URL to use in the source map to refer to [canonicalUrl].
///
/// Returns [canonicalUrl] as-is if it hasn't been loaded by this cache.
Uri sourceMapUrl(Uri canonicalUrl) =>
_resultsCache[canonicalUrl]?.sourceMapUrl ?? canonicalUrl;
/// Clears the cached canonical version of the given [url].
///
/// Has no effect if the canonical version of [url] has not been cached.
@ -222,6 +236,7 @@ Relative canonical URLs are deprecated and will eventually be disallowed.
///
/// Has no effect if the imported file at [canonicalUrl] has not been cached.
void clearImport(Uri canonicalUrl) {
_resultsCache.remove(canonicalUrl);
_importCache.remove(canonicalUrl);
}
}

34
lib/src/parse/sass.dart
View File

@ -185,15 +185,21 @@ class SassParser extends StylesheetParser {
SilentComment _silentComment() {
var start = scanner.state;
scanner.expect("//");
var buffer = StringBuffer();
var parentIndentation = currentIndentation;
while (true) {
buffer.write("//");
// Skip the first two indentation characters because we're already writing
// "//".
for (var i = 2; i < currentIndentation - parentIndentation; i++) {
outer:
do {
var commentPrefix = scanner.scanChar($slash) ? "///" : "//";
while (true) {
buffer.write(commentPrefix);
// Skip the initial characters because we're already writing the
// slashes.
for (var i = commentPrefix.length;
i < currentIndentation - parentIndentation;
i++) {
buffer.writeCharCode($space);
}
@ -202,11 +208,23 @@ class SassParser extends StylesheetParser {
}
buffer.writeln();
if (_peekIndentation() <= parentIndentation) break;
if (_peekIndentation() < parentIndentation) break outer;
if (_peekIndentation() == parentIndentation) {
// Look ahead to the next line to see if it starts another comment.
if (scanner.peekChar(1 + parentIndentation) == $slash &&
scanner.peekChar(2 + parentIndentation) == $slash) {
_readIndentation();
}
break;
}
_readIndentation();
}
} while (scanner.scan("//"));
return SilentComment(buffer.toString(), scanner.spanFrom(start));
lastSilentComment =
SilentComment(buffer.toString(), scanner.spanFrom(start));
return lastSilentComment;
}
/// Consumes an indented-style loud context.

3
lib/src/parse/scss.dart
View File

@ -158,8 +158,9 @@ class ScssParser extends StylesheetParser {
scanner.spanFrom(start));
}
return SilentComment(
lastSilentComment = SilentComment(
scanner.substring(start.position), scanner.spanFrom(start));
return lastSilentComment;
}
/// Consumes a statement-level loud comment block.

17
lib/src/parse/stylesheet.dart
View File

@ -57,6 +57,10 @@ abstract class StylesheetParser extends Parser {
/// Whether the parser is currently within a parenthesized expression.
var _inParentheses = false;
/// The silent comment this parser encountered previously.
@protected
SilentComment lastSilentComment;
StylesheetParser(String contents, {url, Logger logger})
: super(contents, url: url, logger: logger);
@ -147,6 +151,8 @@ abstract class StylesheetParser extends Parser {
/// Consumes a variable declaration.
@protected
VariableDeclaration variableDeclaration() {
var precedingComment = lastSilentComment;
lastSilentComment = null;
var start = scanner.state;
var name = variableName();
@ -179,7 +185,7 @@ abstract class StylesheetParser extends Parser {
expectStatementSeparator("variable declaration");
return VariableDeclaration(name, value, scanner.spanFrom(start),
guarded: guarded, global: global);
guarded: guarded, global: global, comment: precedingComment);
}
/// Consumes a style rule.
@ -681,6 +687,8 @@ abstract class StylesheetParser extends Parser {
///
/// [start] should point before the `@`.
FunctionRule _functionRule(LineScannerState start) {
var precedingComment = lastSilentComment;
lastSilentComment = null;
var name = identifier();
whitespace();
var arguments = _argumentDeclaration();
@ -708,7 +716,8 @@ abstract class StylesheetParser extends Parser {
whitespace();
var children = this.children(_functionAtRule);
return FunctionRule(name, arguments, children, scanner.spanFrom(start));
return FunctionRule(name, arguments, children, scanner.spanFrom(start),
comment: precedingComment);
}
/// Consumes a `@for` rule.
@ -937,6 +946,8 @@ abstract class StylesheetParser extends Parser {
///
/// [start] should point before the `@`.
MixinRule _mixinRule(LineScannerState start) {
var precedingComment = lastSilentComment;
lastSilentComment = null;
var name = identifier();
whitespace();
var arguments = scanner.peekChar() == $lparen
@ -960,7 +971,7 @@ abstract class StylesheetParser extends Parser {
_mixinHasContent = null;
return MixinRule(name, arguments, children, scanner.spanFrom(start),
hasContent: hadContent);
hasContent: hadContent, comment: precedingComment);
}
/// Consumes a `@moz-document` rule.

7
lib/src/utils.dart
View File

@ -289,6 +289,13 @@ Map<String, V2> normalizedMapMap<K, V1, V2>(Map<K, V1> map,
return result;
}
/// Destructively updates every element of [list] with the result of [function].
void mapInPlace<T>(List<T> list, T function(T element)) {
for (var i = 0; i < list.length; i++) {
list[i] = function(list[i]);
}
}
/// Returns the longest common subsequence between [list1] and [list2].
///
/// If there are more than one equally long common subsequence, returns the one

7
test/cli/shared/source_maps.dart
View File

@ -116,13 +116,16 @@ void sharedTests(Future<TestProcess> runSass(Iterable<String> arguments)) {
});
});
test("with --stdin uses an empty string", () async {
test("with --stdin uses a data: URL", () async {
var sass = await runSass(["--stdin", "out.css"]);
sass.stdin.writeln("a {b: c}");
sass.stdin.close();
await sass.shouldExit(0);
expect(_readJson("out.css.map"), containsPair("sources", [""]));
expect(
_readJson("out.css.map"),
containsPair("sources",
[Uri.dataFromString("a {b: c}\n", encoding: utf8).toString()]));
});
group("with --no-source-map,", () {

35
test/dart_api/importer_test.dart
View File

@ -4,6 +4,9 @@
@TestOn('vm')
import 'dart:convert';
import 'package:source_maps/source_maps.dart';
import 'package:test/test.dart';
import 'package:sass/sass.dart';
@ -86,6 +89,38 @@ main() {
'''));
});
test("uses an importer's source map URL", () {
SingleMapping map;
compileString('@import "orange";',
importers: [
_TestImporter((url) => Uri.parse("u:$url"), (url) {
var color = url.path;
return ImporterResult('.$color {color: $color}',
sourceMapUrl: Uri.parse("u:blue"), indented: false);
})
],
sourceMap: (map_) => map = map_);
expect(map.urls, contains("u:blue"));
});
test("uses a data: source map URL if the importer doesn't provide one", () {
SingleMapping map;
compileString('@import "orange";',
importers: [
_TestImporter((url) => Uri.parse("u:$url"), (url) {
var color = url.path;
return ImporterResult('.$color {color: $color}', indented: false);
})
],
sourceMap: (map_) => map = map_);
expect(
map.urls,
contains(Uri.dataFromString(".orange {color: orange}", encoding: utf8)
.toString()));
});
test("wraps an error in canonicalize()", () {
expect(() {
compileString('@import "orange";', importers: [

200
test/doc_comments_test.dart Normal file
View File

@ -0,0 +1,200 @@
// Copyright 2018 Google Inc. Use of this source code is governed by an
// MIT-style license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.
import 'package:sass/src/ast/sass.dart';
import 'package:test/test.dart';
void main() {
group('documentation comments', () {
group('in SCSS', () {
test('attach to variable declarations', () {
final contents = r'''
/// Results my vary.
$vary: 5.16em;''';
final stylesheet = Stylesheet.parseScss(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, equals('Results my vary.'));
});
test('attach to function rules', () {
final contents = r'''
/// A fun function!
@function fun($val) {
// Not a doc comment.
@return ($val / 1000) * 1em;
}''';
final stylesheet = Stylesheet.parseScss(contents);
final function = stylesheet.children.whereType<FunctionRule>().first;
expect(function.comment.docComment, equals('A fun function!'));
});
test('attach to mixin rules', () {
final contents = r'''
/// Mysterious mixin.
@mixin mystery {
// All black.
color: black;
background-color: black;
}''';
final stylesheet = Stylesheet.parseScss(contents);
final mix = stylesheet.children.whereType<MixinRule>().first;
expect(mix.comment.docComment, equals('Mysterious mixin.'));
});
test('are null when there are no triple-slash comments', () {
final contents = r'''
// Regular comment.
$vary: 5.16em;''';
final stylesheet = Stylesheet.parseScss(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, isNull);
});
test('are not carried over across members', () {
final contents = r'''
/// Mysterious mixin.
@mixin mystery {
// All black.
color: black;
background-color: black;
}
/// A fun function!
@function fun($val) {
// Not a doc comment.
@return ($val / 1000) * 1em;
}''';
final stylesheet = Stylesheet.parseScss(contents);
final mix = stylesheet.children.whereType<MixinRule>().first;
final function = stylesheet.children.whereType<FunctionRule>().first;
expect(mix.comment.docComment, equals('Mysterious mixin.'));
expect(function.comment.docComment, equals('A fun function!'));
});
test('do not include double-slash comments', () {
final contents = r'''
// Not a doc comment.
/// Line 1
/// Line 2
// Not a doc comment.
/// Line 3
// Not a doc comment.
$vary: 5.16em;''';
final stylesheet = Stylesheet.parseScss(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, equals('Line 1\nLine 2\nLine 3'));
});
});
group('in indented syntax', () {
test('attach to variable declarations', () {
final contents = r'''
/// Results my vary.
$vary: 5.16em''';
final stylesheet = Stylesheet.parseSass(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, equals('Results my vary.'));
});
test('attach to function rules', () {
final contents = r'''
/// A fun function!
@function fun($val)
// Not a doc comment.
@return ($val / 1000) * 1em''';
final stylesheet = Stylesheet.parseSass(contents);
final function = stylesheet.children.whereType<FunctionRule>().first;
expect(function.comment.docComment, equals('A fun function!'));
});
test('attach to mixin rules', () {
final contents = r'''
/// Mysterious mixin.
@mixin mystery
// All black.
color: black
background-color: black''';
final stylesheet = Stylesheet.parseSass(contents);
final mix = stylesheet.children.whereType<MixinRule>().first;
expect(mix.comment.docComment, equals('Mysterious mixin.'));
});
test('are null when there are no triple-slash comments', () {
final contents = r'''
// Regular comment.
$vary: 5.16em''';
final stylesheet = Stylesheet.parseSass(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, isNull);
});
test('are not carried over across members', () {
final contents = r'''
/// Mysterious mixin.
@mixin mystery
// All black.
color: black
background-color: black
/// A fun function!
@function fun($val)
// Not a doc comment.
@return ($val / 1000) * 1em''';
final stylesheet = Stylesheet.parseSass(contents);
final mix = stylesheet.children.whereType<MixinRule>().first;
final function = stylesheet.children.whereType<FunctionRule>().first;
expect(mix.comment.docComment, equals('Mysterious mixin.'));
expect(function.comment.docComment, equals('A fun function!'));
});
test('do not include double-slash comments', () {
final contents = r'''
// Not a doc comment.
/// Line 1
Line 2
// Not a doc comment.
Should be ignored.
$vary: 5.16em''';
final stylesheet = Stylesheet.parseSass(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(variable.comment.docComment, equals('Line 1\nLine 2'));
});
test('are compacted into one from adjacent comments', () {
final contents = r'''
// Not a doc comment.
/// Line 1
/// Line 2
Line 3
/// Line 4
$vary: 5.16em''';
final stylesheet = Stylesheet.parseSass(contents);
final variable =
stylesheet.children.whereType<VariableDeclaration>().first;
expect(stylesheet.children.length, equals(2));
expect(variable.comment.docComment,
equals('Line 1\nLine 2\nLine 3\nLine 4'));
});
});
});
}

9
test/synchronize_test.dart
View File

@ -10,14 +10,11 @@ import 'dart:io';
import 'package:crypto/crypto.dart';
import 'package:test/test.dart';
import '../tool/grind/synchronize.dart' as synchronize;
void main() {
test("synchronized files are up-to-date", () {
({
'lib/src/visitor/async_evaluate.dart': 'lib/src/visitor/evaluate.dart',
'lib/src/async_environment.dart': 'lib/src/environment.dart',
'lib/src/async_import_cache.dart': 'lib/src/import_cache.dart'
})
.forEach((sourcePath, targetPath) {
synchronize.sources.forEach((sourcePath, targetPath) {
var source = File(sourcePath).readAsStringSync();
var target = File(targetPath).readAsStringSync();

4
tool/grind/synchronize.dart
View File

@ -13,7 +13,7 @@ import 'package:grinder/grinder.dart';
import 'package:path/path.dart' as p;
/// The files to compile to synchronous versions.
final _sources = const {
final sources = const {
'lib/src/visitor/async_evaluate.dart': 'lib/src/visitor/evaluate.dart',
'lib/src/async_compile.dart': 'lib/src/compile.dart',
'lib/src/async_environment.dart': 'lib/src/environment.dart',
@ -38,7 +38,7 @@ final _sharedClasses = const ['EvaluateResult', 'CompileResult'];
/// to a synchronous equivalent.
@Task('Compile async code to synchronous code.')
synchronize() {
_sources.forEach((source, target) {
sources.forEach((source, target) {
var visitor = _Visitor(File(source).readAsStringSync(), source);
parseDartFile(source).accept(visitor);
var formatted = DartFormatter().format(visitor.result);