From d630d505f4167d4052c37690bfd9bc109af26355 Mon Sep 17 00:00:00 2001 From: Christopher Allford <6451942+ObliviousHarmony@users.noreply.github.com> Date: Mon, 29 Jan 2024 12:03:38 -0800 Subject: [PATCH] Added Config Contribution & Changelog --- CHANGELOG.md | 13 ++++++++++++- package.json | 13 +++++++------ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ed2e9d5..ab86d2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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. diff --git a/package.json b/package.json index 2a1de01..7488d0b 100644 --- a/package.json +++ b/package.json @@ -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.", @@ -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" },