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.

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

Already on GitHub? Sign in to your account

Draft version of basic superbol-mode for GNU/Emacs #6

Merged
merged 2 commits into from
Sep 25, 2023

Conversation

nberth
Copy link
Collaborator

@nberth nberth commented May 10, 2023

No description provided.

README.md Outdated
@@ -65,6 +65,29 @@ In the `superbol` field past the path to the `superbol` executable.

You can check the documentation on using the extension on [this page](https://ocamlpro.github.io/superbol-vscode-platform/sphinx).

### GNU/Emacs mode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for the record : we should avoid adding this kind of technical documentation in the README.md file. Technical documentation should go to the Sphinx doc, while the README.md is just an entry point describing the project and its features, and linking to the Sphinx documentation for more technical details.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, as it is now, I find it quite helpful for the initial setup.

Copy link
Collaborator Author

@nberth nberth Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now, I think the fact that we can debate the place for the documentation means the GNU/Emacs mode itself does not fit in this particular repository very well. Wouldn't it be better to have a (however small) separate standalone superbol-mode repository with just the README.md (as with many other modes for Emacs) ?

PS: the only reason I put it here in the first place was to exploit lsp-mode's script to extract options from the package.json for the extension. But that can be achieved in many other means.

Copy link
Contributor

@GitMensch GitMensch Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minimal repo with the emacs folder and the README.md seems most useful.
The "common" parts of the LSP could be a git external set to a fixed revision of this repo that was tested against emacs (not sure how much the common parts actually are, maybe these "common" parts would be reasonable to be split out and referenced as git external here, too).

@GitMensch
Copy link
Contributor

Looks interesting. I volunteer to test a version for Vim ;-)

@lefessan
Copy link
Member

Looks interesting. I volunteer to test a version for Vim ;-)

@emilienlemaire You told me that using it in vim would require uploading it to some online repo, do you have any other recipe ?

@emilienlemaire
Copy link
Contributor

emilienlemaire commented Sep 11, 2023

I was talking about Neovim (which has built-in lsp support), I'm not sur how it works on plain vim (which doesn't have built in lsp support), I can check for it, but this probably would imply a dependency on another plugin

@CLAassistant
Copy link

CLAassistant commented Sep 22, 2023

CLA assistant check
All committers have signed the CLA.

Also fix code for launching the LSP in VSCode platform
@nberth nberth marked this pull request as ready for review September 25, 2023 13:40
@nberth nberth merged commit 0a05abe into OCamlPro:master Sep 25, 2023
3 checks passed
@nberth nberth deleted the superbol-mode branch September 25, 2023 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants