Skip to content

[Repo Assist] docs: document configSearch setting and standard variable substitution #95

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

Draft
github-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[Repo Assist] docs: document configSearch setting and standard variable substitution #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ This extension has the following settings:
* `phpcbf.documentFormattingProvider`: [ Optional | Default: `true` ] Register PHP document formatting provider, right mouse-click context menu, select 'Format Document'
* `phpcbf.onsave`: [ Optional | Default: `false` ]. Format on save. `"editor.formatOnSave": true` will override this setting.
* `phpcbf.debug`: [ Optional | Default: `false` ]. Write phpcbf stdout to the console.
* `phpcbf.standard`: [ Optional | Default: `null` ]. The [coding standard](#coding-standards).
* `phpcbf.standard`: [ Optional | Default: `null` ]. The [coding standard](#coding-standards). Supports variable substitution:
* `${workspaceFolder}/phpcs.xml`
* `${workspaceRoot}/phpcs.xml` (deprecated alias for `${workspaceFolder}`)
* `~/standards/MyStandard`
* `phpcbf.configSearch`: [ Optional | Default: `false` ]. When `true`, automatically searches the file's directory and parent directories (up to the workspace root) for a phpcs configuration file (`.phpcs.xml`, `phpcs.xml`, `phpcs.xml.dist`, etc.) and uses it as the coding standard. This is useful when different sub-projects within a workspace use different standards.


The default settings are
Expand All @@ -46,7 +50,8 @@ The default settings are
"phpcbf.executablePath": "phpcbf",
"phpcbf.documentFormattingProvider": true,
"phpcbf.onsave": false,
"phpcbf.standard": null
"phpcbf.standard": null,
"phpcbf.configSearch": false
}
```

Expand Down