From 9eb3156ab990758b94a0cc833d350dbff67e5a2a Mon Sep 17 00:00:00 2001 From: Michael Jolley Date: Thu, 21 Sep 2023 18:45:59 -0500 Subject: [PATCH] docs: Added README & versioning scripts --- README.md | 41 ++++++++++++++++++++++++++++++++++++++- package.release.config.js | 15 ++++++++++++++ publish.release.config.js | 29 +++++++++++++++++++++++++++ 3 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 package.release.config.js create mode 100644 publish.release.config.js diff --git a/README.md b/README.md index 92742ed..f2ed067 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,42 @@ # Visual Studio Outlining -VS Code extension that adds Visual Studio outlining capabilities +[![Marketplace](https://img.shields.io/visual-studio-marketplace/v/MichaelJolley.vscode-vs-outlining)](https://marketplace.visualstudio.com/items?itemName=MichaelJolley.vscode-vs-outlining) [![Installs](https://img.shields.io/visual-studio-marketplace/i/MichaelJolley.vscode-vs-outlining?color=blue&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=MichaelJolley.vscode-vs-outlining) [![MIT](https://img.shields.io/badge/license-MIT-orange.png?color=blue&style=flat-round)](https://opensource.org/licenses/MIT) + +![CI](https://img.shields.io/github/actions/workflow/status/michaeljolley/vscode-vs-outlining/CI.yml?logo=github) + +A simple extension that adds Visual Studio's outlining (code folding) to Visual +Studio Code. + +![Screenshot of a code editor with the outlining context menu](https://github.com/MichaelJolley/vscode-vs-outlining/assets/1228996/cefb7902-97e6-4b02-9217-24524337123a) + +## Commands + +This extension contributes the following commands: + +### Expand Outlines + +This command behaves like Visual Studio's `Edit > Outlining > Toggle Outlining +Expansion` command. + +It is also accessible via the following keybindings: + +- `Ctrl+M M` (Windows) +- `Cmd+M M` (Mac) + +### Toggle All Outlining + +This command behaves like Visual Studio's `Edit > Outlining > Toggle All Outlining` command. + +It is also accessible via the following keybindings: + +- `Ctrl+M L` (Windows) +- `Cmd+M L` (Mac) + +### Collapse To Definitions + +This command behaves like Visual Studio's `Edit > Outlining > Collapse To Definitions` command. + +It is also accessible via the following keybindings: + +- `Ctrl+M O` (Windows) +- `Cmd+M O` (Mac) diff --git a/package.release.config.js b/package.release.config.js new file mode 100644 index 0000000..f5c3ec5 --- /dev/null +++ b/package.release.config.js @@ -0,0 +1,15 @@ +module.exports = { + branches: ['main'], + plugins: [ + '@semantic-release/commit-analyzer', + '@semantic-release/release-notes-generator', + [ + 'semantic-release-vsce', + { + packageVsix: true, + publish: false, // no-op since we use semantic-release-stop-before-publish + }, + ], + 'semantic-release-stop-before-publish', + ], +}; \ No newline at end of file diff --git a/publish.release.config.js b/publish.release.config.js new file mode 100644 index 0000000..815c071 --- /dev/null +++ b/publish.release.config.js @@ -0,0 +1,29 @@ +module.exports = { + branches: ['main'], + plugins: [ + '@semantic-release/commit-analyzer', + '@semantic-release/release-notes-generator', + '@semantic-release/changelog', + [ + '@semantic-release/npm', + { + npmPublish: false, + tarballDir: 'false', + }, + ], + '@semantic-release/git', + [ + 'semantic-release-vsce', + { + packageVsix: false, + publishPackagePath: '*/*.vsix', + }, + ], + [ + '@semantic-release/github', + { + assets: '*/*.vsix', + }, + ], + ], +}; \ No newline at end of file