Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 2.12 KB
Raw

Want to contribute?

Microsoft's documentation for VS Code extensions is suprisingly good (https://code.visualstudio.com/docs/extensions/overview);

On Linux

Works at least on Kubuntu.

  1. install VS Code, npm, nodejs, optionally zshdb (some time ago nodejs-legacy was required) + build essentials
  2. clone project
  3. disable auto carriage return git config core.autocrlf false; git reset --hard
  4. open VS Code, select project's folder, open terminal and type npm install (this will download dependencies)
  5. Run by clicking Ctrl+F5, new VS window will open
  6. Create some folder with one script file, then try debugging it by F5 (to debug zshDebug.ts, read this -> basically set Extension + Server in debug pane, then set "debugServer": 4711 configuration in launch.json of zsh project)

On Windows 10

All the pieces seem to be there, but for some reason zsh support needs some kick off (https://github.com/Microsoft/ZshOnWindows/issues/2#issuecomment-209118529).

Currently, with some hacks, seems to be working on Windows 10. The scripts are executed in zsh@linux realm,so all the paths inside scripts need to refer to linux filesystem (/mnt/c/..).

On OS X

Seeems to be working when path to pkill is changed.

Build CI

Using Travis CI (https://travis-ci.org/rogalmic/vscode-zsh-debug)

  • Every push to master will create a release in github with vsix package for testing
  • Every tag pushed to master matching v1.2.3 will trigger a deploy to VSCode extension repo with this version.
    • Remember to use proper commit messages.
    • Keep version in project.json same as version in git tag, best to achieve by running npm run release -- --release-as minor to bump version and create commit with proper tag at the same time.
    • Push the tag git push origin v1.2.3, this will start the publish build in TravisCI.