Skip to content

Commit

Permalink
Added Config Contribution & Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ObliviousHarmony committed Jan 29, 2024
1 parent 71e80e8 commit d630d50
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added
- Support using an `obliviousharmony/vscode-phpcs-integration` Composer package to provide
the integration files when a new `phpCodeSniffer.autoloadPHPCSIntegration` option
is enabled.

### Removed
- **BREAKING:** The `phpCodeSniffer.specialOptions.phpcsIntegrationPathOverride` option
has been removed in favor of using `phpCodeSniffer.autoloadPHPCSIntegration`.
There is no reason to set a manual asset path since the Composer package accomplishes
the same thing with an easier-to-use configuration path.

## [2.3.0] - 2024-01-26
### Added
Expand Down Expand Up @@ -42,7 +52,8 @@ for platform-specific executables.
- Support for execution on Windows without the use of WSL.

### Changed
- **BREAKING:** Even if `phpCodeSniffer.autoExecutable` is enabled, the working directory given to PHPCS should always be the workspace root.
- **BREAKING:** Even if `phpCodeSniffer.autoExecutable` is enabled, the working directory given to
PHPCS should always be the workspace root.

### Deprecated
- `phpCodeSniffer.executable` has been deprecated in favor of platform-specific executable options.
Expand Down
13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@
"default": false,
"scope": "resource"
},
"phpCodeSniffer.autoloadPHPCSIntegration": {
"type": "boolean",
"default": false,
"markdownDescription": "Whether or not the PHPCS integration files are available through the autoloader. This should only be enabled when the integration files are provided via Composer.",
"scope": "resource"
},
"phpCodeSniffer.exec.linux": {
"type": "string",
"markdownDescription": "The path to the PHPCS executable we want to use on Linux when `#phpCodeSniffer.autoExecutable#` is disabled or unable to find one.",
Expand Down Expand Up @@ -134,12 +140,7 @@
"type": "object",
"description": "An object of special options for the extension that serve more narrow use-cases.",
"default": {},
"properties": {
"phpcsIntegrationPathOverride": {
"type": "string",
"description": "Overrides the path to the directory that contains the extension's PHPCS integration."
}
},
"properties": {},
"additionalProperties": false,
"scope": "resource"
},
Expand Down

0 comments on commit d630d50

Please sign in to comment.