diff options
| author | Ian P Bradley <ian.bradley@studiocrabapple.com> | 2023-06-20 16:54:58 -0700 |
|---|---|---|
| committer | Ian P Bradley <ian.bradley@studiocrabapple.com> | 2023-06-20 16:54:58 -0700 |
| commit | 58f51b42c6484e4fdfbf50d5062410aa473ea87c (patch) | |
| tree | 4159d306aacfd0f2e0e1b627e2f45e3580e07dae /README.md | |
| parent | 881148ca688e862c1361687170bed86085222835 (diff) | |
| download | PerlNavigator-58f51b42c6484e4fdfbf50d5062410aa473ea87c.zip | |
Add instructions for packaging .vsix files from source
This is in an effort to make it easier for VSCode/VSCodium users to
try/test the latest changes in unpublished releases or the main branch
with a little less effort on their part
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 12 insertions, 1 deletions
@@ -51,7 +51,17 @@ It is recommended to set `perlnavigator.perltidyProfile` if you would like custo Perlimports offers additional diagnostics when imports can be cleaned up. When perlimports is enabled, "Format Document" and "Format Selection" will run perlimports in addition to perltidy. By default, perlimports is not enabled, but the diagnostics (linting) can be enabled with `perlimportsLintEnabled`, and the tidying can be enabled with `perlimportsTidyEnabled`. Perlimports can be customized with a profile using the `perlnavigator.perlimportsProfile`. -Due to implementation limitations, perlimports requires a saved version of the file you are working on. If any results are unexpected, save the working file and try again. +Due to implementation limitations, perlimports requires a saved version of the file you are working on. If any results are unexpected, save the working file and try again. + +## Building For VSCode/VSCodium +In addition to node.js and npm you will have to install [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce), a tool for packaging (among other things) extensions in the .vsix format used by both VSCode and VSCodium by running the following: +```sh +git clone https://github.com/bscan/PerlNavigator +cd PerlNavigator/ +npm install -g @vscode/vsce +vsce package +``` +At this point all that's left to do is install the resulting .vsix file (located in the current directory) in VSCode or VSCodium by navigating to the Extensions pane and choosing "Install from VSIX...". ## Installation For Other Editors Currently, this is not yet packaged for other editors but you can build from source. You'll need to have node.js and npm installed. @@ -182,3 +192,4 @@ For those interested in a Raku language server, check out: https://github.com/bs ## Licenses / Acknowledgments The Perl Navigator is free software licensed under the MIT License. It has a number of bundled dependencies as well, all of which have their respective open source licenses included. This work is only possible due to Class::Inspector, Devel::Symdump, Perl::Critic, PPI, Perl::Tidy, perlimports, Sub::Util, Perl itself, Microsoft LSP libraries, and ideas from Perl::LanguageServer and PLS. + |