Thank you for your interest in the Materialize extension for Visual Studio Code! Contributions of many kinds are encouraged and most welcome.
If you have questions, please create a GitHub issue.
- NPM and NodeJS
- Visual Studio Code
- Docker
- Clone the repository:
git clone https://github.com/MaterializeInc/vscode-extension.git
- Install the dependencies:
npm install
- Build the extension:
npm run esbuild
The extension runs in a parallel instance of Visual Studio Code. To start it, press F5 or click the play button located in the Run and Debug section:
- Run Materialize in docker:
docker run -v mzdata:/mzdata -p 6875:6875 -p 6876:6876 materialize/materialized
- Run the VSCode tests:
npm run test
A GitHub Action will release the new version to the Visual Studio Marketplace.
Follow these instructions to trigger the action:
- Update the
package.json
to the new version. - Write the new changes to the
CHANGELOG.md
. - Run the following commands
VERSION=vX.Y.Z git branch -D release git checkout -b release git commit -am "release $VERSION" git push --set-upstream origin release gh pr create
- Merge the pull request and push the tag by running the following commands:
git checkout main git pull git checkout MERGED-SHA git tag -am $VERSION $VERSION git push --tags gh release create $VERSION