https://github.com/vim-denops/deno-denops-std

📚 Standard module for denops.vim
https://github.com/vim-denops/deno-denops-std

vim-denops

Last synced: about 2 months ago
JSON representation

📚 Standard module for denops.vim

• Host: GitHub
• URL: https://github.com/vim-denops/deno-denops-std
• Owner: vim-denops
• License: mit
• Created: 2021-02-13T18:50:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T00:43:21.000Z (5 months ago)
• Last Synced: 2024-04-14T15:22:15.900Z (5 months ago)
• Topics: vim-denops
• Language: TypeScript
• Homepage: https://deno.land/x/denops_std
• Size: 2.39 MB
• Stars: 56
• Watchers: 8
• Forks: 15
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🐜 denops_std

[![JSR](https://jsr.io/badges/@denops/std)](https://jsr.io/@denops/std)

[![Test](https://github.com/vim-denops/deno-denops-std/actions/workflows/test.yml/badge.svg)](https://github.com/vim-denops/deno-denops-std/actions/workflows/test.yml)

[![codecov](https://codecov.io/github/vim-denops/deno-denops-std/branch/main/graph/badge.svg?token=RKAZMUQ3D9)](https://codecov.io/github/vim-denops/deno-denops-std)

Standard module for [denops.vim].

This module is assumed to be used for developing denops plugins. The code is

assumed to be called in a dedicated worker thread.

By using this module, developers can write Vim/Neovim denops plugins like:

```typescript

import type { Denops } from "jsr:@denops/std";

import * as batch from "jsr:@denops/std/batch";

import * as fn from "jsr:@denops/std/function";

import * as vars from "jsr:@denops/std/variable";

import * as helper from "jsr:@denops/std/helper";

import { assert, is } from "jsr:@core/unknownutil";

export function main(denops: Denops): void {

  denops.dispatcher = {

    async init() {

      // This is just an example. Developers usually should define commands directly in Vim script.

      await batch.batch(denops, async (denops) => {

        await denops.cmd(

          `command! HelloWorld call denops#notify("${denops.name}", "say", ["World"])`,

        );

        await denops.cmd(

          `command! HelloDenops call denops#notify("${denops.name}", "say", ["Denops"])`,

        );

      });

    },

    async say(where) {

      assert(where, is.String);

      const [name, progname] = await batch.collect(denops, (denops) => [

        fn.input(denops, "Your name: "),

        vars.v.get(denops, "progname"),

      ]);

      const messages = [

        `Hello ${where}.`,

        `Your name is ${name}.`,

        `This is ${progname}.`,

      ];

      await helper.echo(denops, messages.join("\n"));

    },

  };

}

```

**Note that developers should avoid calling initialization code within the

`main` function**. If necessary, add an `init` API or a similar approach like

above and call it from `plugin/.vim`.

See [Denops Documentation] or [denops-helloworld.vim] for more details.

[denops.vim]: https://github.com/vim-denops/denops.vim

[Denops Documentation]: https://vim-denops.github.io/denops-documentation

[denops-helloworld.vim]: https://github.com/vim-denops/denops-helloworld.vim

## License

The code follows MIT license written in [LICENSE](./LICENSE). Contributors need

to agree that any modifications sent in this repository follow the license.