Skip to main content
Version: Next

Simple Package

With config home, you can import a package that containing multiple files.

warning

As mentioned in Configuration, the entry point ~/.rsvim.{js,ts} doesn't have a config home, it cannot import any packages.

A simple package is a directory that containing a index.js (or index.ts) script (but without a package.json file), Rsvim can import the package by the directory name.

Example

For example we have a simple package called syntax:

$HOME/.rsvim
|- rsvim.js
|- syntax/
|- index.js
|- utils.js

syntax/utils.js

export function hello(value) {
Rsvim.cmd.echo(`Hello:${value}`);
}

syntax/index.js

import { hello } from "./utils.js";

export default { hello };

rsvim.js

import syntax from "syntax";

syntax.hello("Rsvim!");

Rsvim will look for the "syntax" package in its config home by the directory name syntax.

In simple package, entry point is by default resolved to the index.js or index.ts script file. In this example, the "syntax" specifier is resolved to the syntax/index.js file.

Once a package directory contains a package.json file, it becomes a NPM package.