From d2cec3776dfc1398841f3df190f611b8a79a95ca Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Mon, 20 Mar 2023 04:04:24 -0700 Subject: [PATCH] Clarify postcss config option (#2013) Closes #2005 --- content/en/hugo-pipes/postcss.md | 119 +++++++++++++++++++++---------- 1 file changed, 83 insertions(+), 36 deletions(-) diff --git a/content/en/hugo-pipes/postcss.md b/content/en/hugo-pipes/postcss.md index caf575c17..d96c8a443 100755 --- a/content/en/hugo-pipes/postcss.md +++ b/content/en/hugo-pipes/postcss.md @@ -1,74 +1,121 @@ --- title: PostCSS -description: Hugo Pipes can process CSS files with PostCSS. +description: Use PostCSS to transform CSS using any of the available plugins. categories: [asset management] keywords: [] menu: docs: parent: "pipes" weight: 40 +toc: true weight: 40 --- -Any asset file can be processed using `resources.PostCSS` which takes for argument the resource object and a slice of options listed below. +## Setup -The resource will be processed using the project's or theme's own `postcss.config.js` or any file set with the `config` option. +Follow the steps below to transform CSS using any of the [available PostCSS plugins](https://www.postcss.parts/). -```go-html-template -{{ $css := resources.Get "css/main.css" }} -{{ $style := $css | resources.PostCSS }} -``` +Step 1 +: Install [Node.js](https://nodejs.org/en/download). -You must install the required Node.js packages to use the PostCSS feature. For example, to use the `autoprefixer` package, run these commands from the root of your project: +Step 2 +: Install the required Node.js packages in the root of your project. For example, to add vendor prefixes to CSS rules: -```text +```bash npm install postcss postcss-cli autoprefixer ``` -### Options +Step 3 +: Create a PostCSS configuration file in the root of your project. You must name this file `postcss.config.js` or one of the other [supported file names]. For example: -config [string] -: Set a custom directory to look for a config file +[supported file names]: https://github.com/postcss/postcss-load-config#usage -noMap [bool] -: Default is `false`. Disable the default inline sourcemaps +{{< code file="postcss.config.js" >}} +module.exports = { + plugins: [ + require('autoprefixer') + ] +}; +{{< /code >}} -inlineImports [bool] -: Default is `false`. Enable inlining of @import statements. It does so recursively, but will only import a file once. +{{% note %}} +If you are a Windows user, and the path to your project contains a space, you must place the PostCSS configuration within the package.json file. See [this example](https://github.com/postcss/postcss-load-config#packagejson) and issue [#7333](https://github.com/gohugoio/hugo/issues/7333). +{{% /note %}} + +Step 4 +: Place your CSS file within the `assets` directory. + +Step 5 +: Capture the CSS file as a resource and pipe it through `resources.PostCSS` (alias `postCSS`): + +{{< code file="layouts/partials/css.html" >}} +{{ with resources.Get "css/main.css" | postCSS }} + +{{ end }} +{{< /code >}} + +If starting with a Sass file within the `assets` directory: + +{{< code file="layouts/partials/css.html" >}} +{{ with resources.Get "sass/main.scss" | toCSS | postCSS }} + +{{ end }} +{{< /code >}} + +## Options + +The `resources.PostCSS` method takes an optional map of options. + +config +: (string) The directory that contains the PostCSS configuration file. Default is the root of the project directory. + +noMap +: (bool) Default is `false`. If `true`, disables inline sourcemaps. + +inlineImports +: (bool) Default is `false`. Enable inlining of @import statements. It does so recursively, but will only import a file once. URL imports (e.g. `@import url('https://fonts.googleapis.com/css?family=Open+Sans&display=swap');`) and imports with media queries will be ignored. Note that this import routine does not care about the CSS spec, so you can have @import anywhere in the file. Hugo will look for imports relative to the module mount and will respect theme overrides. -skipInlineImportsNotFound [bool] {{< new-in "0.99.0" >}} -: Default is `false`. Before Hugo 0.99.0 when `inlineImports` was enabled and we failed to resolve an import, we logged it as a warning. We now fail the build. If you have regular CSS imports in your CSS that you want to preserve, you can either use imports with URL or media queries (Hugo does not try to resolve those) or set `skipInlineImportsNotFound` to true. +skipInlineImportsNotFound {{< new-in "0.99.0" >}} +: (bool) Default is `false`. Before Hugo 0.99.0 when `inlineImports` was enabled and we failed to resolve an import, we logged it as a warning. We now fail the build. If you have regular CSS imports in your CSS that you want to preserve, you can either use imports with URL or media queries (Hugo does not try to resolve those) or set `skipInlineImportsNotFound` to true. -_If no configuration file is used:_ +{{< code file="layouts/partials/css.html" >}} +{{ $opts := dict "config" "config-directory" "noMap" true }} +{{ with resources.Get "css/main.css" | postCSS $opts }} + +{{ end }} +{{< /code >}} -use [string] -: Space-delimited list of PostCSS plugins to use +## No configuration file -parser [string] -: Custom PostCSS parser +To avoid using a PostCSS configuration file, you can specify a minimal configuration using the options map. -stringifier [string] -: Custom PostCSS stringifier +use +: (string) A space-delimited list of PostCSS plugins to use. -syntax [string] -: Custom postcss syntax +parser +: (string) A custom PostCSS parser. -```go-html-template -{{ $options := dict "config" "/path/to/custom-config-directory" "noMap" true }} -{{ $style := resources.Get "css/main.css" | resources.PostCSS $options }} +stringifier +: (string) A custom PostCSS stringifier. -{{ $options := dict "use" "autoprefixer postcss-color-alpha" }} -{{ $style := resources.Get "css/main.css" | resources.PostCSS $options }} -``` +syntax +: (string) Custom postcss syntax. -## Check Hugo Environment from postcss.config.js +{{< code file="layouts/partials/css.html" >}} +{{ $opts := dict "use" "autoprefixer postcss-color-alpha" }} +{{ with resources.Get "css/main.css" | postCSS $opts }} + +{{ end }} +{{< /code >}} + +## Check Hugo environment The current Hugo environment name (set by `--environment` or in config or OS environment) is available in the Node context, which allows constructs like this: -```js +{{< code file="postcss.config.js" >}} module.exports = { plugins: [ require('autoprefixer'), @@ -77,4 +124,4 @@ module.exports = { : [] ] } -``` +{{< /code >}}