Giter VIP home page Giter VIP logo

files-to-sass's Introduction

Files to Sass

Converts a list of files to (a map of) Sass variables with their content.

GitHub | NPM | @jelmerdemaat

Early beta

Don't use if you're not me or Michel! Yet.

Configuration

Use as follows:

var filesToSass = require('files-to-sass');

filesToSass({
    src: '/path/to/source/folder/',
    dest: '/path/to/dest/file.scss',
    useSassMap: true,           // default is false
    sassMapName: 'MyFiles',     // defaults to: 'fileMap'
    debug: true
});

Using Gulp it's possible to access this module directly:

var filesToSass = require('files-to-sass');

gulp.task('import', function () {
    filesToSass({
        src: '/path/to/source/folder/',
        dest: '/path/to/dest/file.scss',
        useSassMap: true,
        sassMapName: 'MyFiles',
        debug: true
    });
});

Example output, using SVG's as input, would be:

$logo: '<svg width="58" height="56" viewBox="0 0 58 56"><g fill="#163962"...';
$icon-download: '<svg width="12" height="12" viewBox="0 0 12 12"><g fill="#000"...';
$icon-arrow-right: '<svg width="15" height="15" viewBox="0 0 15 15"><g fill="#fd0"...';

With SassMap:

$fileMap: (
    logo: '<svg width="58" height="56" viewBox="0 0 58 56"><g fill="#163962"...';
    icon-download: '<svg width="12" height="12" viewBox="0 0 12 12"><g fill="#000"...';
    icon-arrow-right: '<svg width="15" height="15" viewBox="0 0 15 15"><g fill="#fd0"...';
);

Options

options.src

Required. Sets the path to the source folder.

options.dest

Required. Sets the path and name of the destination Sass file, including extension.

options.debug

Optional. Set to true if you want to see which files are being processed.

options.useSassMap

Optional. Set to true if you want to output a Sass map.

options.sassMapName

Optional. String to be use as the Sass map variable name the $ will be prepended.

Todo

  • Add ability to use files as source input.
  • Add option to use maps in stead of plain variables.

files-to-sass's People

Contributors

jelmerdemaat avatar sebsmi avatar

Watchers

Sebastiaan Smid avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.