rsvim-types 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitmodules +3 -0
- package/LICENSE.txt +78 -0
- package/README.md +75 -0
- package/package.json +22 -0
- package/runtime/00__web.ts +669 -0
- package/runtime/01__rsvim.ts +2003 -0
- package/tsconfig.json +40 -0
- package/types/00__web.d.ts +252 -0
- package/types/01__rsvim.d.ts +1335 -0
- package/types/index.d.ts +2 -0
package/.gitmodules
ADDED
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
VIM LICENSE
|
|
2
|
+
|
|
3
|
+
I) There are no restrictions on distributing unmodified copies of Vim except
|
|
4
|
+
that they must include this license text. You can also distribute
|
|
5
|
+
unmodified parts of Vim, likewise unrestricted except that they must
|
|
6
|
+
include this license text. You are also allowed to include executables
|
|
7
|
+
that you made from the unmodified Vim sources, plus your own usage
|
|
8
|
+
examples and Vim scripts.
|
|
9
|
+
|
|
10
|
+
II) It is allowed to distribute a modified (or extended) version of Vim,
|
|
11
|
+
including executables and/or source code, when the following four
|
|
12
|
+
conditions are met:
|
|
13
|
+
1) This license text must be included unmodified.
|
|
14
|
+
2) The modified Vim must be distributed in one of the following five ways:
|
|
15
|
+
a) If you make changes to Vim yourself, you must clearly describe in
|
|
16
|
+
the distribution how to contact you. When the maintainer asks you
|
|
17
|
+
(in any way) for a copy of the modified Vim you distributed, you
|
|
18
|
+
must make your changes, including source code, available to the
|
|
19
|
+
maintainer without fee. The maintainer reserves the right to
|
|
20
|
+
include your changes in the official version of Vim. What the
|
|
21
|
+
maintainer will do with your changes and under what license they
|
|
22
|
+
will be distributed is negotiable. If there has been no negotiation
|
|
23
|
+
then this license, or a later version, also applies to your changes.
|
|
24
|
+
The current maintainers are listed here: https://github.com/orgs/vim/people.
|
|
25
|
+
If this changes it will be announced in appropriate places (most likely
|
|
26
|
+
vim.sf.net, www.vim.org and/or comp.editors). When it is completely
|
|
27
|
+
impossible to contact the maintainer, the obligation to send him
|
|
28
|
+
your changes ceases. Once the maintainer has confirmed that he has
|
|
29
|
+
received your changes they will not have to be sent again.
|
|
30
|
+
b) If you have received a modified Vim that was distributed as
|
|
31
|
+
mentioned under a) you are allowed to further distribute it
|
|
32
|
+
unmodified, as mentioned at I). If you make additional changes the
|
|
33
|
+
text under a) applies to those changes.
|
|
34
|
+
c) Provide all the changes, including source code, with every copy of
|
|
35
|
+
the modified Vim you distribute. This may be done in the form of a
|
|
36
|
+
context diff. You can choose what license to use for new code you
|
|
37
|
+
add. The changes and their license must not restrict others from
|
|
38
|
+
making their own changes to the official version of Vim.
|
|
39
|
+
d) When you have a modified Vim which includes changes as mentioned
|
|
40
|
+
under c), you can distribute it without the source code for the
|
|
41
|
+
changes if the following three conditions are met:
|
|
42
|
+
- The license that applies to the changes permits you to distribute
|
|
43
|
+
the changes to the Vim maintainer without fee or restriction, and
|
|
44
|
+
permits the Vim maintainer to include the changes in the official
|
|
45
|
+
version of Vim without fee or restriction.
|
|
46
|
+
- You keep the changes for at least three years after last
|
|
47
|
+
distributing the corresponding modified Vim. When the maintainer
|
|
48
|
+
or someone who you distributed the modified Vim to asks you (in
|
|
49
|
+
any way) for the changes within this period, you must make them
|
|
50
|
+
available to him.
|
|
51
|
+
- You clearly describe in the distribution how to contact you. This
|
|
52
|
+
contact information must remain valid for at least three years
|
|
53
|
+
after last distributing the corresponding modified Vim, or as long
|
|
54
|
+
as possible.
|
|
55
|
+
e) When the GNU General Public License (GPL) applies to the changes,
|
|
56
|
+
you can distribute the modified Vim under the GNU GPL version 2 or
|
|
57
|
+
any later version.
|
|
58
|
+
3) A message must be added, at least in the output of the ":version"
|
|
59
|
+
command and in the intro screen, such that the user of the modified Vim
|
|
60
|
+
is able to see that it was modified. When distributing as mentioned
|
|
61
|
+
under 2)e) adding the message is only required for as far as this does
|
|
62
|
+
not conflict with the license used for the changes.
|
|
63
|
+
4) The contact information as required under 2)a) and 2)d) must not be
|
|
64
|
+
removed or changed, except that the person himself can make
|
|
65
|
+
corrections.
|
|
66
|
+
|
|
67
|
+
III) If you distribute a modified version of Vim, you are encouraged to use
|
|
68
|
+
the Vim license for your changes and make them available to the
|
|
69
|
+
maintainer, including the source code. The preferred way to do this is
|
|
70
|
+
by e-mail or by uploading the files to a server and e-mailing the URL.
|
|
71
|
+
If the number of changes is small (e.g., a modified Makefile) e-mailing a
|
|
72
|
+
context diff will do. The e-mail address to be used is
|
|
73
|
+
<maintainer@vim.org>
|
|
74
|
+
|
|
75
|
+
IV) It is not allowed to remove this license from the distribution of the Vim
|
|
76
|
+
sources, parts of it or from a modified version. You may use this
|
|
77
|
+
license for previous Vim releases instead of the license that they came
|
|
78
|
+
with, at your option.
|
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="logo.svg" src="https://raw.githubusercontent.com/rsvim/assets/main/logo/RSVIM-logo.svg" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
The VIM editor reinvented in Rust+TypeScript.
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://crates.io/crates/rsvim"><img alt="rsvim" src="https://img.shields.io/crates/v/rsvim" /></a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@rsvim/types"><img alt="rsvim" src="https://img.shields.io/npm/v/%40rsvim%2Ftypes" /></a>
|
|
12
|
+
<a href="https://docs.rs/rsvim_core/latest/"><img alt="rsvim_core" src="https://img.shields.io/docsrs/rsvim_core?label=docs.rs" /></a>
|
|
13
|
+
<a href="https://github.com/rsvim/rsvim/actions/workflows/release.yml"><img alt="release.yml" src="https://img.shields.io/github/actions/workflow/status/rsvim/rsvim/release.yml" /></a>
|
|
14
|
+
<a href="https://github.com/rsvim/rsvim/actions/workflows/ci.yml"><img alt="ci.yml" src="https://img.shields.io/github/actions/workflow/status/rsvim/rsvim/ci.yml?branch=main&label=ci" /></a>
|
|
15
|
+
<a href="https://app.codecov.io/gh/rsvim/rsvim"><img alt="codecov" src="https://img.shields.io/codecov/c/github/rsvim/rsvim" /></a>
|
|
16
|
+
<a href="https://discord.gg/5KtRUCAByB"><img alt="discord" src="https://img.shields.io/discord/1220171472329379870?logo=discord&style=social&label=discord" /></a>
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
> [!CAUTION]
|
|
20
|
+
>
|
|
21
|
+
> _**This project is still in very early stage of development and not ready for use. Please choose alternatives [Neovim](https://neovim.io/) and [Vim](https://www.vim.org/).**_
|
|
22
|
+
|
|
23
|
+
## About
|
|
24
|
+
|
|
25
|
+
RSVIM is an open source terminal based text editor, built from scratch with [Rust](https://www.rust-lang.org/), [Tokio](https://tokio.rs/) and [V8](https://v8.dev/) javascript engine. It strives to be highly extensible by following main features, concepts, philosophy of ([Neo](https://neovim.io/))[Vim](https://www.vim.org/), while also to be:
|
|
26
|
+
|
|
27
|
+
- A fast editor that fully utilizes all CPU cores and never freezes.
|
|
28
|
+
- A powerful TUI engine that provides widgets, event handlers, layouts, etc.
|
|
29
|
+
- A consistent JavaScript-based runtime with built-in support for TypeScript.
|
|
30
|
+
- An editing service that allows multiple users to access remotely and work together.
|
|
31
|
+
- A text processing tool that integrates with shell environment.
|
|
32
|
+
|
|
33
|
+
## Installation
|
|
34
|
+
|
|
35
|
+
Please download prebuilt executables in [releases](https://github.com/rsvim/rsvim/releases) page, or build with cargo:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
cargo install rsvim
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
To get latest updates, build with source:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
git clone https://github.com/rsvim/rsvim
|
|
45
|
+
cd rsvim
|
|
46
|
+
cargo install --path ./rsvim_cli
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Get Started
|
|
50
|
+
|
|
51
|
+
Please check out [Documentation](https://rsvim.github.io/) for more details!
|
|
52
|
+
|
|
53
|
+
## Contribution
|
|
54
|
+
|
|
55
|
+
Contributions to RSVIM are always welcomed. A few guidelines that help quickly set up development environment can be found in [DEVELOPMENT.md](https://github.com/rsvim/rsvim/blob/main/DEVELOPMENT.md).
|
|
56
|
+
|
|
57
|
+
Road map and high-level design can be found in [RFC](https://github.com/rsvim/rfc), please submit your ideas and designs there if they need fairly large efforts.
|
|
58
|
+
|
|
59
|
+
## Credits
|
|
60
|
+
|
|
61
|
+
Some source code are studied from following projects for implementing the initial prototype of javascript runtime and [Minimum Common Web Platform API](https://min-common-api.proposal.wintertc.org/):
|
|
62
|
+
|
|
63
|
+
- **[dune](https://github.com/aalykiot/dune)**: A hobby runtime for JavaScript and TypeScript 🚀.
|
|
64
|
+
- **[deno](https://github.com/denoland/deno)**: A modern runtime for JavaScript and TypeScript.
|
|
65
|
+
|
|
66
|
+
## Supporting the Project
|
|
67
|
+
|
|
68
|
+
If you like RSVIM, please consider sponsoring it. Your support encourages contributors and maintainers of this project, and other fees or efforts spent on it.
|
|
69
|
+
|
|
70
|
+
- [GitHub Sponsor](https://github.com/sponsors/rsvim)
|
|
71
|
+
- [Open Collective](https://opencollective.com/rsvim)
|
|
72
|
+
|
|
73
|
+
## License
|
|
74
|
+
|
|
75
|
+
Licensed under [Vim License](https://github.com/rsvim/rsvim/blob/main/LICENSE.txt).
|
package/package.json
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "rsvim-types",
|
|
3
|
+
"version": "0.1.3",
|
|
4
|
+
"description": "TypeScript types for Rsvim text editor.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"rsvim"
|
|
7
|
+
],
|
|
8
|
+
"homepage": "https://github.com/rsvim/rsvim",
|
|
9
|
+
"bugs": {
|
|
10
|
+
"url": "https://github.com/rsvim/rsvim/issues"
|
|
11
|
+
},
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "git+https://github.com/rsvim/rsvim.git"
|
|
15
|
+
},
|
|
16
|
+
"license": "Vim",
|
|
17
|
+
"author": "rsvim",
|
|
18
|
+
"type": "module",
|
|
19
|
+
"main": "./runtime/index.js",
|
|
20
|
+
"types": "./types/index.d.ts",
|
|
21
|
+
"scripts": {}
|
|
22
|
+
}
|