{"id":13412619,"url":"https://github.com/is0n/jaq-nvim","last_synced_at":"2025-03-14T18:31:48.875Z","repository":{"id":39649710,"uuid":"423014155","full_name":"is0n/jaq-nvim","owner":"is0n","description":"⚙️ Just Another Quickrun Plugin for Neovim in Lua","archived":false,"fork":false,"pushed_at":"2024-07-21T02:25:26.000Z","size":556,"stargazers_count":176,"open_issues_count":13,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-07-31T20:51:12.671Z","etag":null,"topics":["lua","neovim"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/is0n.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-30T23:48:59.000Z","updated_at":"2024-07-12T06:35:47.000Z","dependencies_parsed_at":"2024-10-26T08:36:17.649Z","dependency_job_id":"82c44371-e2e4-4731-8774-10f6becf7895","html_url":"https://github.com/is0n/jaq-nvim","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/is0n%2Fjaq-nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/is0n%2Fjaq-nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/is0n%2Fjaq-nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/is0n%2Fjaq-nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/is0n","download_url":"https://codeload.github.com/is0n/jaq-nvim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243625153,"owners_count":20321241,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","neovim"],"created_at":"2024-07-30T20:01:26.882Z","updated_at":"2025-03-14T18:31:48.560Z","avatar_url":"https://github.com/is0n.png","language":"Lua","funding_links":[],"categories":["Code Runner","Lua"],"sub_categories":["Quickfix"],"readme":"\u003cimg src=\"https://img.shields.io/github/stars/is0n/jaq-nvim.svg?style=for-the-badge\u0026label=stars\" align=\"left\"/\u003e\n\u003cimg src=\"https://img.shields.io/github/license/is0n/jaq-nvim?style=for-the-badge\u0026logo=GNU\" align=\"right\"/\u003e\n\n\u003ch1 align='center'\u003ejaq-nvim\u003c/h1\u003e\n\n`jaq-nvim` is **J**ust **A**nother **Q**uickrun plugin for Neovim that was inspired by [quickrun.vim](https://github.com/D0n9X1n/quickrun.vim). In short, it is a plugin that lets you run the code of any language with a single command.\n\n## Demo:\n\n| Type Info                                                                      | Demonstration                                                                                                      |\n| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| \u003cins\u003eInternal:\u003c/ins\u003e \u003cbr/\u003e Runs a vim command using `:`.                       | ![Internal](https://user-images.githubusercontent.com/57725322/178857660-6e0f9eff-cef2-47c6-85f0-4696697e95d7.png) |\n| \u003cins\u003eFloat:\u003c/ins\u003e \u003cbr/\u003e Opens a floating window with `vim.api.nvim_open_win()` | ![Float](https://user-images.githubusercontent.com/57725322/178857665-a771d37c-b705-4bd2-99f6-9812bb37a898.png)    |\n| \u003cins\u003eTerminal:\u003c/ins\u003e \u003cbr/\u003e Opens a terminal with `:terminal`                   | ![Terminal](https://user-images.githubusercontent.com/57725322/178857666-8536e793-3977-4a10-a611-a3aaec975870.png) |\n| \u003cins\u003eBang:\u003c/ins\u003e \u003cbr/\u003e Opens a small window with `:!`                          | ![Bang](https://user-images.githubusercontent.com/57725322/178857662-fe4d133f-24d2-4298-89fd-fd9fc3fbf326.png)     |\n| \u003cins\u003eQuickfix:\u003c/ins\u003e \u003cbr/\u003e Command output is placed in a quickfix window       | ![Quickfix](https://user-images.githubusercontent.com/57725322/178857664-1d6593be-2ea6-4a00-9531-36b3a097a02a.png) |\n\n## Installation:\n\n#### [packer.nvim](https://github.com/wbthomason/packer.nvim):\n  ```lua\n  use {\"is0n/jaq-nvim\"}\n  ```\n\n## Example Lua Config:\n```lua\nrequire('jaq-nvim').setup{\n  cmds = {\n    -- Uses vim commands\n    internal = {\n      lua = \"luafile %\",\n      vim = \"source %\"\n    },\n\n    -- Uses shell commands\n    external = {\n      markdown = \"glow %\",\n      python   = \"python3 %\",\n      go       = \"go run %\",\n      sh       = \"sh %\"\n    }\n  },\n\n  behavior = {\n    -- Default type\n    default     = \"float\",\n\n    -- Start in insert mode\n    startinsert = false,\n\n    -- Use `wincmd p` on startup\n    wincmd      = false,\n\n    -- Auto-save files\n    autosave    = false\n  },\n\n  ui = {\n    float = {\n      -- See ':h nvim_open_win'\n      border    = \"none\",\n\n      -- See ':h winhl'\n      winhl     = \"Normal\",\n      borderhl  = \"FloatBorder\",\n\n      -- See ':h winblend'\n      winblend  = 0,\n\n      -- Num from `0-1` for measurements\n      height    = 0.8,\n      width     = 0.8,\n      x         = 0.5,\n      y         = 0.5\n    },\n\n    terminal = {\n      -- Window position\n      position = \"bot\",\n\n      -- Window size\n      size     = 10,\n\n      -- Disable line numbers\n      line_no  = false\n    },\n\n    quickfix = {\n      -- Window position\n      position = \"bot\",\n\n      -- Window size\n      size     = 10\n    }\n  }\n}\n```\n\n## Example JSON Config:\n```json\n{\n  \"internal\": {\n    \"lua\": \"luafile %\",\n    \"vim\": \"source %\"\n  },\n\n  \"external\": {\n    \"markdown\": \"glow %\",\n    \"python\": \"python3 %\",\n    \"go\": \"go run %\",\n    \"sh\": \"sh %\"\n  }\n}\n```\n\nIn the current working directory, `Jaq` will search for a file called `.jaq.json`.\n\nThis config file will be used for running commands, both external and internal.\n\n## Usage:\n\n`:Jaq` by default uses the `float` type to run code. The default can be changed (see `Example Lua Config`).\n\nTo use any other type, provide any of the arguments seen in `Demonstration`.\n\nExample: `:Jaq bang`\n\nThe commands for `:Jaq` also have certain variables that can help in running code.\n\nYou can put any of the following in `require('jaq-nvim').setup()` or `.jaq.json` ...\n- `%` / `$file`    • Current File\n- `#` / `$altFile` • Alternate File\n- `$dir`           • Current Working Directory\n- `$filePath`      • Path to Current File\n- `$fileBase`      • Basename of File (no extension)\n- `$moduleName`    • Python Module Name\n\n\u003cdiv align=\"center\" id=\"madewithlua\"\u003e\n\n[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge\u0026logo=lua)](#madewithlua)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fis0n%2Fjaq-nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fis0n%2Fjaq-nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fis0n%2Fjaq-nvim/lists"}