https://github.com/mrkmg/nativesass

A sass compiler using the real sass compiler
https://github.com/mrkmg/nativesass

Last synced: 16 days ago
JSON representation

A sass compiler using the real sass compiler

• Host: GitHub
• URL: https://github.com/mrkmg/nativesass
• Owner: mrkmg
• Created: 2014-11-02T19:59:30.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-13T15:55:48.000Z (over 9 years ago)
• Last Synced: 2024-10-04T09:59:04.162Z (about 1 month ago)
• Language: PHP
• Size: 223 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
NativeSass

==========

NativeSass will compile your sass and scss files using the sass command on your system.

It allows for a variety of options and comes with a ServiceProvider for Laravel.

Installation

------------

First, ensure that Sass is installed on your system. To do that see [Sass Install](http://sass-lang.com/install).

Next, install NativeSass via composer.

    composer require mrkmg/native-sass

___With Laravel 4___

Add the service provider to your app config (app/config/app.php)

    'mrkmg\NativeSass\CompilerServiceProvider'

    

Install the configuration file

    

    php artisan config:publish mrkmg/native-sass

Update the configuration file to your needs.

Usage

----

___Generic Usage___

Instantiate a new instance of the compiler with the desired options.

    $compiler = new \mrkmg\NativeSass\Compiler([

        'compilerPath'  => 'sass',

        'inputPath'     => '/some/path/to/raw/sass',

        'outputPath'    => '/some/path/for/compiled/css',

        'outputStyle'   => 'expanded', //Options are nested, compact, compressed, or expanded

        'sourceMap'     => 'file', //Options are auto, inline, file, or none

    ]);

    

For all the following examples, if you pass a relative path, it is assumed to be relative to the `inputPath`. If

you pass an absolute path (any path starting with a /) then the path is used as is.

    

If you wish to compile a single file into CSS, use the `compileSingle` method.

    

    //Keep the same name. Will create rawfile.css and rawfile.css.map in the outputPath

    $compiler->compileSingle('rawfile.sass');

    

    //Custom output name and paths. Will create newname.css and newname.css.map in /some/other/output/

    $compiler->compileSingle('/some/other/path/rawfile.scss', '/some/other/output/newname.css');

You can also compile many files at once. Use the `compileMany` method which takes an array of files.

    

    //Compiles many files.

    $compiler->compileMany([

        'rawfile.sass',

        'rawfile2.sass',

        'rawfile3.sass' => 'alternatename.css'

    ]);

Finally, you can compile an entire directory of CSS files all at once with the `compileAll` method. By default, only

files in the top directory are compiled.

    

    //Compiles all files in the inputPath into the outputPath

    $compiler->compileAll();

    

    //Compiles all files in a specific directory into the outputPath

    $compiler->compileAll('/some/other/sourcedir/');

    

    //Compile all files in the inputPath, and 2 levels deep of sub-directories, into the outputPath

    $compiler->compileAll("", 2);

___With Laravel___

The class in instantiated automatically and all methods made available via the alias NativeSass.

For example, to run compile a single file:

    

    NativeSass::compileSingle('rawfile.sass');

    

Usage is the same as above.

Optional Command for Laravel 4

------------------------------

If you wish to compile all your sass via a console command in artisan, create the following command:

Create app/command/CompileSass.php