git: upload first revision of plugin template repo
This commit is contained in:
commit
a8fa80fc7e
10 changed files with 470 additions and 0 deletions
2
.cargo/config.toml
Normal file
2
.cargo/config.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[build]
|
||||
target = "wasm32-wasi"
|
8
.editorconfig
Normal file
8
.editorconfig
Normal file
|
@ -0,0 +1,8 @@
|
|||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
|
||||
[*.toml]
|
||||
indent_size = 2
|
||||
indent_style = space
|
84
.gitattributes
vendored
Normal file
84
.gitattributes
vendored
Normal file
|
@ -0,0 +1,84 @@
|
|||
# Auto detect text files and perform normalization
|
||||
* text=auto eol=lf
|
||||
|
||||
*.rs text diff=rust eol=lf
|
||||
*.toml text diff=toml eol=lf
|
||||
Cargo.lock text eol=lf
|
||||
|
||||
*.wasm binary
|
||||
|
||||
# Common settings that generally should always be used with your language specific settings
|
||||
|
||||
# Documents
|
||||
*.bibtex text diff=bibtex
|
||||
*.doc diff=astextplain
|
||||
*.DOC diff=astextplain
|
||||
*.docx diff=astextplain
|
||||
*.DOCX diff=astextplain
|
||||
*.dot diff=astextplain
|
||||
*.DOT diff=astextplain
|
||||
*.pdf diff=astextplain
|
||||
*.PDF diff=astextplain
|
||||
*.rtf diff=astextplain
|
||||
*.RTF diff=astextplain
|
||||
*.md text diff=markdown
|
||||
*.mdx text diff=markdown
|
||||
*.tex text diff=tex
|
||||
*.adoc text
|
||||
*.textile text
|
||||
*.mustache text
|
||||
*.csv text
|
||||
*.tab text
|
||||
*.tsv text
|
||||
*.txt text
|
||||
*.sql text
|
||||
|
||||
# Graphics
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.jpeg binary
|
||||
*.gif binary
|
||||
*.tif binary
|
||||
*.tiff binary
|
||||
*.ico binary
|
||||
# SVG treated as text by default.
|
||||
*.svg text
|
||||
# If you want to treat it as binary,
|
||||
# use the following line instead.
|
||||
# *.svg binary
|
||||
*.eps binary
|
||||
|
||||
# Scripts
|
||||
*.bash text eol=lf
|
||||
*.fish text eol=lf
|
||||
*.sh text eol=lf
|
||||
*.zsh text eol=lf
|
||||
# These are explicitly windows files and should use crlf
|
||||
*.bat text eol=crlf
|
||||
*.cmd text eol=crlf
|
||||
*.ps1 text eol=crlf
|
||||
|
||||
# Serialisation
|
||||
*.json text
|
||||
*.toml text
|
||||
*.xml text
|
||||
*.yaml text
|
||||
*.yml text
|
||||
|
||||
# Archives
|
||||
*.7z binary
|
||||
*.gz binary
|
||||
*.tar binary
|
||||
*.tgz binary
|
||||
*.zip binary
|
||||
|
||||
# Text files where line endings should be preserved
|
||||
*.patch -text
|
||||
|
||||
#
|
||||
# Exclude files from exporting
|
||||
#
|
||||
|
||||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
.gitkeep export-ignore
|
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
/target
|
||||
Cargo.lock
|
5
.rustfmt.toml
Normal file
5
.rustfmt.toml
Normal file
|
@ -0,0 +1,5 @@
|
|||
reorder_imports = true
|
||||
newline_style = "unix"
|
||||
# uncomment once stable
|
||||
# imports_granularity = "Crate"
|
||||
# group_imports = "StdExternalCrate"
|
15
Cargo.toml
Normal file
15
Cargo.toml
Normal file
|
@ -0,0 +1,15 @@
|
|||
[package]
|
||||
edition = "2021"
|
||||
name = "lapce-plugin-template"
|
||||
version = "0.0.0"
|
||||
resolver = "2"
|
||||
|
||||
[target.'cfg(target_os = "wasi")'.dependencies]
|
||||
|
||||
# default deps for all lapce plugins
|
||||
anyhow = "1.0"
|
||||
serde_json = "1.0"
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
# lapce-plugin = { git = "https://github.com/lapce/lapce-plugin-rust.git", branch = "volt" }
|
||||
lapce-plugin = { git = "https://github.com/panekj/lapce-plugin-rust.git", branch = "volt" }
|
||||
|
201
LICENSE
Normal file
201
LICENSE
Normal file
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
54
Makefile.toml
Normal file
54
Makefile.toml
Normal file
|
@ -0,0 +1,54 @@
|
|||
[tasks.default]
|
||||
clear = true
|
||||
dependencies = [
|
||||
"fmt",
|
||||
"check",
|
||||
"clippy",
|
||||
"release",
|
||||
]
|
||||
|
||||
[tasks.fmt]
|
||||
command = 'cargo'
|
||||
args = ['fmt']
|
||||
|
||||
[tasks.release]
|
||||
dependencies = [
|
||||
'build-release',
|
||||
'copy-release',
|
||||
]
|
||||
|
||||
[tasks.dev]
|
||||
dependencies = [
|
||||
'build-dev',
|
||||
'copy-dev',
|
||||
]
|
||||
|
||||
[tasks.check]
|
||||
command = 'cargo'
|
||||
args = ['check']
|
||||
|
||||
[tasks.clippy]
|
||||
command = 'cargo'
|
||||
args = ['clippy']
|
||||
|
||||
[tasks.build-dev]
|
||||
command = 'cargo'
|
||||
args = ['build']
|
||||
|
||||
[tasks.copy-dev]
|
||||
script_runner = "@shell"
|
||||
script = '''
|
||||
rm ./lapce*.wasm
|
||||
cp ./target/wasm32-wasi/debug/lapce*.wasm ./
|
||||
'''
|
||||
|
||||
[tasks.build-release]
|
||||
command = 'cargo'
|
||||
args = ['build', '--release']
|
||||
|
||||
[tasks.copy-release]
|
||||
script_runner = "@shell"
|
||||
script = '''
|
||||
rm ./lapce*.wasm
|
||||
cp ./target/wasm32-wasi/release/lapce*.wasm ./
|
||||
'''
|
88
src/main.rs
Normal file
88
src/main.rs
Normal file
|
@ -0,0 +1,88 @@
|
|||
use anyhow::Result;
|
||||
use lapce_plugin::{
|
||||
psp_types::{
|
||||
lsp_types::{request::Initialize, InitializeParams, Url},
|
||||
Request,
|
||||
},
|
||||
register_plugin, LapcePlugin, VoltEnvironment, PLUGIN_RPC,
|
||||
};
|
||||
use serde_json::Value;
|
||||
|
||||
#[derive(Default)]
|
||||
struct State {}
|
||||
|
||||
register_plugin!(State);
|
||||
|
||||
fn initialize(params: InitializeParams) -> Result<()> {
|
||||
// Check for user specified LSP server path
|
||||
// ```
|
||||
// [lapce-plugin-name.lsp]
|
||||
// serverPath = "[path or filename]"
|
||||
// ```
|
||||
if let Some(options) = params.initialization_options.as_ref() {
|
||||
if let Some(lsp) = options.get("lsp") {
|
||||
if let Some(server_path) = lsp.get("serverPath") {
|
||||
if let Some(server_path) = server_path.as_str() {
|
||||
if !server_path.is_empty() {
|
||||
PLUGIN_RPC.start_lsp(
|
||||
Url::parse(&format!("urn:{}", server_path))?,
|
||||
"[language_id]",
|
||||
params.initialization_options,
|
||||
);
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Architecture check
|
||||
let _ = match VoltEnvironment::architecture().as_deref() {
|
||||
Ok("x86_64") => "x86_64",
|
||||
Ok("aarch64") => "aarch64",
|
||||
_ => return Ok(()),
|
||||
};
|
||||
|
||||
// OS check
|
||||
let _ = match VoltEnvironment::architecture().as_deref() {
|
||||
Ok("macos") => "macos",
|
||||
Ok("linux") => "linux",
|
||||
Ok("windows") => "windows",
|
||||
_ => return Ok(()),
|
||||
};
|
||||
|
||||
// Download URL
|
||||
// let _ = format!("https://github.com/<name>/<project>/releases/download/<version>/{filename}");
|
||||
|
||||
// see lapce_plugin::Http for available API to download files
|
||||
|
||||
let _ = match VoltEnvironment::operating_system().as_deref() {
|
||||
Ok("windows") => {
|
||||
format!("{}.exe", "[filename]")
|
||||
}
|
||||
_ => "[filename]".to_string(),
|
||||
};
|
||||
|
||||
// Plugin working directory
|
||||
let volt_uri = VoltEnvironment::uri()?;
|
||||
let exec_path = Url::parse(&volt_uri)?.join("[filename]")?;
|
||||
|
||||
// Available language IDs
|
||||
// https://github.com/lapce/lapce/blob/HEAD/lapce-proxy/src/buffer.rs#L173
|
||||
PLUGIN_RPC.start_lsp(exec_path, "[language_id]", params.initialization_options);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
impl LapcePlugin for State {
|
||||
fn handle_request(&mut self, _id: u64, method: String, params: Value) {
|
||||
#[allow(clippy::single_match)]
|
||||
match method.as_str() {
|
||||
Initialize::METHOD => {
|
||||
let params: InitializeParams = serde_json::from_value(params).unwrap();
|
||||
let _ = initialize(params);
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
}
|
11
volt.toml
Normal file
11
volt.toml
Normal file
|
@ -0,0 +1,11 @@
|
|||
name = "<plugin-name>"
|
||||
version = "0.0.0"
|
||||
author = "<your name>"
|
||||
display-name = "<plugin-display-name>"
|
||||
description = "<plugin-description>"
|
||||
|
||||
# for non-theme plugins
|
||||
# wasm = "<plugin-name>.wasm"
|
||||
|
||||
# for theme plugins
|
||||
# themes = ["theme-one.toml", "theme-two.toml", "theme-three.toml"]
|
Loading…
Reference in a new issue