Code Monkey home page Code Monkey logo

postsass's Introduction

Powered by Tanuel Documentation npm npm

PostSass - Sass x PostCSS cli compiler

PostSass is a cli tool to build scss files via dart-sass and PostCSS

Installation

Requirements:

  • Node 12.x (Not tested for older versions)
  • yarn or npm

Using yarn

yarn add -D postsass

Using npm

npm install postsass --save-dev

Usage

PostSass will compile all .sass and .scss files to css, except partials starting with _, according to sass spec.

Basic

# compile files in the same directory
yarn postsass --dir src

# compile files from src to dist (keeping directory structure
yarn postsass --dir scss:css

#compile multiple directories
yarn postsass --dir scss:css --dir fonts
# -> write files from directory scss to css
# -> write files from directory fonts to fonts

Cli options

Option Values Description
--help - Show overview of commands
--version - Show version
--dir
-d
- Read files from source and write them to the destination if specified
e.g. --dir src or --dir src:dist
--outputStyle
--style
-s
compressed or expanded output style according to dart sass
--sourceMap true or false generate sourcemaps
--context default: process.cwd() The working directory where to look for source files. Needs to be an absolute path
--watch - Enable watch mode

Configuration File and Postcss Plugins

You can provide a file named postsass.config.js to provide configuration and plugins for PostCSS

The file needs to be located in the working directory (process.cwd())

Example

const path = require("path");
const autoprefixer = require("autoprefixer");
const oldie = require("oldie");
const postcssUrl = require("postcss-url");

module.exports = {
  sass: {
    includePaths: [path.dirname(require.resolve("modern-normalize"))],
  },
  postcss: {
    plugins: [
      autoprefixer({ grid: "autoplace" }),
      oldie({
        rgba: {
          filter: true,
        },
      }),
    ],
    // when using the "use" property, you can pass callbacks to configure plugins at compile time
    // "from" gives you the source filename
    // "to" gives you the destination filename
    use: [
      // example: inline svg files, resolve relatively to file
      ({ from, to }) => postcssUrl({ filter: /\.svg$/, url: "inline", basePath: path.dirname(from) }),
    ],
  },
};

Why not postcss.config.js?

We do not want to conflict with other configuration files. This would give us limitations and we would have to be aware of compatibility issues. Postsass is not intended to be used along postcss-cli or webpack or any other compiler tools, but is aimed to work standalone for those who don't use a bundler

postsass's People

Contributors

renovate[bot] avatar iwt-danielschuster avatar tanuel avatar renovate-bot 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.