Merge pull request #1824 from karlhorky/patch-1

ai · web-flow · commit c2e94de4479e · 2023-03-28T00:05:39.000+02:00
Add JSDoc type for config
diff --git a/README.md b/README.md
@@ -241,12 +241,15 @@ module.exports = {
 Then create `postcss.config.js`:
 
 ```js
-module.exports = {
+/** @type {import('postcss-load-config').Config} */
+const config = {
   plugins: [
     require('autoprefixer'),
     require('postcss-nested')
   ]
 }
+
+module.exports = config
 ```
 
 [`astroturf`]: https://github.com/4Catalyzer/astroturf
@@ -259,12 +262,15 @@ and cssnano. If you want to change plugins, create `postcss.config.js`
 in project’s root:
 
 ```js
-module.exports = {
+/** @type {import('postcss-load-config').Config} */
+const config = {
   plugins: [
     require('autoprefixer'),
     require('postcss-nested')
   ]
 }
+
+module.exports = config
 ```
 
 Parcel will even automatically install these plugins for you.
@@ -308,12 +314,15 @@ module.exports = {
 Then create `postcss.config.js`:
 
 ```js
-module.exports = {
+/** @type {import('postcss-load-config').Config} */
+const config = {
   plugins: [
     require('autoprefixer'),
     require('postcss-nested')
   ]
 }
+
+module.exports = config
 ```
 
 [`postcss-loader`]: https://github.com/postcss/postcss-loader
