Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: copyedit docs/dev/how-to-use-vscode.md #10009

Merged
merged 1 commit into from Mar 25, 2024
Merged

docs: copyedit docs/dev/how-to-use-vscode.md #10009

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/dev/how-to-use-vscode.md
View file
Open in desktop
Expand Up @@ -9,8 +9,7 @@ Here are some useful tricks.

One way to have perlcritic work is the following:

* install the [perlcritic](https://marketplace.visualstudio.com/items?itemName=sfodje.perlcritic)
extension
* install the [perlcritic extension](https://marketplace.visualstudio.com/items?itemName=sfodje.perlcritic)
* add a `perlcritic.sh` at the root of your project with following content:
```bash
#!/usr/bin/env bash
Expand All @@ -20,15 +19,15 @@ One way to have perlcritic work is the following:
the second line is useful only if you [use direnv](how-to-use-direnv.md)
* `chmod +x perlcritic.sh`
* patch perlcritic by editing its files, following [sfodje/perlcritic issue #26](https://github.com/sfodje/perlcritic/issues/26#issuecomment-1006411268)
* the edit perlcritic configuration in workspace to set those values:
* Executable: `/home/alex/docker/off-server/perlcritic.sh`
* edit the perlcritic configuration in workspace to set the value (after adjusting the pathname for your own OFF setup):
* Executable: `/path/to/your/own/OFF-server/perlcritic.sh`


## Perl Language Server

The extension [Language Server and Debugger](https://marketplace.visualstudio.com/items?itemName=richterger.perl) is less easy to work with !
The extension [Language Server and Debugger](https://marketplace.visualstudio.com/items?itemName=richterger.perl) is harder to work with!

**Note:** This setup does not work yet, but might not be so far. It is probably due to https://github.com/richterger/Perl-LanguageServer/issues/131
**Note:** This setup does not work yet, but might be getting close. It is probably due to https://github.com/richterger/Perl-LanguageServer/issues/131.

* install the extension
* add a script `shell-into-appserver.sh` in the project:
Expand Down Expand Up @@ -63,6 +62,6 @@ The extension [Language Server and Debugger](https://marketplace.visualstudio.co
[Remote Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
extension.
While we can consider using it,
it has some drawback because not all the project is contained within the "backend" container.
For example all that concern nodejs is in the "frontend" container.
So it means making a quite complete Docker image on its own with all the tooling necessary.
it has some drawbacks because not all the project is contained within the "backend" container.
For example everything related to nodejs is in the "frontend" container.
So it means making a quite complete Docker image on its own with all the tooling necessary.