https://github.com/klesh/nvim-runscript

Neovim users, you may not need Postman
https://github.com/klesh/nvim-runscript

Last synced: 3 months ago
JSON representation

Neovim users, you may not need Postman

• Host: GitHub
• URL: https://github.com/klesh/nvim-runscript
• Owner: klesh
• License: mit
• Created: 2022-07-24T06:56:27.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-23T03:14:33.000Z (about 2 years ago)
• Last Synced: 2024-06-18T07:33:15.216Z (5 months ago)
• Language: Shell
• Size: 13.7 KB
• Stars: 20
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nvim-runscript

Neovim users, you may not need Postman, `nvim-runscript` is the lightweight plugin you may need for API observation,

testing, and debugging in a Unix-Philosophy way.

![nvim-runscript-demo](https://user-images.githubusercontent.com/61080/180638392-bc5fcb73-fe54-4af5-a256-926dfaf5a766.gif)

## Why

- Lightweight and fast

- The request scripts can be written in any language as long as they are executable

- The request scripts can be added to Git repository and shared between teammates

- You may run them in pure CLI without neovim for debugging purposes

- It is easy to manipulate the response with tool that you like, and write complicated script

  - [Fetch author detail of the github repository](example/github/get-repo-license.sh)

  - [Fetch user profile with OAuth token](example/github/get-profile-with-oauth.sh)

## Requirement

Developed and tested it on neovim v0.7

## Install

Install with packer:

```lua

use {

  "klesh/nvim-runscript",

  config = function() require("nvim-runscript").setup{} end

}

```

## How to use

1. Open a executable script file, i.e. `example/github/get-repo-detail.sh`.

2. Run commands `:RunScript`.

    1. A RESULT buffer should be appear on the bottom.

    2. The output of the process should be piped to the RESULT buffer.

    3. A markdown file wil be saved into `example/github/get-repo-detail.sh.result/`.

3. You may re-run the script from RESULT buffer.