Skip to content

rsvim/ex.rsvim

Repository files navigation

ex.rsvim

rsvim ci.yml

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:

# use $XDG_CONFIG_HOME
cd $XDG_CONFIG_HOME/rsvim

# or use $HOME
cd $HOME/.rsvim

Then install with either git or npm.

Tip

Which version should I use?

  • For release version of Rsvim, use a "x.y.?" branch (for git) or the latest "x.y.?" version (for npm), for example use "v0.1.x" branch for Rsvim v0.1.2.
  • For nightly or main branch of Rsvim, use "main" branch since this plugin is consistent with Rsvim's main branch.

git

# version branch
git clone --branch=v0.1.x https://github.com/rsvim/ex.rsvim @rsvim/ex.rsvim

# or main branch
git clone https://github.com/rsvim/ex.rsvim @rsvim/ex.rsvim

npm

# tagged version
npm install @rsvim/ex.rsvim@v0.1.0

# or latest version
npm install @rsvim/ex.rsvim

Setup

Setup in your config entry script:

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

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

ex.rsvim/src/index.ts

Lines 32 to 36 in 1f09822

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

You can pass your custom options when setup:

import ex from "@rsvim/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.x
🔰 write w Save current buffer to filesystem v0.1.x

Contribution

Contributions are always welcomed :)

Project Structure

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

Warning

Please DO NOT manually edit files under lib and types.

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.

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.

License

Licensed under Vim License.

About

Builtin ex commands for Rsvim.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors