release: v3.1.0

See CHANGELOG.md file for more information about this release

Author: NTBBloodbath

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# 2 spaces indentation
+[*.lua]
+indent_size = 2
+indent_style = space

.gitattributes

@@ -14,14 +14,14 @@ jobs:
         uses: JohnnyMorganz/stylua-action@1.0.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --config-path=stylua.toml -g *.lua -g !doomrc.lua -- .
+          args: --config-path=./.stylua.toml -g *.lua -g !doomrc.lua -g !lua/colors/**/*.lua -- .
       - name: Commit files
         run: |
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           if [[ ! -z $(git status -s) ]]; then
-            git add *.lua lua/
-            git commit -m "Format lua files"
+            git add *.lua colors/*.lua lua/
+            git commit -m "chore: format source code"
           fi
       - name: Push formatted files
         uses: ad-m/github-push-action@master

.github/workflows/format.yml

@@ -2,19 +2,17 @@ name: lint
 
 on:
   push:
-    paths: '**.lua'
     branches: [main, develop]
   pull_request:
-    paths: '**.lua'
     types: [opened, synchronize]
 
 jobs:
-  selene:
+  luacheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Setup and run selene
-        uses: NTBBloodbath/selene-action@v1.0.0
+      - uses: nebularg/actions-luacheck@v1.1.0
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: "."
+          files: '.'
+          config: 'https://raw.githubusercontent.com/NTBBloodbath/doom-nvim/develop/.luacheckrc'
+          annotate: 'error'

.github/workflows/lint.yml

@@ -1,7 +1,9 @@
 # My temp files
 plugin/
 sessions/
+undodir/
 time_cost.txt
+tags
 # Backup files
 .doom_releases
 .doom_backup_hash

.gitignore

@@ -0,0 +1,29 @@
+stds.nvim = {
+  globals = {
+    vim = { fields = { "g" } },
+    table = { fields = { "unpack" } },
+    package = { fields = { "searchers" } },
+  },
+  read_globals = {
+    "vim",
+    "jit",
+    "packer_plugins",
+  },
+}
+std = "lua51+nvim"
+
+-- Rerun tests only if their modification time changed.
+cache = true
+
+-- NOTE: rules from 200...400 are specific for Neovim stuff, e.g. vim.opt
+ignore = {
+  "212/_.*", -- Unused argument, for variables with "_" prefix.
+  "331", -- Value assigned to a local variable is mutated but never accessed.
+  "631", -- Line is too long.
+}
+
+exclude_files = {
+  "plugin/packer_compiled.lua",
+}
+
+-- vim: ft=lua sw=2 ts=2

.luacheckrc

@@ -0,0 +1,5 @@
+column_width = 100
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferDouble"

.stylua.toml

@@ -7,6 +7,85 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2021-08-26
+
+### Added
+
+- Options field to `doom_config.lua`, see [#62](https://github.com/NTBBloodbath/doom-nvim/pull/62)
+- New prompt for editing doom configurations
+- Better internal errors handling
+- Allow to use options (e.g. silent) in the custom mappings
+- Custom settings defined on `doom_config.lua` are automatically reloaded
+- `SPC - d - l` keybinding for manually reload configurations
+- Windows support (note that some plugins does not work well on Windows and that's not a doom issue!)
+- `SPC - d - s` keybinding now offers a live preview for the colorschemes
+- `tsx` treesitter parser is now installed alongside with the typescript one, see [#84](https://github.com/NTBBloodbath/doom-nvim/issues/84)
+- Allow to override default keymappings
+- Quick save with `SPC - v / m`
+- Jump keybindings on which-key
+- Keybindings to move lines (`Alt + j / k`)
+- `win_width` option, for automatically setting the windows width
+- You can now add your doom-nvim configurations to your dotfiles without having to use submodules!
+    See [#79](https://github.com/NTBBloodbath/doom-nvim/issues/79)
+- Plugins:
+  - New plugin: treesitter companion plugins (autotag, docs, etc)
+  - New plugin: nvim-mapper, a keybindings cheatsheet
+  - New plugin: DAP (Debugging Adapter Protocol) support
+  - New plugin: trouble, better quickfix window
+  - New plugin: todo-comments.nvim, better TODO comments
+  - New plugin: superman, man pages integration
+  - New plugin: ranger, file browser integration
+  - New plugin: firenvim, use Neovim in your favorite web browser!
+  - New plugin: registers.nvim, show contents of each register on a popup window
+  - Added more dynamic color palettes to galaxyline (e.g. nord, dracula, tokyonight)
+
+### Changed
+
+- Assume `~/.config/nvim` rather than `~/.config/doom-nvim`, see [#41](https://github.com/NTBBloodbath/doom-nvim/pull/41)
+- Autocommands and keybindings now lives in `doom.extras` instead of `doom.core`
+- Use a custom toggleterm instance for running and compiling code
+- `<leader><space>` keybind is now `<leader>` + \`
+- Format files before saving them instead of saving and formatting later
+- Improved crash report (`SPC - d - R`) output
+- undodir is now located at `~/.local/share/nvim`
+- We have adopted a more saner and common coding style:
+  - Spaces over tabs
+  - Two spaces for indentation
+- Plugins:
+  - Changed some packer defaults for cloning, should speed up the cloning step with heavy size plugins like plenary
+  - Changed kommentary lazy-loading event
+  - Changed nvim-compe lazy-loading event
+  - Improved how which-key plugin is being lazy-loaded
+  - Updated TrueZen configurations
+  - Updated gitsigns configurations
+  - Lua LSP configurations are now handled by lua-dev.nvim plugin
+  - session-lens was replaced by persistence.nvim
+  - Improved some dashboard icons
+  - indent-blankline character is now full height
+  - Saner telescope configurations
+
+### Fixed
+
+- Respect `XDG_CONFIG_HOME` environment variable
+- Plugins:
+  - Occasional bug with autosessions
+  - Properly lazy-load TrueZen
+  - Use GCC compiler for haskell treesitter parser
+  - bufferline will not be shown when:
+    1. Only one buffer is opened
+    2. While being in the dashboard
+  - Add extra whitespace to some icons on galaxyline
+  - Disable indent-blankline on norg files
+
+### Deleted
+
+- "Async" logic, it was not true async so we don't need it anymore
+- Installer, doom-nvim can be installed with just two commands. Now you can have truly power over
+    the installation process and a very transparent installation
+- Unneeded `:checkhealth` add-on
+- Plugins:
+  - lspsaga, we are now using the built-in functionalities for LSP (hover doc, etc)
+
 ## [3.0.13] - 2021-08-24
 
 ### Fixed
@@ -446,8 +525,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial stable release
 
-[unreleased]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.13...develop
-[3.0.12]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.12...v3.0.13
+[unreleased]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.1.0...develop
+[3.1.0]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.13...v3.1.0
+[3.0.13]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.12...v3.0.13
 [3.0.12]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.11...v3.0.12
 [3.0.11]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.10...v3.0.11
 [3.0.10]: https://github.com/NTBBloodbath/doom-nvim/compare/v3.0.9...v3.0.10

CHANGELOG.md

@@ -85,41 +85,77 @@ Its design is guided by these mantras:
 
 ### Installation
 
-- Curl 7.x (for using the installation script)
 - Git 2.23+
 
 ### Runtime
 
 - Neovim 0.5.0 onwards
 
 - GNU `find`
-- _Optionals:_
-  - [ripgrep] 11.0+ or [fd] 7.3.0+ (improves file indexing performance for some commands)
-  - `nodejs` and `npm` (required to use some Language Server Protocols)
+- [ripgrep] 11.0+ or [fd] 7.3.0+ (optional but highly recommended, improves file indexing performance for some commands)
+- `nodejs` and `npm` (optional, required to use some Language Server Protocols)
 
 Doom is comprised of [~40 optional plugins][modules], some of which may have
 additional dependencies. [Please visit their documentation][modules].
 
 ## Install
 
-Simply run the following command:
+> **IMPORTANT**: if you don't have a patched nerd font then you will need to
+> install one in your system so you will be able to see icons in Neovim.
+
+First you'll want to backup your current Neovim configuration if you have one.
+
+> **NOTES**:
+>
+> 1. Your current configuration will be backed up to `~/.config/nvim.bak`
+>    or where your `XDG_CONFIG_HOME` environment variable points to.
+>
+> 2. If you're a cheovim user you can skip this step and go directly to
+>    [installing with cheovim](#installing-with-cheovim).
+
+```sh
+[ -d ${XDG_CONFIG_HOME:-$HOME/.config}/nvim ] && mv ${XDG_CONFIG_HOME:-$HOME/.config}/nvim ${XDG_CONFIG_HOME:-$HOME/.config}/nvim.bak
+```
+
+Now that you have backed up your current Neovim configuration you can proceed to install
+`doom-nvim`.
 
 ```sh
-curl -sLf https://raw.githubusercontent.com/NTBBloodbath/doom-nvim/main/install.sh | bash
+git clone --depth 1 https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/nvim
 ```
 
 Or if you want to live in the bleeding-edge with the latest features:
 
 ```sh
-curl -sLf https://raw.githubusercontent.com/NTBBloodbath/doom-nvim/main/install.sh | bash -s -- -d
+git clone --depth 1 -b develop https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/nvim
+```
+
+### Installing with cheovim
+
+If you're using cheovim as your Neovim configurations manager you can install `doom-nvim` and then
+use the recipe listed in cheovim documentation:
+
+```sh
+# Clone doom-nvim under a specific directory under our '~/.config' directory
+git clone --depth 1 https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/doom-nvim
+
+# Change the doom-nvim internal path
+sed -i "37s/nvim/doom-nvim/" ${XDG_CONFIG_HOME:-$HOME/.config}/doom-nvim/lua/doom/core/system/init.lua
 ```
 
+```lua
+-- In your '~/.config/nvim/profiles.lua'
+doom_nvim = { "~/.config/doom-nvim", {
+        plugins = "packer",
+        preconfigure = "doom-nvim"
+    }
+}
+```
+---
+
 Then [read our Getting Started guide][getting-started] to be walked through
 installing, configuring and maintaining Doom Nvim.
 
-> **NOTE**: If you want to see all the available commands in the installation script, then use
-> <kbd>bash -s -- -h</kbd> instead of just <kbd>bash</kbd>
-
 ## Getting help
 
 Neovim is not very difficult. Although you will occasionally run into problems
@@ -130,6 +166,7 @@ if you are not an advanced vimmer. When you do, here are some places you can loo
     its modules.
   - [The Plugins Management section][plugins-management] covers how to install
     and disable plugins.
+- [Our troubleshooting wiki](https://github.com/NTBBloodbath/doom-nvim/wiki/Troubleshooting)
 - Search the [Doom Nvim's issue tracker](https://github.com/NTBBloodbath/doom-nvim/issues)
   before opening a new issue to see if your issue was already been reported and to
   avoid duplicating issues.