@css-blocks/config

CSS Blocks Configuration

Loads configuration for css-blocks from standardized locations so that build integrations, text editors, and the cli can all interoperate with the same configuration.

Installation

yarn add @css-blocks/config

Usage

import { Options as CSSBlocksOptions } from "@css-blocks/core";
import * as config from '@css-blocks/config';
// finds configuration starting in the current working directory.
let opts: CSSBlocksOptions | null = config.search();

// finds configuration starting in the specified directory;
opts = config.search(__dirname);

// loads a specific configuration file:
opts = config.load("config/css-blocks.js");

Configuration Options

The values specified in the configuration files are expected to be legal options for the CSS Blocks configuration. However, there are a few exceptions:

• preprocesors - This can be set to a file location of a javascript file that exports one or more preprocessors. The properties exported should correspond to the supported syntaxes.
• importer - This can be set to a file location of a javascript file that exports an object with keys of importer and (optionally) data. If data is returned, it takes precedence over a configuration value for importerData in the current configuration file.
• extends - If provided, this configuration file located at the provided path is loaded and this configuration is deeply merged into it. Note: the values for importer and importerData are not deeply merged.
• rootDir - If this configuration property is not set explicitly, the directory of the configuration file is used.

Note: Any path to another file or directory is interpreted as being relative to the directory of the file containing the path.

Changelog

1.5.0 (2020-09-16)

Bug Fixes

• Missed one package that needed an opticss upgrade. (6a2345e)
• Pass a copy of sass options for sync setup. (eaf06b6)
• Pick up fix for opticss crash on unknown css declarations. (55f2245)
• Prune css-blocks.css from the output after concatenating it. (a663364)
• Remove some lingering traces of the async factory. (23308e1)
• Set eyeglass root within a directory-scoped processor. (cb72810)
• Update the debug identifier for BlockFactorySync. (17588e3)

Features

• Add file+loc to class name conflict error. (82e4cfd)
• Class name collision detection. (31afe26)
• Scan app CSS for classes. (3ec0216)
• Synchronous Block Factory. (0b31607)
• Update eyeglass integration to support synchronous preprocessing. (f3b11af)