docs(README): clarify path option description (options.config.path)
#371
Conversation
y-gagar1n
requested review from
alexander-akait and
michael-ciniawsky
as code owners
michael-ciniawsky
changed the title
options.config.path)
README.md
Outdated
| |[`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. |
There was a problem hiding this comment.
⚠️ 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' ❌
}
}
|
Fixed |
README.md
Outdated
| @@ -144,20 +144,23 @@ If you use JS styles without the [`postcss-js`][postcss-js] parser, add the `exe | |||
|
|
|||
| 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. 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. | |||
| > ⚠️ Note that you **can't** use a **filename** other than 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 | |||
There was a problem hiding this comment.
Please still leave the previous warning
⚠️ Otherwise it is unnecessary to set this option and is not recommended.
|
Fixed |
michael-ciniawsky
changed the title
options.config.path)path option description (options.config.path)
michael-ciniawsky
added
status: approved
and removed
ci: ok
pr: refactor
priority: medium
status: pending
labels
|
Turns out those ✅ and ❌ symbols are shown as squares on Chrome in Debian. |
|
Can you post a screenshot and does this also happen with other symbols (e.g the various |
|
Hmm, must've been some specific version of Chrome or something. Seen that on my work machine today. Now I check on my personal machine (also Chrome and Debian) and everything is OK. Will discover it more tomorrow. |
|
It's caused by the lack of some system fonts on my Debian. I've made a little research and found out that there are more widely supported symbols for 'cross' and 'check' marks. The downside is that they are not so fancy looking. Here they are with their supported fonts: Used now: ✅ http://www.fileformat.info/info/unicode/char/2705/fontsupport.htm Recommended: ✔ https://www.fileformat.info/info/unicode/char/2714/fontsupport.htm |
|
And here is the screenshot you asked for. Same behavior in Chrome and Opera. Firefox works fine.
|
The description for
pathoption in README.md is a bit misleading. It saysPostCSS Config Pathwhile in fact it sets only the directory where postcss.config.js will be looked for.It leads to a confusion, because users may think that they can set arbitrary name for their config file.
TypeSemVerIssuesChecklist