Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(README): clarify path option description (options.config.path) #371

Merged
merged 3 commits into from
Jul 16, 2018
Merged

docs(README): clarify path option description (options.config.path) #371

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fe8b08
clarify 'path' option description in docs
y-gagar1n Jul 14, 2018
c868dd0
fixes after review
y-gagar1n Jul 15, 2018
5e3aa5d
fix after review
y-gagar1n Jul 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,14 @@ If you use JS styles without the [`postcss-js`][postcss-js] parser, add the `exe

|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Path|
|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Directory|
|[`context`](#context)|`{Object}`|`undefined`|PostCSS Config Context|

#### `Path`

You can manually specify the path to search for your config (`postcss.config.js`) with the `config.path` option. This is needed if you store your config in a separate e.g `./config || ./.config` folder.

> ⚠️ Otherwise it is **unnecessary** to set this option and is **not** recommended
> ⚠️ Otherwise it is **unnecessary** to set this option and is **not** recommended. You **can't** set other name for **postcss.config.js**, this option only allows you to specify the folder where it will be looked for.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Note that you can't use other filename other then the supported config formats (e.g .postcssrc.js, postcss.config.js), this option only allows you to manually specify the directory where config lookup should start from

webpack.config.js

{
   config: {
      path: 'path/to/.config/' ✅ 
      path: 'path/to/.config/css.config.js' ❌ 
   }
}


**webpack.config.js**
```js
Expand Down