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

Change logo and name #458

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ jobs:
if: runner.os == 'Linux'
uses: actions/upload-artifact@v2
with:
name: ocaml-platform-${{ github.sha }}
path: ocaml-platform.vsix
name: vscode-ocaml-${{ github.sha }}
path: vscode-ocaml.vsix

- name: Test extension
uses: GabrielBB/xvfb-action@v1
Expand Down Expand Up @@ -107,8 +107,8 @@ jobs:
uses: actions/upload-release-asset@v1
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: ./ocaml-platform.vsix
asset_name: ocaml-platform.vsix
asset_path: ./vscode-ocaml.vsix
asset_name: vscode-ocaml.vsix
asset_content_type: application/zip
env:
GITHUB_TOKEN: ${{ github.token }}
Expand Down
8 changes: 2 additions & 6 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"outFiles": [
"${workspaceRoot}/_build/default/src/vscode_ocaml_platform.bc.js"
],
"outFiles": ["${workspaceRoot}/_build/default/src/vscode_ocaml.bc.js"],
"args": [
"--disable-extensions",
"--extensionDevelopmentPath=${workspaceFolder}"
Expand All @@ -23,9 +21,7 @@
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"outFiles": [
"${workspaceRoot}/_build/default/src/vscode_ocaml_platform.bc.js"
],
"outFiles": ["${workspaceRoot}/_build/default/src/vscode_ocaml.bc.js"],
"args": ["--extensionDevelopmentPath=${workspaceFolder}"]
}
]
Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ switch: create_switch deps ## Create an opam switch and install development depe

.PHONY: build
build: ## Build the project
dune build src/vscode_ocaml_platform.bc.js
dune build src/vscode_ocaml.bc.js
yarn --cwd astexplorer start
yarn esbuild _build/default/src/vscode_ocaml_platform.bc.js \
yarn esbuild _build/default/src/vscode_ocaml.bc.js \
--bundle \
--external:vscode \
--outdir=dist \
Expand All @@ -32,9 +32,9 @@ build: ## Build the project

.PHONY: build-release
build-release:
dune build src/vscode_ocaml_platform.bc.js --profile=release
dune build src/vscode_ocaml.bc.js --profile=release
yarn --cwd astexplorer build
yarn esbuild _build/default/src/vscode_ocaml_platform.bc.js \
yarn esbuild _build/default/src/vscode_ocaml.bc.js \
--bundle \
--external:vscode \
--outdir=dist \
Expand Down
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VSCode OCaml Platform
# VSCode OCaml

[![Main workflow](https://img.shields.io/github/workflow/status/ocamllabs/vscode-ocaml-platform/Main%20workflow?branch=master)](https://github.com/ocamllabs/vscode-ocaml-platform/actions?query=workflow%3A%22Main+workflow%22+branch%3Amaster)
[![Main workflow](https://img.shields.io/github/workflow/status/ocaml/vscode-ocaml/Main%20workflow?branch=master)](https://github.com/ocaml/vscode-ocaml/actions?query=workflow%3A%22Main+workflow%22+branch%3Amaster)

Visual Studio Code extension for OCaml and relevant tools.

Expand Down Expand Up @@ -304,20 +304,20 @@ required for file formatting to work.
### Problems with this Extension or OPAM support in the Extension

One by one, invoke and see outputs for commands
`OCaml: Show OCaml Platform Extension Output` and
`OCaml: Show OCaml Commands Output`. In these Output Views you may see errors
and warnings, which can be handy to detect and fix the problem you're facing.
Please, check the issue you're facing hasn't been already reported and report in
[Issues](https://github.com/ocamllabs/vscode-ocaml-platform/issues) tab of this
repository, if necessary.
`OCaml: Show OCaml Extension Output` and `OCaml: Show OCaml Commands Output`. In
these Output Views you may see errors and warnings, which can be handy to detect
and fix the problem you're facing. Please, check the issue you're facing hasn't
been already reported and report in
[Issues](https://github.com/ocaml/vscode-ocaml/issues) tab of this repository,
if necessary.

### Things to include in your Issue report

It is helpful to include information such as

- Operation system information
- VS Code version
- OCaml Platform Extension version
- OCaml Extension version
- OCaml-LSP version
- Reproducible setup (some codebase, for example, where we can see the bug
happening) the problem
Expand All @@ -328,7 +328,7 @@ It is helpful to include information such as
<details>
<summary>I installed <code>ocaml-lsp-server</code>, but the extension still cannot find it.</summary>

Make sure you installed the the language server in the sandbox used by the
Make sure you installed the language server in the sandbox used by the
extension.

_OPAM_: If you're using opam, make sure that you're using correct switch when
Expand Down Expand Up @@ -364,13 +364,13 @@ In case you have a question or problem not listed above:

- if you don't understand how to the extension works or how to make it work
correctly, create a new discussion in the repository Discussions
[tab](https://github.com/ocamllabs/vscode-ocaml-platform/discussions).
[tab](https://github.com/ocaml/vscode-ocaml/discussions).

- if the extension seems to misbehave:
- see [Debugging](#debugging) section to see if you can see any reported
errors
- file an issue in the repository Issues
[tab](https://github.com/ocamllabs/vscode-ocaml-platform/issues).
[tab](https://github.com/ocaml/vscode-ocaml/issues).

If this section doesn't contain the problem you managed to resolve, and you
think this may help others, consider adding the problem and its solution here by
Expand Down Expand Up @@ -417,9 +417,8 @@ The extension does not offer such functionality because it is rarely necessary.
A workaround is to _not_ install `ocamllsp`. As a result you will mostly have
just syntax highlighting for OCaml source files but also a warning notification
that `ocamllsp` wasn't found. See this
[issue](https://github.com/ocamllabs/vscode-ocaml-platform/issues/889), feel
free to upvote this issue by leaving a thumbs-up reaction. Pull requests are
welcome as well.
[issue](https://github.com/ocaml/vscode-ocaml/issues/889), feel free to upvote
this issue by leaving a thumbs-up reaction. Pull requests are welcome as well.

### Persisting sandbox information

Expand Down Expand Up @@ -466,7 +465,7 @@ _Local switch_
{
"ocaml.sandbox": {
"kind": "esy",
"root": "${workspaceFolder:vscode-ocaml-platform}"
"root": "${workspaceFolder:vscode-ocaml}"
}
}
```
Expand Down
Binary file modified assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions dune-project
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
(lang dune 3.0)

(name vscode-ocaml-platform)
(name vscode-ocaml)

(source
(github ocamllabs/vscode-ocaml-platform))
(github ocaml/vscode-ocaml))

(license ISC)

Expand All @@ -22,7 +22,7 @@
(generate_opam_files true)

(package
(name vscode-ocaml-platform)
(name vscode-ocaml)
(synopsis "Visual Studio Code extension for OCaml")
(allow_empty)
(depends
Expand Down
2 changes: 1 addition & 1 deletion nix/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ let
in
{
vscode = default;
"vscode-ocaml-platform" = default;
"vscode-ocaml" = default;
};

};
Expand Down
8 changes: 4 additions & 4 deletions nix/opam-selection.nix
Original file line number Diff line number Diff line change
Expand Up @@ -644,17 +644,17 @@ in
};
opamSrc = "vscode.opam";
};
vscode-ocaml-platform =
vscode-ocaml =
{
pname = "vscode-ocaml-platform";
pname = "vscode-ocaml";
version = "development";
src = self.directSrc "vscode-ocaml-platform";
src = self.directSrc "vscode-ocaml";
opamInputs =
{
inherit (selection) vscode promise_jsoo ppxlib opam-file-format
ocaml-version ocaml jsonoo js_of_ocaml gen_js_api dune base;
};
opamSrc = "vscode-ocaml-platform.opam";
opamSrc = "vscode-ocaml.opam";
};
yojson =
{
Expand Down
18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"name": "ocaml-platform",
"displayName": "OCaml Platform",
"displayName": "OCaml",
"description": "Official OCaml language extension for VSCode",
"license": "MIT",
"version": "1.10.8",
"publisher": "ocamllabs",
"repository": {
"type": "git",
"url": "https://github.com/ocamllabs/vscode-ocaml-platform"
"url": "https://github.com/ocaml/vscode-ocaml"
},
"bugs": {
"url": "https://github.com/ocamllabs/vscode-ocaml-platform/issues"
"url": "https://github.com/ocaml/vscode-ocaml/issues"
},
"homepage": "https://github.com/ocamllabs/vscode-ocaml-platform",
"main": "./dist/vscode_ocaml_platform.bc.js",
"homepage": "https://github.com/ocaml/vscode-ocaml",
"main": "./dist/vscode_ocaml.bc.js",
"engines": {
"vscode": "^1.64.0"
},
Expand Down Expand Up @@ -261,7 +261,7 @@
{
"command": "ocaml.open-ocaml-platform-ext-output",
"category": "OCaml",
"title": "Show OCaml Platform Extension Output"
"title": "Show OCaml Extension Output"
},
{
"command": "ocaml.open-ocaml-commands-output",
Expand Down Expand Up @@ -451,7 +451,7 @@
]
},
"configuration": {
"title": "OCaml Platform",
"title": "OCaml",
"properties": {
"ocaml.sandbox": {
"type": "object",
Expand Down Expand Up @@ -1021,8 +1021,8 @@
"test:opam": "node ./test/runOpamTests.js",
"test:problems": "node ./test/runProblemMatcherTests.js",
"test": "npm-run-all -s test:*",
"package": "vsce package --out ocaml-platform.vsix --yarn",
"deploy:vsce": "vsce publish --packagePath ocaml-platform.vsix --yarn",
"package": "vsce package --out vscode-ocaml.vsix --yarn",
"deploy:vsce": "vsce publish --packagePath vscode-ocaml.vsix --yarn",
"deploy:ovsx": "ovsx publish --yarn",
"fmt:check": "prettier . --check",
"fmt": "prettier . --write"
Expand Down
2 changes: 1 addition & 1 deletion shell.nix
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ let
in with local;

pkgs.mkShell {
inputsFrom = [ vscode vscode-ocaml-platform ];
inputsFrom = [ vscode vscode-ocaml ];
buildInputs = (with pkgs; [
yarn
nodejs-14_x
Expand Down
2 changes: 1 addition & 1 deletion src/dune
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(executable
(name vscode_ocaml_platform)
(name vscode_ocaml)
(preprocess
(pps gen_js_api.ppx))
(libraries
Expand Down
5 changes: 2 additions & 3 deletions src/extension_commands.ml
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,8 @@ let _open_current_dune_file =
in
command Extension_consts.Commands.open_current_dune_file handler

let ( _open_ocamllsp_output_pane
, _open_ocaml_platform_ext_pane
, _open_ocaml_commands_pane ) =
let _open_ocamllsp_output_pane, _open_ocaml_ext_pane, _open_ocaml_commands_pane
=
let handler output (_instance : Extension_instance.t) ~args:_ =
let show_output (lazy output) = OutputChannel.show output () in
show_output output
Expand Down
7 changes: 3 additions & 4 deletions src/extension_commands.mli
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@
and expose them here if they want to.

All commands are registered using [register_all_commands] in
[Vscode_ocaml_platform.activate].
[Vscode_ocaml.activate].

[1] https://code.visualstudio.com/api/references/vscode-api#commands *)

(** Registers commands with vscode. Should be called in
[Vscode_ocaml_platform.activate]. It subscribes the disposables to the
extension context provided. *)
(** Registers commands with vscode. Should be called in [Vscode_ocaml.activate].
It subscribes the disposables to the extension context provided. *)
val register_all_commands :
Vscode.ExtensionContext.t -> Extension_instance.t -> unit

Expand Down
2 changes: 1 addition & 1 deletion src/extension_instance.ml
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ end = struct
let clientOptions = client_options () in
LanguageClient.make
~id:"ocaml"
~name:"OCaml Platform VS Code extension"
~name:"VSCode OCaml extension"
~serverOptions
~clientOptions
()
Expand Down
2 changes: 1 addition & 1 deletion src/odig.ml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type t = { cache_dir : Path.t }
let make_odig_cmd sandbox = Sandbox.get_command sandbox "odig"

(** TODO: propose to install odig. See
https://github.com/ocamllabs/vscode-ocaml-platform/pull/771#discussion_r765297112 *)
https://github.com/ocaml/vscode-ocaml/pull/771#discussion_r765297112 *)
let of_sandbox (sandbox : Sandbox.t) =
let make_odig_cmd = make_odig_cmd sandbox in
let odig_version = make_odig_cmd [ "--version" ] in
Expand Down
2 changes: 1 addition & 1 deletion src/output.ml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ let language_server_output_channel =
lazy (Vscode.Window.createOutputChannel ~name:"OCaml Language Server")

let extension_output_channel =
lazy (Vscode.Window.createOutputChannel ~name:"OCaml Platform Extension")
lazy (Vscode.Window.createOutputChannel ~name:"OCaml Extension")

let command_output_channel =
lazy (Vscode.Window.createOutputChannel ~name:"OCaml Commands")
3 changes: 1 addition & 2 deletions src/sandbox.mli
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

3. Helper functions that extract the tools from the setup sandbox. This
includes just [ocamllsp] right now, but in future could include others like
debuggers, REPLs etc that could be shipped with [vscode-ocaml-platform]
plugin itself
debuggers, REPLs etc that could be shipped with [vscode-ocaml] plugin itself

The separation between [init], [run_setup] and extraction helpers exist so
that we can handle missing tools gracefully (ie provide degraded
Expand Down
4 changes: 1 addition & 3 deletions src/treeview_help.ml
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ let github_item =
~title:"Open"
~command:"vscode.open"
~arguments:
[ Vscode.Uri.parse
"https://github.com/ocamllabs/vscode-ocaml-platform"
()
[ Vscode.Uri.parse "https://github.com/ocaml/vscode-ocaml" ()
|> Vscode.Uri.t_to_js
]
()
Expand Down
2 changes: 1 addition & 1 deletion src/vscode_ocaml_platform.ml → src/vscode_ocaml.ml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ let suggest_to_pick_sandbox () =
let+ selection =
Window.showInformationMessage
~message:
"OCaml Platform is using the package manager and sandbox available in \
"VSCode OCaml is using the package manager and sandbox available in \
the environment. Pick a particular package manager and sandbox by \
clicking the button below"
~choices:[ (select_pm_button_text, ()) ]
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions vscode-ocaml-platform.opam → vscode-ocaml.opam
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ authors: [
"Javier Chávarri <[email protected]>"
]
license: "ISC"
homepage: "https://github.com/ocamllabs/vscode-ocaml-platform"
bug-reports: "https://github.com/ocamllabs/vscode-ocaml-platform/issues"
homepage: "https://github.com/ocaml/vscode-ocaml"
bug-reports: "https://github.com/ocaml/vscode-ocaml/issues"
depends: [
"dune" {>= "3.0"}
"vscode" {= version}
Expand Down Expand Up @@ -43,4 +43,4 @@ build: [
"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/ocamllabs/vscode-ocaml-platform.git"
dev-repo: "git+https://github.com/ocaml/vscode-ocaml.git"
6 changes: 3 additions & 3 deletions vscode.opam
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ authors: [
"Javier Chávarri <[email protected]>"
]
license: "ISC"
homepage: "https://github.com/ocamllabs/vscode-ocaml-platform"
bug-reports: "https://github.com/ocamllabs/vscode-ocaml-platform/issues"
homepage: "https://github.com/ocaml/vscode-ocaml"
bug-reports: "https://github.com/ocaml/vscode-ocaml/issues"
depends: [
"dune" {>= "3.0"}
"ocaml" {>= "4.13"}
Expand All @@ -38,4 +38,4 @@ build: [
"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/ocamllabs/vscode-ocaml-platform.git"
dev-repo: "git+https://github.com/ocaml/vscode-ocaml.git"