Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.68 KB

DEVELOPMENT.md

File metadata and controls

45 lines (29 loc) · 2.68 KB

vscode-phpcbf

Current Version Installs GitHub issues Commitizen friendly

Integrates phpcs & phpcbf into Visual Studio Code.

This extension is designed to use an auto config search functionality. When it finds a configuration file through auto search this extension should use that configuration file to create reports with phpcs and apply fixes with phpcbf based on the same configuration.

Setup Development Version

Run/Debug Development Version

To run the development version of the vscode-phpsab extension:

  • open the cloned repository folder using Visual Studio Code
  • select sidebar option Debug
  • press Start Debugging button or hit F5

This will launch a new VS Code window named Extension Development Host, automatically using the development version of the vscode-phpsab extension.

Installing the Development Version

To install a development version of this extension for testing you will need to install the vsce package and package the project into a .vsix file.

  • Install vsce: npm install -g @vscode/vsce
  • In the root of the project run: vsce package
  • From the VSCode main menu, select "Extensions", click the ... on the Extensions tab.
  • Find the option that is Install from VSIX... and follow the prompts.
  • After installing, you may need to reload VSCode.

Publishing Releases

Using the Release system on Github, draft a new release with the desired version tag. The github workflow should handle updating the package.json version and publishing the release to both Vs Marketplace and the Open VSX Registry. These both require a PAT to be set in the security section on github.com and will occasionally need to be updated or rotated if the publishing workflow fails.

Commit Messages

In order to provide some unit to commit messages and make the changelog more valuable we will use commitizen. To make a commit message use git cz and follow the prompts.