npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@realgeeks/sassquanch

v0.0.6

Published

Squanch style dependencies and combine into one flat file

Downloads

188

Readme

sassquanch

Define style dependencies on files distributed through npm, resolve them, collect them, and combine them into a vendor import.

Usage

npx @realgeeks/sassquanch -f /path/to/your/package.json /path/to/output/file.scss

Or install globally:

npm install -g @realgeeks/sassquanch
sassquanch -f /path/to/your/package.json /path/to/output/file.scss

For help:

npx @realgeeks/sassquanch --help

Configuration

By default, sassquanch will look in the current working directory for a package.json file. It expects to find a section title styleDependencies with the following schema.

{
  "styleDependencies": [
    {
      "package": "rag",
      "path": "_style.scss"
    },
    {
      "package": "@realgeeks/mapsearch",
      "path": "dist/styles.scss"
    },
    {
      "package": "@realgeeks/rg-modal",
      "path": "dist/_style.scss"
    }
  ]
}

styleDependencies must be an array of objects, where each object specifies:

  • package: The node module that contains the style dependency
  • path: The path to the style dependency within that module's root

For each listed dependency, sassquanch will attempt to find and resolve paths to each style file. It will then read the entirety of the contents and combine all of the contents into one single file.

NOTE: It is not a requirement to include your styleDependencies within your package.json, it is merely a suggestion. If you wish to keep your style dependencies in a separate file, you may specify a path to a json file with the -f flag. Keep in mind, if you do this, you will also need to specify the node_modules path with the -m flag, since by default we assume that the dependencies are within the package.json at the project root. An example of this could be:

sassquanch -f /path/to/style_deps.json -m /path/to/project/root/ vendor.scss

Caveats

If any of your dependencies have relative imports, these imports will be included in the final file as-is. If you wish to prepare your dependency styles in order to work with sassquanch, then you may want to run them through sass-flatten to resolve the imports first.

In the future, sassquanch may do this automatically.

Development

Transpile and watch for file changes:

npm run dev

Run the development bin:

npm run start:dev

# With flags
npm run start:dev -- -f /path/to/package.json vendor.scss

Build the development version without watch mode:

npm run build:dev

Build the production version:

npm run build