Validate settings alignment between README.md and package.json in pipeline and pre-commit.
⚡️ What's your motivation?
Extension settings must be specified in package.json for VSCode, and additionally in the README for documentation purposes. This leads to two sources for the same information.
Although a script exists to update associated README changes in package.json, there is no validation in the pipeline or pre-commit that this has been applied; which has previously resulted in the two files going out of sync.
Codifying these rules removes the need for implicit knowledge for maintaining and contributing to the project; and removes the need to check that these rules have been applied during code review.
🏷️ What kind of change is this?
:bank: Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)
🤔 What's changed?
Validate settings alignment between README.md and package.json in pipeline and pre-commit.
⚡️ What's your motivation?
Extension settings must be specified in package.json for VSCode, and additionally in the README for documentation purposes. This leads to two sources for the same information.
Although a script exists to update associated README changes in package.json, there is no validation in the pipeline or pre-commit that this has been applied; which has previously resulted in the two files going out of sync.
Codifying these rules removes the need for implicit knowledge for maintaining and contributing to the project; and removes the need to check that these rules have been applied during code review.
🏷️ What kind of change is this?
📋 Checklist: