ex.rsvim

About

Implements Vim's builtin ex commands for Rsvim, provide a compatible user experience in command-line.

Installation

First go to Rsvim config home directory:

cd $XDG_CONFIG_HOME/rsvim
# or
cd $HOME/.rsvim

Then install with either git or npm:

Plugin version should be compatible with the Rsvim version, for example install ex.rsvim 0.1.x for Rsvim 0.1.x, ex.rsvim 0.2.x for Rsvim 0.2.x (or development branch if Rsvim didn't release v0.2 yet)

git

# tag v0.2.1
git clone --branch=v0.2.1 https://github.com/rsvim/ex.rsvim ex.rsvim

# main branch
git clone --branch=main https://github.com/rsvim/ex.rsvim ex.rsvim

npm

# version v0.2.1
npm install [email protected]

# latest version
npm install @rsvim/ex.rsvim

Setup

Setup in your config entry script:

import ex from "ex.rsvim";
ex.setup();

The setup function accepts an optional object, by default is:

const DefaultSetupOptions: SetupOptions = {
  force: true,
};

You can pass your custom options when setup:

import ex from "ex.rsvim";
ex.setup({
  // Your configurations here...
});

Command Index

There are a lot of ex commands, which cannot be done all at once. This section trace the status of each command with below symbols:

• ✅ Almost compatible
• 🔰 Basically usable
• 🚧 Working in Progress
• 🔴 Missing

| Status | Command | Alias | Description | Since Version | | ------ | ----------- | ----- | --------------------------------- | ------------- | | 🔰 | quit | q | Quit editor | v0.1 | | 🔰 | write | w | Save current buffer to filesystem | v0.1 | | 🔰 | writeQuit | wq | Save current buffer and quit | v0.2 |

Contribution

Contributions are always welcomed :)

Development Environment

Please setup the development environment with:

1. Install mise.
2. Run mise i to install python, node and other npm cli tools.
3. Run npm i to install dependencies.

Here are some useful tools:

• npm run prettier: Format source code.
• npm run tsc: Compile typescript to javascript and .d.ts declarations.

The project structure is:

|-lib    // Compiled javascript files
|-src    // Typescript source files
|-types  // Typescript type declarations

Please DO NOT manually edit files under lib and types.

Supporting the Project

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.

• GitHub Sponsor
• Open Collective

License

Licensed under Vim License.