Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Error on Invalid PostCSS Shape (#10244)
* Error on Invalid PostCSS Shape * Add link to docs
- Loading branch information
Showing
2 changed files
with
136 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
# Invalid PostCSS Configuration | ||
|
||
#### Why This Error Occurred | ||
|
||
PostCSS configuration was provided in an unsupported shape. | ||
|
||
#### Possible Ways to Fix It | ||
|
||
PostCSS configuration must be defined in the following shape: | ||
|
||
```js | ||
module.exports = { | ||
plugins: [ | ||
// A plugin that does not require configuration: | ||
'simple-plugin-example', | ||
|
||
// A plugin which needs a configuration object: | ||
[ | ||
'plugin-with-configuration', | ||
{ | ||
optionA: '...', | ||
}, | ||
], | ||
|
||
// A plugin that is toggled on or off based on environment: | ||
[ | ||
'plugin-toggled', | ||
process.env.NODE_ENV === 'production' | ||
? { | ||
optionA: '...', | ||
} | ||
: false, | ||
], | ||
|
||
// Boolean expressions are also valid. | ||
// `true` enables the plugin, `false` disables the plugin: | ||
['plugin-toggled-2', true /* a === b, etc */], | ||
], | ||
} | ||
``` | ||
|
||
You can [read more](https://nextjs.org/docs/advanced-features/customizing-postcss-config) about configuring PostCSS in Next.js [here](https://nextjs.org/docs/advanced-features/customizing-postcss-config). | ||
|
||
#### Common Errors | ||
|
||
**Before: plugin is require()'d** | ||
|
||
```js | ||
const pluginA = require('postcss-plugin-a') | ||
module.exports = { | ||
plugins: [require('postcss-plugin'), pluginA], | ||
} | ||
``` | ||
|
||
**After** | ||
|
||
```js | ||
module.exports = { | ||
plugins: ['postcss-plugin', 'postcss-plugin-a'], | ||
} | ||
``` | ||
|
||
--- | ||
|
||
**Before: plugin is instantiated with configuration** | ||
|
||
```js | ||
module.exports = { | ||
plugins: [ | ||
require('postcss-plugin')({ | ||
optionA: '...', | ||
}), | ||
], | ||
} | ||
``` | ||
|
||
**After** | ||
|
||
```js | ||
module.exports = { | ||
plugins: [ | ||
// Pay attention to this nested array. The first index is the plugin name, | ||
// the second index is the configuration. | ||
[ | ||
'postcss-plugin', | ||
{ | ||
optionA: '...', | ||
}, | ||
], | ||
], | ||
} | ||
``` | ||
|
||
--- | ||
|
||
**Before: plugin is missing configuration** | ||
|
||
```js | ||
module.exports = { | ||
plugins: [ | ||
[ | ||
'postcss-plugin-1', | ||
{ | ||
optionA: '...', | ||
}, | ||
], | ||
// This single-entry array is detected as misconfigured because it's | ||
// missing the second element. To fix, unwrap the value. | ||
['postcss-plugin-2'], | ||
], | ||
} | ||
``` | ||
|
||
**After** | ||
|
||
```js | ||
module.exports = { | ||
plugins: [ | ||
[ | ||
'postcss-plugin-1', | ||
{ | ||
optionA: '...', | ||
}, | ||
], | ||
// Only string: | ||
'postcss-plugin-2', | ||
], | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters