{"id":19943305,"url":"https://github.com/softwareqinc/nvim-sq","last_synced_at":"2026-04-05T18:02:31.888Z","repository":{"id":271569574,"uuid":"767486527","full_name":"softwareQinc/nvim-sq","owner":"softwareQinc","description":"Power-up your workflow with Neovim","archived":false,"fork":false,"pushed_at":"2026-04-02T22:02:32.000Z","size":473,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-03T02:44:56.573Z","etag":null,"topics":["lua","neovim","neovim-configuration"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/softwareQinc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-03-05T11:34:18.000Z","updated_at":"2026-04-02T22:01:38.000Z","dependencies_parsed_at":"2025-01-08T15:49:18.428Z","dependency_job_id":"58d14528-875c-4932-b2bb-4e072491286a","html_url":"https://github.com/softwareQinc/nvim-sq","commit_stats":null,"previous_names":["softwareqinc/nvim-sq"],"tags_count":41,"template":false,"template_full_name":null,"purl":"pkg:github/softwareQinc/nvim-sq","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwareQinc%2Fnvim-sq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwareQinc%2Fnvim-sq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwareQinc%2Fnvim-sq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwareQinc%2Fnvim-sq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softwareQinc","download_url":"https://codeload.github.com/softwareQinc/nvim-sq/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwareQinc%2Fnvim-sq/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31444702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T15:22:31.103Z","status":"ssl_error","status_checked_at":"2026-04-05T15:22:00.205Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","neovim-configuration"],"created_at":"2024-11-13T00:16:07.187Z","updated_at":"2026-04-05T18:02:31.864Z","avatar_url":"https://github.com/softwareQinc.png","language":"Lua","readme":"# nvim-sq\n\nCustom [Neovim](https://neovim.io) configuration designed to enhance\ndevelopment productivity. Includes language servers, debug adapters, linters,\nformatters, auto-completion, fuzzy finding, Tree-sitter, tmux integration,\nChatGPT, and more. Plugins are managed via\n[lazy.nvim](https://github.com/folke/lazy.nvim). Requires Neovim 0.12 or newer.\n\nThis configuration has been extensively tested on macOS and Linux\n(Debian/Ubuntu). Minor issues may occur on other platforms.\n\n---\n\n## Pre-requisites\n\n### Terminal\n\nInstall a terminal application with TrueColor support, as the default macOS\nTerminal does not support TrueColor. On macOS, you can install, for example,\n[WezTerm](https://wezterm.org), a terminal emulator built with Rust that uses\nLua for configuration, using [Homebrew](https://brew.sh)\n\n```shell\nbrew install wezterm\n```\n\n### Fonts\n\nInstall a [Nerd Font](https://www.nerdfonts.com/font-downloads), such as\n[JetBrainsMono Nerd Font](https://www.programmingfonts.org/#jetbrainsmono), on\nmacOS using\n\n```shell\nbrew install font-jetbrains-mono-nerd-font\n```\n\n### External dependencies\n\nThese external tools are required by Neovim or its plugins for full\nfunctionality.\n\n- [**`curl`**](https://curl.se)\n  Required by certain Neovim plugins for internal networking and data retrieval\n  tasks.\n  - **macOS** - Installed by default\n  - **Ubuntu / Debian**\n    ```shell\n    sudo apt install curl\n    ```\n\n- [**`lazygit`**](https://github.com/jesseduffield/lazygit)\n  Required by [lazygit.nvim](https://github.com/kdheepak/lazygit.nvim).\n  - **macOS**\n    ```shell\n    brew install lazygit\n    ```\n\n- [**`luarocks`**](https://luarocks.org)\n  Required by [lazy.nvim](https://lazy.folke.io).\n  - **macOS**\n    ```shell\n    brew install luarocks\n    ```\n\n- [**Node.js**](https://nodejs.org)\n  Required by [mason.nvim](https://github.com/mason-org/mason.nvim) to install\n  and manage various language servers, linters, formatters, and other\n  development tools.\n  - **macOS**\n    ```shell\n    brew install node\n    ```\n\n- [**ripgrep**](https://github.com/BurntSushi/ripgrep)\n  Required by [Telescope](https://github.com/nvim-telescope/telescope.nvim) for\n  live text searching.\n  - **macOS**\n    ```shell\n    brew install ripgrep\n    ```\n\n- [**`sioyek`**](https://sioyek.info)\n  Required by [VimTeX](https://github.com/lervag/vimtex) to preview compiled\n  LaTeX documents.\n  - **macOS**\n    ```shell\n    brew install sioyek\n    ```\n\n- [**`tree-sitter-cli`**](https://www.npmjs.com/package/tree-sitter-cli)\n  Required to install and build Tree-sitter parsers locally.\n  - **All platforms - via `npm` (Node.js) or `cargo` (Rust)**\n    ```shell\n    npm install -g tree-sitter-cli\n    # or\n    cargo install --locked tree-sitter-cli\n    ```\n\n- [**GnuPG**](https://gnupg.org) \u0026\n  [**Pinentry**](https://www.gnupg.org/related_software/pinentry)\n  **(optional)**\n  Required for transparent encryption/decryption in Neovim, i.e., to\n  interactively prompt for passphrases. Without this, encryption or decryption\n  will not work. Ensure that [GnuPG](https://gnupg.org) is installed and\n  configured.\n  - **macOS**\n    ```shell\n    brew install pinentry-mac\n    echo \"use-agent\" \u003e\u003e ~/.gnupg/gpg.conf\n    echo \"pinentry-program $(brew --prefix)/bin/pinentry-mac\" \u003e\u003e ~/.gnupg/gpg-agent.conf\n    gpgconf --reload gpg-agent\n    ```\n\n---\n\n## Installation\n\nInstall Neovim using your preferred package manager. For example, on macOS,\nexecute\n\n```shell\nbrew install nvim\n```\n\nNext, install the custom configuration. Before doing so, we highly recommend to\n**backup any existing Neovim configuration and data**. On UNIX-like systems,\nexecute\n\n```shell\nmv ~/.config/nvim ~/.config/nvim.bak\nmv ~/.local/share/nvim ~/.local/share/nvim.bak\nmv ~/.local/state/nvim ~/.local/state/nvim.bak\n```\n\nThen clone the new configuration\n\n```shell\ngit clone https://github.com/softwareqinc/nvim-sq ~/.config/nvim --depth 1\n```\n\nAdapt the backup and installation commands accordingly for your operating\nsystem. Finally, launch Neovim by executing\n\n```shell\nnvim\n```\n\nThis configuration ships with plugins pinned according to\n[lazy-lock.json](lazy-lock.json). To update them to newer versions, run\n`:Lazy update` from within Neovim.\n\n---\n\n## Configuration overview\n\nThis configuration is written entirely in Lua, is documented, and\nself-contained. The main configuration file is [init.lua](init.lua), which\nserves as the entry point for loading all other configuration options and\nplugins.\n\n### Plugins\n\nPlugins are located under [lua/plugins](lua/plugins).\n\n### Key mappings\n\nKey mappings can be found in [lua/core/keymaps.lua](lua/core/keymaps.lua).\n\n### Options\n\nOptions are located in [lua/core/options.lua](lua/core/options.lua).\n\n### Snippets\n\nA collection of snippets for various programming/scripting languages can be\nfound under [lua/snippets](lua/snippets).\n\n### Colour schemes\n\nA few additional colour schemes can be lazy-loaded from\n[lua/plugins/colorschemes.lua](lua/plugins/colorschemes.lua).\nEdit the [init.lua](init.lua) file if you intend to make the changes persistent\nacross sessions: scroll towards the end of the file and replace the\n`light_scheme_name` and the `dark_scheme_name`, respectively, with your\nfavourite colour schemes. Moreover, you can also set there the time of day when\nNeovim will automatically switch from a light colour scheme to a dark one.\n\n### GUI client\n\nIf you prefer a GUI Neovim client, consider [Neovide](https://neovide.dev).\nOn macOS, install it with\n\n```shell\nbrew install neovide\n```\n\nThe Neovide configuration is located under [lua/neovide](lua/neovide).\n\n---\n\n## Programming language support\n\nThis Neovim configuration includes built-in support for the Language Server\nProtocol (LSP), Debug Adapter Protocol (DAP), and integrated linting and\nformatting across a wide range of programming, scripting, and markup languages,\nincluding C, C++, Python, Go, Rust, Haskell, Julia, Bash, Perl,\nJavaScript/TypeScript, Markdown, TOML, YAML, LaTeX, and Typst.\n\n### Language servers (LSP)\n\nLanguage server management is fully automated. Servers are\n\n- Discovered from the [after/lsp](after/lsp) directory\n- Installed via [mason-lspconfig.nvim](https://github.com/mason-org/mason-lspconfig.nvim),\n  see [lua/plugins/mason.lua](lua/plugins/mason.lua)\n- Configured and enabled via [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig),\n  see [lua/plugins/nvim-lspconfig.lua](lua/plugins/nvim-lspconfig.lua)\n\nTo install and enable a new server, create a corresponding file\n\n```text\nafter/lsp/\u003cserver\u003e.lua\n```\n\nThe file can simply `return {}` - the server will then use the default\nconfiguration provided by\n[nvim-lspconfig](https://github.com/neovim/nvim-lspconfig). Any additional\noptions you define will be merged with the defaults.\n\n### Debug adapters (DAP)\n\nDebug adapters are configured and installed by\n[nvim-dap](https://github.com/mfussenegger/nvim-dap), see\n[lua/plugins/dap.lua](lua/plugins/dap.lua).\n\n### Linters and formatters\n\nLinters and formatters are\n\n- Installed via [mason-null-ls.nvim](https://github.com/jay-babu/mason-null-ls.nvim),\n  see [lua/plugins/mason.lua](lua/plugins/mason.lua)\n- Configured via [none-ls.nvim](https://github.com/nvimtools/none-ls.nvim), see\n  see [lua/plugins/none-ls.lua](lua/plugins/none-ls.lua)\n\n### Potential issues\n\nBelow are some potential issues you may encounter with specific languages.\n\n#### Haskell\n\nEnsure that [ghcup](https://www.haskell.org/ghcup) is installed, see\n[https://www.haskell.org/ghcup/install](https://www.haskell.org/ghcup/install).\n\n#### JavaScript/TypeScript\n\nIf you encounter problems with [ESLint](https://eslint.org), run\n\n```shell\nnpm init @eslint/config@latest\n```\n\nfrom the root of your project.\n\n#### Julia\n\nTo enable Julia support, install Julia (on macOS) with\n\n```shell\ncurl -fsSL https://install.julialang.org | sh\n```\n\nNext, to enable full LSP integration, execute in a shell\n\n```shell\njulia --project=\"~/.julia/environments/nvim-lspconfig\" \\\n  -e 'using Pkg;\n      Pkg.add(\"LanguageServer\");\n      Pkg.add(\"SymbolServer\");\n      Pkg.add(\"StaticLint\")'\n```\n\n---\n\n## Troubleshooting\n\nFrom Neovim, run `:checkhealth` in case you are getting warnings/errors and/or\nthere are missing packages required for this configuration.\n\n### ChatGPT\n\nThe\n[ChatGPT](https://github.com/jackMort/ChatGPT.nvim) plugin, configured in\n[lua/plugins/chatgpt.lua](lua/plugins/chatgpt.lua), assumes that the OpenAI API\nkey is stored as a text file in `~/OpenAIkey.txt`; modify accordingly for your\nsystem.\n\n### Neorg\n\nIf the [Neorg](https://github.com/nvim-neorg/neorg) plugin, configured\nin [lua/plugins/neorg.lua](lua/plugins/neorg.lua), fails to install or does not\nwork properly, you can apply the workaround described in the related issue\n[here](https://github.com/nvim-neorg/neorg/issues/1715#issuecomment-3524433687)\nby following the steps below.\n\n- On UNIX-like systems, create a directory named `parser` in the root of your\n  Neovim configuration, assumed here to be `~/.config/nvim`, followed by\n  creating a symbolic link to the Neorg parser\n\n  ```shell\n  mkdir parser\n  ln -s ~/.local/share/nvim/lazy-rocks/tree-sitter-norg/lib/lua/5.1/parser/norg.so parser/\n  ```\n\nAdapt accordingly for your operating system. In addition, refer to the\n[Neorg's Kickstart](https://github.com/nvim-neorg/neorg/wiki/Kickstart) for\ndetailed installation instructions and troubleshooting.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwareqinc%2Fnvim-sq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftwareqinc%2Fnvim-sq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwareqinc%2Fnvim-sq/lists"}