dart_sass_transformer 0.5.0+1

  • README.md
  • Installing
  • Versions
  • 16

Build Status

Sass integration for pub #

Sass-transformer for pub-serve and pub-build.

Usage #

Simply add the following lines to your pubspec.yaml:

  dart_sass_transformer: any
  - dart_sass_transformer

After adding the transformer your .sass and .scss files will be automatically transformed to corresponding .css files.

You need to have Sass installed and available on the path.

Configuration #

You can also pass options to Sass if necessary:

  - dart_sass_transformer:
      executable: /path/to/sass     # Sass executable to use
      compass: true                 # Include compass
      line-numbers: true            # Include line numbers in output
      style: compact                # Style of generated CSS
      copy-sources: true            # Copy original .scss/.sass files to output directory

Using SassC #

You can use SassC instead of normal Sass by specifying executable as 'sassc' (or any path ending with 'sassc'):

  - dart_sass_transformer:
      executable: sassc  # or /path/to/sassc

SassC only supports .scss-files and does not support Compass.

Inlined transformer #

Normally the transformer simply asks Sass to process the primary input files and Sass will then read the dependent inputs from file system. However, if the input files for Sass are themselves produced by other transformers, they might not exist on the file system at all. The normal transformer will not work in those cases.

To work around this problem, you can use inlined_sass_transformer. It will use Barback's APIs to read and inline all imports into one big Sass file which it will then pass to Sass. The downside is that line numbers on error messages and source maps might be incorrect. (See Issue #4 for details.)

To enable the use of inlined transformer, use sass/inlined_sass_transformer as your transformer:

  - dart_sass_transformer/inlined_sass_transformer
      <possible configuration settings>

Current limitations #

  • UTF8-encoding is assumed for all input files.

v0.5.0+1 (2016-10-16) #

  • Package name changed from sass to dart_sass_transformer

v0.4.2 (2014-11-03) #

  • Fixed files over 1024 bytes getting truncated on Windows. (#19) (Thanks to Alexander Sergeev.)
  • Normalize the load paths to platform's native format. (Thanks to llamadonica.)

v0.4.1 (2014-10-09) #

  • Filter out external packages when resolving imports. (#12) (Thanks to Konstantin Borisov.)

v0.4.0 (2014-09-22) #

  • Support for new inlined_sass_transformer. (#4) (Thanks to Dan Schultz.)
  • Require Barback 0.15.x.

v0.3.2 (2014-09-17) #

  • Support Barback 0.15.x.

v0.3.1 (2014-06-24) #

  • Use sass.bat as default executable on Windows. (#10) (Thanks to Nicholas Tuck.)

v0.3.0 (2014-05-25) #

  • Breaking change: don't copy source .scss/.sass files to build directory by default. Use copy-sources: true to keep the old behavior. (#7)
  • Support imports with directory names. (#8)

v0.2.2 (2014-05-23) #

  • Require Barback 0.13.x.
  • Fixed DeclaringTransformer on Barback 0.13.x.

v0.2.1 (2014-05-15) #

  • Implemented DeclaringTransformer interface so Barback can optimize the asset graph.
  • Compatibility with Barback 0.13.x.

v0.2.0 (2014-05-15) #

  • Exclude URL-imports when parsing imports. (Thanks to Vikraman Choudhury.)

v0.1.1 (2014-04-24) #

  • Ignore Compass imports when reading the dependencies of a module. (Thanks to Dan Schultz.)

v0.1.0 (2014-04-19) #

  • Support using SassC instead of vanilla Sass.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  dart_sass_transformer: ^0.5.0+1

2. Install it

You can install packages from the command line:

with pub:

$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:dart_sass_transformer/inlined_sass_transformer.dart';
import 'package:dart_sass_transformer/sass.dart';
import 'package:dart_sass_transformer/transformer.dart';
Version Uploaded Documentation Archive
0.5.0+1 Oct 19, 2016 Go to the documentation of dart_sass_transformer 0.5.0+1 Download dart_sass_transformer 0.5.0+1 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.