mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-12-27 05:02:23 +00:00
Merge pull request #440 from NotAShelf/typos-and-friends
Some checks are pending
Check for typos in the source tree / check-typos (push) Waiting to run
Some checks are pending
Check for typos in the source tree / check-typos (push) Waiting to run
treewide: documentation cleanup and fixes
This commit is contained in:
GitHub
commit
0b52ea8dbc
73 changed files with 1004 additions and 1516 deletions
35
.github/CONTRIBUTING.md
vendored
35
.github/CONTRIBUTING.md
vendored
|
|
@ -8,23 +8,42 @@
|
|||
|
||||
## Welcome
|
||||
|
||||
I'm glad you are thinking about contributing to neovim-flake! If you're unsure about anything, just ask - or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. Friendly contributions are always welcome.
|
||||
I'm glad you are thinking about contributing to nvf! If you're unsure about
|
||||
anything, just ask - or submit the issue or pull request anyway. The worst that
|
||||
can happen is you'll be politely asked to change something. Friendly
|
||||
contributions are always welcome.
|
||||
|
||||
Before you contribute, I encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md).
|
||||
Before you contribute, I encourage you to read this project's CONTRIBUTING
|
||||
policy (you are here) and its [LICENSE](../LICENSE) to understand how your
|
||||
contributions are licensed.
|
||||
|
||||
If you have any questions regarding those files, feel free to open an issue or [shoot me an email](mailto:me@notashelf.dev). Discussions tab is also available for more informal discussions.
|
||||
If you have any questions regarding those files, feel free to open an issue or
|
||||
[shoot me an email](mailto:me@notashelf.dev). Discussions tab is also available
|
||||
for more informal discussions.
|
||||
|
||||
## Contributing
|
||||
|
||||
The contribution process is mostly documented in the [pull request template](pull_request_template.md). You will find a checklist of items to complete before submitting a pull request. Please make sure you complete it before submitting a pull request. If you are unsure about any of the items, please ask.
|
||||
The contribution process is mostly documented in the
|
||||
[pull request template](PULL_REQUEST_TEMPLATE/pull_request_template.md). You
|
||||
will find a checklist of items to complete before submitting a pull request.
|
||||
Please make sure you complete it before submitting a pull request. If you are
|
||||
unsure about any of the items, please ask.
|
||||
|
||||
### Guidelines
|
||||
|
||||
We provide instructions on a healthy contribution to neovim-flake - including styling, commit formats, how-to guides for adding new modules and options.
|
||||
You are very well recommended to read the contributing guideliner over at [the documentation](https://notashelf.github.io/neovim-flake#hacking)
|
||||
We provide instructions on a healthy contribution to neovim-flake - including
|
||||
styling, commit formats, how-to guides for adding new modules and options. You
|
||||
are very well recommended to read the contributing guidelines over at
|
||||
[the documentation](https://notashelf.github.io/nvf#hacking)
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
This project does not quite have a code of conduct yet. And to be honest, I'm not sure if I want one or if it will ever have one. I'm not expecting this project to be a hotbed of activity, but I do want to make sure that everyone who does contribute feels welcome and safe. As such, I will do my best to make sure that those who distrupt the project are dealt with swiftly and appropriately.
|
||||
This project does not quite have a code of conduct yet. And to be perfectly
|
||||
honest, I'm not sure if I want one or if it will ever have one. I'm not
|
||||
expecting this project to be a hotbed of activity, but I do want to make sure
|
||||
that everyone who does contribute feels welcome and safe. As such, I will do my
|
||||
best to make sure that those who distrupt the project are dealt with swiftly and
|
||||
appropriately.
|
||||
|
||||
If you feel that you are not being treated with respect, please contact me directly.
|
||||
If you feel that you are not being treated with respect, please contact me
|
||||
directly.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ or dependency in this section.
|
|||
|
||||
If your pull request aims to fix an open issue or a please bug, please also link the relevant issue
|
||||
below this line. You may attach an issue to your pull request with `Fixes #<issue number>` outside
|
||||
this comment.
|
||||
this comment, and it will be closed when your pull request is merged.
|
||||
-->
|
||||
|
||||
## Sanity Checking
|
||||
|
|
@ -23,20 +23,20 @@ it above in your description.
|
|||
[editorconfig]: https://editorconfig.org
|
||||
[changelog]: https://github.com/NotAShelf/nvf/tree/main/docs/release-notes
|
||||
|
||||
- [ ] I have updated the [changelog] as per my changes.
|
||||
- [ ] I have tested, and self-reviewed my code.
|
||||
- [ ] I have updated the [changelog] as per my changes
|
||||
- [ ] I have tested, and self-reviewed my code
|
||||
- Style and consistency
|
||||
- [ ] I ran **Alejandra** to format my code (`nix fmt`).
|
||||
- [ ] My code conforms to the [editorconfig] configuration of the project.
|
||||
- [ ] My changes are consistent with the rest of the codebase.
|
||||
- [ ] I ran **Alejandra** to format my code (`nix fmt`)
|
||||
- [ ] My code conforms to the [editorconfig] configuration of the project
|
||||
- [ ] My changes are consistent with the rest of the codebase
|
||||
- If new changes are particularly complex:
|
||||
- [ ] My code includes comments in particularly complex areas
|
||||
- [ ] I have added a section in the manual.
|
||||
- [ ] _(For breaking changes)_ I have included a migration guide.
|
||||
- [ ] I have added a section in the manual
|
||||
- [ ] _(For breaking changes)_ I have included a migration guide
|
||||
- Package(s) built:
|
||||
- [ ] `.#nix` (default package)
|
||||
- [ ] `.#maximal`
|
||||
- [ ] `.#docs-html`
|
||||
- [ ] `.#docs-html` (manual, must build)
|
||||
- Tested on platform(s)
|
||||
- [ ] `x86_64-linux`
|
||||
- [ ] `aarch64-linux`
|
||||
72
.github/README.md
vendored
72
.github/README.md
vendored
|
|
@ -48,7 +48,7 @@
|
|||
[Documentation]: #documentation
|
||||
[Help]: #help
|
||||
[Contribute]: #contributing
|
||||
[FAQ]: #faq
|
||||
[FAQ]: #frequently-asked-questions
|
||||
[Credits]: #credits
|
||||
|
||||
**[<kbd><br> Features <br></kbd>][Features]**
|
||||
|
|
@ -56,7 +56,7 @@
|
|||
**[<kbd><br> Documentation <br></kbd>][Documentation]**
|
||||
**[<kbd><br> Help <br></kbd>][Help]**
|
||||
**[<kbd><br> Contribute <br></kbd>][Contribute]**
|
||||
**[<kbd><br> FAQ <br></kbd>][Faq]** **[<kbd><br> Credits <br></kbd>][Credits]**
|
||||
**[<kbd><br> FAQ <br></kbd>][FAQ]** **[<kbd><br> Credits <br></kbd>][Credits]**
|
||||
|
||||
</p></div>
|
||||
|
||||
|
|
@ -64,12 +64,21 @@
|
|||
|
||||
## Features
|
||||
|
||||
[standalone]: https://notashelf.github.io/nvf/index.xhtml#ch-standalone-installation
|
||||
[NixOS module]: https://notashelf.github.io/nvf/index.xhtml#ch-standalone-nixos
|
||||
[Home-Manager module]: https://notashelf.github.io/nvf/index.xhtml#ch-standalone-hm
|
||||
|
||||
- **Simple**: One language to rule them all! Use Nix to configure everything,
|
||||
with additional Lua Support
|
||||
- **Reproducible**: Your configuration will behave the same _anywhere_. No
|
||||
surprises, promise!
|
||||
- **Portable**: nvf depends _solely_ on your Nix store, and nothing else. No
|
||||
more global binaries! Works on all platforms, without hassle.
|
||||
- Options to install [standalone], [NixOS module] or [Home-Manager module].
|
||||
- **Customizable**: There are _almost no defaults_ to annoy you. nvf is fully
|
||||
customizable through the Nix module system.
|
||||
- Not comfortable with a full-nix config or want to bring your Lua config? You
|
||||
can do just that, no unnecessary restrictions.
|
||||
- **Well-documented**: Documentation is priority. You will _never_ face
|
||||
undocumented, obscure behaviour.
|
||||
- **Idiomatic**: nvf does things ✨ _the right way_ ✨ - the codebase is, and
|
||||
|
|
@ -120,7 +129,9 @@ instructions.
|
|||
|
||||
## Documentation
|
||||
|
||||
The _recommended_ way of installing **nvf** is using either the NixOS or the
|
||||
### Installation
|
||||
|
||||
The _recommended_ way of installing nvf is using either the NixOS or the
|
||||
Home-Manager module, though it is completely possible and no less supported to
|
||||
install **nvf** as a standalone package, or a flake output.
|
||||
|
||||
|
|
@ -138,11 +149,13 @@ Please create an issue on the [issue tracker] if you find the documentation
|
|||
lacking or confusing. Any improvements to the documentation through pull
|
||||
requests are also welcome, and appreciated.
|
||||
|
||||
## Help
|
||||
## Getting Help
|
||||
|
||||
You can create an issue on the [issue tracker] to ask questions or report bugs.
|
||||
I am not yet on spaces like matrix or IRC, so please use the issue tracker for
|
||||
now.
|
||||
If you are confused, stuck or would like to ask a simple question; you may
|
||||
create an issue on the [issue tracker] to ask questions or report bugs.
|
||||
|
||||
We are not not yet on spaces like matrix or IRC, so please use the issue tracker
|
||||
for now.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -152,7 +165,7 @@ submitting a pull request. You can also create an issue on the [issue tracker]
|
|||
before submitting a pull request if you would like to discuss a feature or bug
|
||||
fix.
|
||||
|
||||
## FAQ
|
||||
## Frequently Asked Questions
|
||||
|
||||
[appropriate issue template]: https://github.com/NotAShelf/nvf/issues/new/choose
|
||||
[list of branches]: https://github.com/NotAShelf/nvf/branches
|
||||
|
|
@ -160,13 +173,15 @@ fix.
|
|||
|
||||
**Q**: What platforms are supported?
|
||||
<br/> **A**: nvf actively supports Linux and Darwin platforms using standalone
|
||||
Nix, NixOS or Home-Manager. Please take a look at the
|
||||
Nix, NixOS or Home-Manager. Please take a look at the [nvf manual] for available
|
||||
installation instructions.
|
||||
|
||||
**Q**: Can you add _X_?
|
||||
<br/> **A**: Maybe! It is not one of our goals to support each and every Neovim
|
||||
plugin, however, I am always open to new modules and plugin setup additions to
|
||||
**nvf**. Use the [appropriate issue template] and I will consider a module
|
||||
addition. As mentioned before, PRs adding new features are also welcome.
|
||||
addition. As mentioned before, pull requests to add new features are also
|
||||
welcome.
|
||||
|
||||
**Q**: A plugin I need is not available in **nvf**. What to do?
|
||||
<br/> **A**: **nvf** exposes several APIs for you to be able to add your own
|
||||
|
|
@ -185,22 +200,26 @@ better prepare to breaking changes.
|
|||
|
||||
### Contributors
|
||||
|
||||
Special, heart-felt thanks to
|
||||
[mnw]: https://github.com/gerg-l/mnw
|
||||
|
||||
- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts
|
||||
- [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to
|
||||
work
|
||||
nvf would not be what it is today without the awesome people below. Special,
|
||||
heart-felt thanks to
|
||||
|
||||
- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts and
|
||||
invaluable Nix assistance.
|
||||
- [@FlafyDev](https://github.com/FlafyDev) - For getting home-manager module to
|
||||
work and Nix assistance.
|
||||
- [@n3oney](https://github.com/n3oney) - For making custom keybinds finally
|
||||
possible
|
||||
possible, and other module additions.
|
||||
- [@horriblename](https://github.com/horriblename) - For actively implementing
|
||||
planned features and quality of life updates
|
||||
planned features and quality of life updates.
|
||||
- [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
|
||||
- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I
|
||||
could not
|
||||
- [@Diniamo](https://github.com/Diniamo) - For actively submitting PRs, pull
|
||||
requests and overall assistence
|
||||
- [@Gerg-l](https://github.com/gerg-l) - For the modern Neovim wrapper, mnw and
|
||||
occasional code improvements
|
||||
could not.
|
||||
- [@Diniamo](https://github.com/Diniamo) - For actively submitting pull
|
||||
requests, issues and assistance with maintenance of nvf.
|
||||
- [@Gerg-l](https://github.com/gerg-l) - For the modern Neovim wrapper, [mnw],
|
||||
and occasional code improvements.
|
||||
|
||||
and everyone who has submitted issues or pull requests!
|
||||
|
||||
|
|
@ -214,7 +233,7 @@ including:
|
|||
is originally based on.
|
||||
- [@sioodmy's](https://github.com/sioodmy)
|
||||
[dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design
|
||||
choices.
|
||||
choices for UI and plugin defaults.
|
||||
- [@wiltaylor's](https://github.com/wiltaylor)
|
||||
[neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and
|
||||
design ideas.
|
||||
|
|
@ -229,10 +248,11 @@ recommend checking their work out.
|
|||
## License
|
||||
|
||||
Following the license of the
|
||||
[original neovim-flake](https://github.com/jordanisaacs/neovim-flake), **nvf**
|
||||
has been made available under the [**MIT License**](LICENSE). However, all
|
||||
assets and documentation are published under the
|
||||
[**CC BY License**](https://github.com/NotAShelf/nvf/blob/main/.github/assets/LICENSE).
|
||||
[original neovim-flake](https://github.com/jordanisaacs/neovim-flake), nvf has
|
||||
been made available under the [**MIT License**](LICENSE). However, all assets
|
||||
and documentation are published under the
|
||||
[**CC BY License**](https://github.com/NotAShelf/nvf/blob/main/.github/assets/LICENSE)
|
||||
under explicit permission by the artist.
|
||||
|
||||
<h6 align="center">Yes, this includes the logo work too. Stop taking artwork that is not yours!</h6>
|
||||
|
||||
|
|
|
|||
2
.github/typos.toml
vendored
Normal file
2
.github/typos.toml
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
|
||||
default.extend-ignore-words-re = ["(?i)(noice)", "befores", "annote", "viw"]
|
||||
24
.github/workflows/check-docs.yml
vendored
24
.github/workflows/check-docs.yml
vendored
|
|
@ -19,19 +19,12 @@ jobs:
|
|||
- docs-manpages
|
||||
- docs-json
|
||||
steps:
|
||||
- uses: easimon/maximize-build-space@v10
|
||||
with:
|
||||
overprovision-lvm: true
|
||||
remove-android: true
|
||||
remove-dotnet: true
|
||||
remove-haskell: true
|
||||
|
||||
- name: Install Nix
|
||||
uses: DeterminateSystems/nix-installer-action@main
|
||||
- uses: DeterminateSystems/magic-nix-cache-action@main
|
||||
|
||||
- uses: actions/checkout@v4
|
||||
name: Checkout
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set default git branch (to reduce log spam)
|
||||
run: git config --global init.defaultBranch main
|
||||
|
|
@ -49,3 +42,16 @@ jobs:
|
|||
with:
|
||||
name: "${{ matrix.package }}"
|
||||
path: result/share/doc/nvf
|
||||
flake-docs-linkcheck:
|
||||
name: Validate hyperlinks in documentation sources
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Install Nix
|
||||
uses: DeterminateSystems/nix-installer-action@main
|
||||
- uses: DeterminateSystems/magic-nix-cache-action@main
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Build documentation packages
|
||||
run: nix build .#docs-linkcheck -Lv
|
||||
|
|
|
|||
2
.github/workflows/editorconfig.yml
vendored
2
.github/workflows/editorconfig.yml
vendored
|
|
@ -15,7 +15,7 @@ jobs:
|
|||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
gh api \
|
||||
repos/notashelf/neovim-flake/pulls/${{github.event.number}}/files --paginate \
|
||||
repos/notashelf/nvf/pulls/${{github.event.number}}/files --paginate \
|
||||
| jq '.[] | select(.status != "removed") | .filename' \
|
||||
> "$HOME/changed_files"
|
||||
|
||||
|
|
|
|||
2
.github/workflows/manual.yml
vendored
2
.github/workflows/manual.yml
vendored
|
|
@ -47,7 +47,7 @@ jobs:
|
|||
- uses: DeterminateSystems/nix-installer-action@main
|
||||
- uses: DeterminateSystems/magic-nix-cache-action@main
|
||||
- run: |
|
||||
nix build .#docs
|
||||
nix build .#docs -Lv
|
||||
cp -r result/share/doc/nvf public
|
||||
- uses: peaceiris/actions-gh-pages@v4
|
||||
with:
|
||||
|
|
|
|||
30
.github/workflows/typos.yml
vendored
Normal file
30
.github/workflows/typos.yml
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
name: "Check for typos in the source tree"
|
||||
|
||||
permissions: read-all
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
check-typos:
|
||||
runs-on: ubuntu-latest
|
||||
if: "!contains(github.event.pull_request.title, '[skip ci]')"
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Check for typos
|
||||
uses: crate-ci/typos@master
|
||||
with:
|
||||
config: .github/typos.toml
|
||||
|
||||
- name: Fail Gracefully
|
||||
if: ${{ failure() }}
|
||||
shell: bash
|
||||
run: |
|
||||
echo "::error:: Current codebase contains typos that were caught by the CI!"
|
||||
echo "If those typos were intentional, please add them to the ignored regexes in .github/typos.toml"
|
||||
echo "[skip ci] label may be used if this is a one-time issue"
|
||||
exit 1
|
||||
141
docs/manual.nix
141
docs/manual.nix
|
|
@ -1,63 +1,112 @@
|
|||
{
|
||||
lib,
|
||||
stdenvNoCC,
|
||||
fetchzip,
|
||||
runCommandLocal,
|
||||
# build inputs
|
||||
nixos-render-docs,
|
||||
documentation-highlighter,
|
||||
dart-sass,
|
||||
path,
|
||||
# nrd configuration
|
||||
release,
|
||||
optionsJSON,
|
||||
}:
|
||||
stdenvNoCC.mkDerivation {
|
||||
name = "nvf-manual";
|
||||
src = builtins.path {
|
||||
path = lib.sourceFilesBySuffices ./manual [".md"];
|
||||
name = "nvf-manual";
|
||||
} @ args: let
|
||||
manual-release = args.release or "unstable";
|
||||
|
||||
scss-reset = fetchzip {
|
||||
url = "https://github.com/Frontend-Layers/scss-reset/archive/refs/tags/1.4.2.zip";
|
||||
hash = "sha256-cif5Sx8Ca5vxdw/mNAgpulLH15TwmzyJFNM7JURpoaE=";
|
||||
};
|
||||
|
||||
nativeBuildInputs = [nixos-render-docs];
|
||||
compileStylesheet = runCommandLocal "compile-nvf-stylesheet" {} ''
|
||||
mkdir -p $out
|
||||
|
||||
buildPhase = ''
|
||||
dest="$out/share/doc/nvf"
|
||||
mkdir -p "$(dirname "$dest")"
|
||||
mkdir -p $dest/{highlightjs,media}
|
||||
tmpfile=$(mktemp -d)
|
||||
trap "rm -r $tmpfile" EXIT
|
||||
|
||||
cp -vt $dest/highlightjs \
|
||||
${documentation-highlighter}/highlight.pack.js \
|
||||
${documentation-highlighter}/LICENSE \
|
||||
${documentation-highlighter}/mono-blue.css \
|
||||
${documentation-highlighter}/loader.js
|
||||
ln -s "${scss-reset}/build" "$tmpfile/scss-reset"
|
||||
|
||||
substituteInPlace ./options.md \
|
||||
--subst-var-by \
|
||||
OPTIONS_JSON \
|
||||
${optionsJSON}/share/doc/nixos/options.json
|
||||
${dart-sass}/bin/sass --load-path "$tmpfile" \
|
||||
${./static/style.scss} "$out/style.css"
|
||||
|
||||
substituteInPlace ./manual.md \
|
||||
--subst-var-by \
|
||||
NVF_VERSION \
|
||||
${release}
|
||||
|
||||
# copy stylesheet
|
||||
cp ${./static/style.css} "$dest/style.css"
|
||||
|
||||
# copy release notes
|
||||
cp -vr ${./release-notes} release-notes
|
||||
|
||||
# generate manual from
|
||||
nixos-render-docs manual html \
|
||||
--manpage-urls ${path + "/doc/manpage-urls.json"} \
|
||||
--revision ${lib.trivial.revisionWithDefault release} \
|
||||
--stylesheet style.css \
|
||||
--script highlightjs/highlight.pack.js \
|
||||
--script highlightjs/loader.js \
|
||||
--toc-depth 2 \
|
||||
--section-toc-depth 1 \
|
||||
manual.md \
|
||||
"$dest/index.xhtml"
|
||||
|
||||
mkdir -p $out/nix-support/
|
||||
echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products
|
||||
echo "Generated styles"
|
||||
'';
|
||||
}
|
||||
in
|
||||
stdenvNoCC.mkDerivation {
|
||||
name = "nvf-manual";
|
||||
src = builtins.path {
|
||||
name = "nvf-manual-${manual-release}";
|
||||
path = lib.sourceFilesBySuffices ./manual [".md" ".md.in"];
|
||||
};
|
||||
|
||||
strictDependencies = true;
|
||||
nativeBuildInputs = [nixos-render-docs];
|
||||
|
||||
postPatch = ''
|
||||
ln -s ${optionsJSON}/share/doc/nixos/options.json ./config-options.json
|
||||
'';
|
||||
|
||||
buildPhase = ''
|
||||
dest="$out/share/doc/nvf"
|
||||
mkdir -p "$(dirname "$dest")"
|
||||
mkdir -p $dest/{highlightjs,script}
|
||||
|
||||
# Copy highlight scripts to /highlights in document root.
|
||||
cp -vt $dest/highlightjs \
|
||||
${documentation-highlighter}/highlight.pack.js \
|
||||
${documentation-highlighter}/LICENSE \
|
||||
${documentation-highlighter}/mono-blue.css \
|
||||
${documentation-highlighter}/loader.js
|
||||
|
||||
# Copy anchor scripts to the script directory in document root.
|
||||
cp -vt "$dest"/script \
|
||||
${./static/script}/anchor-min.js \
|
||||
${./static/script}/anchor-use.js
|
||||
|
||||
substituteInPlace ./options.md \
|
||||
--subst-var-by OPTIONS_JSON ./config-options.json
|
||||
|
||||
substituteInPlace ./manual.md \
|
||||
--subst-var-by NVF_VERSION ${manual-release}
|
||||
|
||||
substituteInPlace ./hacking/additional-plugins.md \
|
||||
--subst-var-by NVF_REPO "https://github.com/notashelf/nvf/blob/${manual-release}"
|
||||
|
||||
# Move compiled stylesheet
|
||||
cp -vt $dest \
|
||||
${compileStylesheet}/style.css
|
||||
|
||||
# Move release notes
|
||||
cp -vr ${./release-notes} release-notes
|
||||
|
||||
# Generate final manual from a set of parameters. Explanation of the CLI flags are
|
||||
# as follows:
|
||||
#
|
||||
# 1. --manpage-urls will allow you to use manual pages as they are defined in
|
||||
# the nixpkgs documentation.
|
||||
# 2. --revision is the project revision as it is defined in 'release.json' in the
|
||||
# repository root
|
||||
# 3. --script will inject a given Javascript file into the resulting pages inside
|
||||
# the <script> tag.
|
||||
# 4. --toc-depth will determine the depth of the initial Table of Contents while
|
||||
# --section-toc-depth will determine the depth of per-section Table of Contents
|
||||
# sections.
|
||||
nixos-render-docs manual html \
|
||||
--manpage-urls ${path + "/doc/manpage-urls.json"} \
|
||||
--revision ${lib.trivial.revisionWithDefault manual-release} \
|
||||
--stylesheet "$dest"/style.css \
|
||||
--script ./highlightjs/highlight.pack.js \
|
||||
--script ./highlightjs/loader.js \
|
||||
--script script/anchor-use.js \
|
||||
--script script/anchor-min.js \
|
||||
--toc-depth 2 \
|
||||
--section-toc-depth 1 \
|
||||
manual.md \
|
||||
"$dest/index.xhtml"
|
||||
|
||||
# Hydra support. Probably not necessary.
|
||||
mkdir -p $out/nix-support/
|
||||
echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products
|
||||
'';
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
```{=include=} chapters
|
||||
configuring/custom-package.md
|
||||
configuring/custom-plugins.md
|
||||
configuring/custom-inputs.md
|
||||
configuring/languages.md
|
||||
configuring/dags.md
|
||||
configuring/dag-entries.md
|
||||
|
|
|
|||
53
docs/manual/configuring/custom-inputs.md
Normal file
53
docs/manual/configuring/custom-inputs.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Custom Inputs {#ch-custom-inputs}
|
||||
|
||||
One of the greatest strengths of **nvf** is its ability to get plugins from
|
||||
flake inputs and build them locally from any given source. For plugins that do
|
||||
not require any kind of additional building step, this is a powerful method of
|
||||
adding plugins to your configuration that are not packaged in nixpkgs, or those
|
||||
you want to track from source without relying on nixpkgs.
|
||||
|
||||
The [additional plugins section](#sec-additional-plugins) details the addition
|
||||
of new plugins to nvf under regular circumstances, i.e. while making a pull
|
||||
request to the project. You may _override_ those plugin inputs in your own
|
||||
`flake.nix` to change source versions, e.g., to use newer versions of plugins
|
||||
that are not yet updated in **nvf**.
|
||||
|
||||
```nix
|
||||
{
|
||||
|
||||
inputs = {
|
||||
# ...
|
||||
|
||||
# The name here is arbitrary, you can name it whatever.
|
||||
# This will add a plugin input called "your-neodev-input"
|
||||
# that you can reference in a `follows` line.
|
||||
your-neodev-input = {
|
||||
url = "github:folke/neodev.nvim";
|
||||
flake = false;
|
||||
};
|
||||
|
||||
nvf = {
|
||||
url = "github:notashelf/nvf";
|
||||
|
||||
# The name of the input must match for the follows line
|
||||
# plugin-neodev-nvim is what the input is called inside nvf
|
||||
# so you must match the exact name here.
|
||||
inputs.plugin-neodev-nvim.follows = "your-neodev-input";
|
||||
};
|
||||
# ...
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
This will override the source for the `neodev.nvim` plugin that is used in nvf
|
||||
with your own input. You can update your new input via `nix flake update` or
|
||||
more specifically `nix flake update <name of your input>` to keep it up to date.
|
||||
|
||||
::: {.warning}
|
||||
|
||||
While updating plugin inputs, make sure that any configuration that has been
|
||||
deprecated in newer versions is changed in the plugin's `setupOpts`. If you
|
||||
depend on a new version, requesting a version bump in the issues section is a
|
||||
more reliable option.
|
||||
|
||||
:::
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
# Custom Plugins {#ch-custom-plugins}
|
||||
|
||||
**nvf**, by default, exposes a wide variety of plugins as module options
|
||||
for your convenience and bundles necessary dependencies into **nvf**'s runtime.
|
||||
In case a plugin is not available in **nvf**, you may consider making a pull
|
||||
**nvf**, by default, exposes a wide variety of plugins as module options for
|
||||
your convenience and bundles necessary dependencies into **nvf**'s runtime. In
|
||||
case a plugin is not available in **nvf**, you may consider making a pull
|
||||
request to **nvf** to include it as a module or you may add it to your
|
||||
configuration locally.
|
||||
|
||||
|
|
@ -11,12 +11,12 @@ configuration locally.
|
|||
There are multiple ways of adding custom plugins to your **nvf** configuration.
|
||||
|
||||
You can use custom plugins, before they are implemented in the flake. To add a
|
||||
plugin to the runtime, you need to add it to the `vim.startPlugins` list in
|
||||
your configuration.
|
||||
plugin to the runtime, you need to add it to the [](#opt-vim.startPlugins) list
|
||||
in your configuration.
|
||||
|
||||
Adding a plugin to `startPlugins` will not allow you to configure the plugin
|
||||
that you have adeed, but **nvf** provides multiple way of configuring any
|
||||
custom plugins that you might have added to your configuration.
|
||||
that you have added, but **nvf** provides multiple way of configuring any custom
|
||||
plugins that you might have added to your configuration.
|
||||
|
||||
```{=include=} sections
|
||||
custom-plugins/configuring.md
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
# Configuring {#sec-configuring-plugins}
|
||||
|
||||
Just making the plugin to your Neovim configuration available might not always be enough. In that
|
||||
case, you can write custom lua config using either `config.vim.lazy.plugins.*.setupOpts`
|
||||
`config.vim.extraPlugins.*.setup` or `config.vim.luaConfigRC`.
|
||||
Just making the plugin to your Neovim configuration available might not always
|
||||
be enough. In that case, you can write custom lua config using either
|
||||
`config.vim.lazy.plugins.*.setupOpts` `config.vim.extraPlugins.*.setup` or
|
||||
`config.vim.luaConfigRC`.
|
||||
|
||||
The first option uses an extended version of `lz.n`'s PluginSpec. `setupModule` and `setupOpt` can
|
||||
be used if the plugin uses a `require('module').setup(...)` pattern. Otherwise, the `before` and
|
||||
`after` hooks should do what you need.
|
||||
The first option uses an extended version of `lz.n`'s PluginSpec. `setupModule`
|
||||
and `setupOpt` can be used if the plugin uses a `require('module').setup(...)`
|
||||
pattern. Otherwise, the `before` and `after` hooks should do what you need.
|
||||
|
||||
```nix
|
||||
{
|
||||
|
|
@ -24,10 +25,11 @@ be used if the plugin uses a `require('module').setup(...)` pattern. Otherwise,
|
|||
}
|
||||
```
|
||||
|
||||
The second option uses an attribute set, which maps DAG section names to a custom type, which has
|
||||
the fields `package`, `after`, `setup`. They allow you to set the package of the plugin, the
|
||||
sections its setup code should be after (note that the `extraPlugins` option has its own DAG
|
||||
scope), and the its setup code respectively. For example:
|
||||
The second option uses an attribute set, which maps DAG section names to a
|
||||
custom type, which has the fields `package`, `after`, `setup`. They allow you to
|
||||
set the package of the plugin, the sections its setup code should be after (note
|
||||
that the `extraPlugins` option has its own DAG scope), and the its setup code
|
||||
respectively. For example:
|
||||
|
||||
```nix
|
||||
config.vim.extraPlugins = with pkgs.vimPlugins; {
|
||||
|
|
@ -56,13 +58,17 @@ For example:
|
|||
}
|
||||
```
|
||||
|
||||
:::{.note}
|
||||
If your configuration needs to be put in a specific place in the config, you
|
||||
can use functions from `inputs.nvf.lib.nvim.dag` to order it. Refer to
|
||||
https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix
|
||||
<!-- deno-fmt-ignore-start -->
|
||||
|
||||
::: {.note}
|
||||
One of the greatest strengths of nvf is the ability to order
|
||||
snippets of configuration via the DAG system. It will allow specifying positions
|
||||
of individual sections of configuration as needed. nvf provides helper functions
|
||||
in the extended library, usually under `inputs.nvf.lib.nvim.dag` that you may
|
||||
use.
|
||||
|
||||
Please refer to the [DAG section](/index.xhtml#ch-dag-entries) in the nvf manual
|
||||
to find out more about the DAG system.
|
||||
:::
|
||||
|
||||
If you successfully made your plugin work, please feel free to create a PR to
|
||||
add it to **nvf** or open an issue with your findings so that we can make it
|
||||
available for everyone easily.
|
||||
<!-- deno-fmt-ignore-end -->
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Legacy Method {#sec-legacy-method}
|
||||
|
||||
Prior to version 0.5, the method of adding new plugins was adding the plugin
|
||||
Prior to version v0.5, the method of adding new plugins was adding the plugin
|
||||
package to `vim.startPlugins` and add its configuration as a DAG under one of
|
||||
`vim.configRC` or `vim.luaConfigRC`. Users who have not yet updated to 0.5, or
|
||||
prefer a more hands-on approach may use the old method where the load order of
|
||||
|
|
@ -8,13 +8,14 @@ the plugins is determined by DAGs.
|
|||
|
||||
## Adding plugins {#sec-adding-plugins}
|
||||
|
||||
To add a plugin to **nvf**'s runtime, you may add it
|
||||
To add a plugin not available in nvf as a module to your configuration, you may
|
||||
add it to [](#opt-vim.startPlugins) in order to make it available to Neovim at
|
||||
runtime.
|
||||
|
||||
```nix
|
||||
{pkgs, ...}: {
|
||||
# add a package from nixpkgs to startPlugins
|
||||
vim.startPlugins = [
|
||||
pkgs.vimPlugins.aerial-nvim ];
|
||||
# Add a Neovim plugin from Nixpkgs to the runtime.
|
||||
vim.startPlugins = [pkgs.vimPlugins.aerial-nvim];
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -23,7 +24,9 @@ provide configuration as a DAG using the **nvf** extended library.
|
|||
|
||||
```nix
|
||||
{inputs, ...}: let
|
||||
# assuming you have an input called nvf pointing at the nvf repository
|
||||
# This assumes you have an input called 'nvf' in your flake inputs
|
||||
# and 'inputs' in your specialArgs. In the case you have passed 'nvf'
|
||||
# to specialArgs, the 'inputs' prefix may be omitted.
|
||||
inherit (inputs.nvf.lib.nvim.dag) entryAnywhere;
|
||||
in {
|
||||
vim.luaConfigRC.aerial-nvim= entryAnywhere ''
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ entries in nvf:
|
|||
2. `globalsScript` - used to set globals defined in `vim.globals`
|
||||
3. `basic` - used to set basic configuration options
|
||||
4. `optionsScript` - used to set options defined in `vim.o`
|
||||
5. `theme` (this is simply placed before `pluginConfigs` and `lazyConfigs`, meaning that
|
||||
surrounding entries don't depend on it) - used to set up the theme, which has to be done before
|
||||
other plugins
|
||||
5. `theme` (this is simply placed before `pluginConfigs` and `lazyConfigs`,
|
||||
meaning that surrounding entries don't depend on it) - used to set up the
|
||||
theme, which has to be done before other plugins
|
||||
6. `lazyConfigs` - `lz.n` and `lzn-auto-require` configs. If `vim.lazy.enable`
|
||||
is false, this will contain each plugin's config instead.
|
||||
7. `pluginConfigs` - the result of the nested `vim.pluginRC` (internal option,
|
||||
|
|
|
|||
|
|
@ -1,25 +1,23 @@
|
|||
# Using DAGs {#ch-using-dags}
|
||||
|
||||
We conform to the NixOS options types for the most part, however, a noteworthy
|
||||
addition for certain options is the [**DAG
|
||||
(Directed acyclic graph)**](https://en.wikipedia.org/wiki/Directed_acyclic_graph)
|
||||
addition for certain options is the
|
||||
[**DAG (Directed acyclic graph)**](https://en.wikipedia.org/wiki/Directed_acyclic_graph)
|
||||
type which is borrowed from home-manager's extended library. This type is most
|
||||
used for topologically sorting strings. The DAG type allows the attribute set
|
||||
entries to express dependency relations among themselves. This can, for
|
||||
example, be used to control the order of configuration sections in your
|
||||
`luaConfigRC`.
|
||||
entries to express dependency relations among themselves. This can, for example,
|
||||
be used to control the order of configuration sections in your `luaConfigRC`.
|
||||
|
||||
The below section, mostly taken from the [home-manager
|
||||
manual](https://raw.githubusercontent.com/nix-community/home-manager/master/docs/manual/writing-modules/types.md)
|
||||
The below section, mostly taken from the
|
||||
[home-manager manual](https://raw.githubusercontent.com/nix-community/home-manager/master/docs/manual/writing-modules/types.md)
|
||||
explains in more detail the overall usage logic of the DAG type.
|
||||
|
||||
## entryAnywhere {#sec-types-dag-entryAnywhere}
|
||||
|
||||
> `lib.dag.entryAnywhere (value: T) : DagEntry<T>`
|
||||
|
||||
Indicates that `value` can be placed anywhere within the DAG.
|
||||
This is also the default for plain attribute set entries, that
|
||||
is
|
||||
Indicates that `value` can be placed anywhere within the DAG. This is also the
|
||||
default for plain attribute set entries, that is
|
||||
|
||||
```nix
|
||||
foo.bar = {
|
||||
|
|
@ -41,8 +39,8 @@ are equivalent.
|
|||
|
||||
> `lib.dag.entryAfter (afters: list string) (value: T) : DagEntry<T>`
|
||||
|
||||
Indicates that `value` must be placed _after_ each of the
|
||||
attribute names in the given list. For example
|
||||
Indicates that `value` must be placed _after_ each of the attribute names in the
|
||||
given list. For example
|
||||
|
||||
```nix
|
||||
foo.bar = {
|
||||
|
|
@ -57,8 +55,8 @@ would place `b` after `a` in the graph.
|
|||
|
||||
> `lib.dag.entryBefore (befores: list string) (value: T) : DagEntry<T>`
|
||||
|
||||
Indicates that `value` must be placed _before_ each of the
|
||||
attribute names in the given list. For example
|
||||
Indicates that `value` must be placed _before_ each of the attribute names in
|
||||
the given list. For example
|
||||
|
||||
```nix
|
||||
foo.bar = {
|
||||
|
|
@ -73,9 +71,8 @@ would place `b` before `a` in the graph.
|
|||
|
||||
> `lib.dag.entryBetween (befores: list string) (afters: list string) (value: T) : DagEntry<T>`
|
||||
|
||||
Indicates that `value` must be placed _before_ the attribute
|
||||
names in the first list and _after_ the attribute names in the
|
||||
second list. For example
|
||||
Indicates that `value` must be placed _before_ the attribute names in the first
|
||||
list and _after_ the attribute names in the second list. For example
|
||||
|
||||
```nix
|
||||
foo.bar = {
|
||||
|
|
@ -87,18 +84,18 @@ foo.bar = {
|
|||
|
||||
would place `c` before `b` and after `a` in the graph.
|
||||
|
||||
There are also a set of functions that generate a DAG from a list.
|
||||
These are convenient when you just want to have a linear list of DAG
|
||||
entries, without having to manually enter the relationship between
|
||||
each entry. Each of these functions take a `tag` as argument and the
|
||||
DAG entries will be named `${tag}-${index}`.
|
||||
There are also a set of functions that generate a DAG from a list. These are
|
||||
convenient when you just want to have a linear list of DAG entries, without
|
||||
having to manually enter the relationship between each entry. Each of these
|
||||
functions take a `tag` as argument and the DAG entries will be named
|
||||
`${tag}-${index}`.
|
||||
|
||||
## entriesAnywhere {#sec-types-dag-entriesAnywhere}
|
||||
|
||||
> `lib.dag.entriesAnywhere (tag: string) (values: [T]) : Dag<T>`
|
||||
|
||||
Creates a DAG with the given values with each entry labeled
|
||||
using the given tag. For example
|
||||
Creates a DAG with the given values with each entry labeled using the given tag.
|
||||
For example
|
||||
|
||||
```nix
|
||||
foo.bar = lib.dag.entriesAnywhere "a" [ 0 1 ];
|
||||
|
|
@ -117,9 +114,9 @@ foo.bar = {
|
|||
|
||||
> `lib.dag.entriesAfter (tag: string) (afters: list string) (values: [T]) : Dag<T>`
|
||||
|
||||
Creates a DAG with the given values with each entry labeled
|
||||
using the given tag. The list of values are placed are placed
|
||||
_after_ each of the attribute names in `afters`. For example
|
||||
Creates a DAG with the given values with each entry labeled using the given tag.
|
||||
The list of values are placed are placed _after_ each of the attribute names in
|
||||
`afters`. For example
|
||||
|
||||
```nix
|
||||
foo.bar =
|
||||
|
|
@ -140,13 +137,13 @@ foo.bar = {
|
|||
|
||||
> `lib.dag.entriesBefore (tag: string) (befores: list string) (values: [T]) : Dag<T>`
|
||||
|
||||
Creates a DAG with the given values with each entry labeled
|
||||
using the given tag. The list of values are placed _before_ each
|
||||
of the attribute names in `befores`. For example
|
||||
Creates a DAG with the given values with each entry labeled using the given tag.
|
||||
The list of values are placed _before_ each of the attribute names in `befores`.
|
||||
For example
|
||||
|
||||
```nix
|
||||
foo.bar =
|
||||
{ b = 0; } // lib.dag.entriesBefore "a" [ "b" ] [ 1 2 ];
|
||||
foo.bar =
|
||||
{ b = 0; } // lib.dag.entriesBefore "a" [ "b" ] [ 1 2 ];
|
||||
```
|
||||
|
||||
is equivalent to
|
||||
|
|
@ -163,10 +160,9 @@ foo.bar = {
|
|||
|
||||
> `lib.dag.entriesBetween (tag: string) (befores: list string) (afters: list string) (values: [T]) : Dag<T>`
|
||||
|
||||
Creates a DAG with the given values with each entry labeled
|
||||
using the given tag. The list of values are placed _before_ each
|
||||
of the attribute names in `befores` and _after_ each of the
|
||||
attribute names in `afters`. For example
|
||||
Creates a DAG with the given values with each entry labeled using the given tag.
|
||||
The list of values are placed _before_ each of the attribute names in `befores`
|
||||
and _after_ each of the attribute names in `afters`. For example
|
||||
|
||||
```nix
|
||||
foo.bar =
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
Language specific support means there is a combination of language specific
|
||||
plugins, `treesitter` support, `nvim-lspconfig` language servers, and `null-ls`
|
||||
integration. This gets you capabilities ranging from autocompletion to formatting
|
||||
to diagnostics. The following languages have sections under the `vim.languages`
|
||||
attribute.
|
||||
integration. This gets you capabilities ranging from autocompletion to
|
||||
formatting to diagnostics. The following languages have sections under the
|
||||
`vim.languages` attribute.
|
||||
|
||||
- Rust: [vim.languages.rust.enable](#opt-vim.languages.rust.enable)
|
||||
- Nix: [vim.languages.nix.enable](#opt-vim.languages.nix.enable)
|
||||
|
|
@ -20,8 +20,8 @@ attribute.
|
|||
- Lua: [vim.languages.lua.enable](#opt-vim.languages.lua.enable)
|
||||
- PHP: [vim.languages.php.enable](#opt-vim.languages.php.enable)
|
||||
|
||||
Adding support for more languages, and improving support for existing ones are great places
|
||||
where you can contribute with a PR.
|
||||
Adding support for more languages, and improving support for existing ones are
|
||||
great places where you can contribute with a PR.
|
||||
|
||||
```{=include=} sections
|
||||
languages/lsp.md
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# LSP Custom Packages/Command {#sec-languages-custom-lsp-packages}
|
||||
|
||||
In any of the `opt.languages.<language>.lsp.package` options you can provide
|
||||
your own LSP package, or provide the command to launch the language server, as
|
||||
a list of strings. You can use this to skip automatic installation of a language
|
||||
your own LSP package, or provide the command to launch the language server, as a
|
||||
list of strings. You can use this to skip automatic installation of a language
|
||||
server, and instead use the one found in your `$PATH` during runtime, for
|
||||
example:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
# Default Configs {#ch-default-configs}
|
||||
|
||||
While you can configure **nvf** yourself using the builder, you can also use the pre-built configs that are available.
|
||||
Here are a few default configurations you can use.
|
||||
While you can configure **nvf** yourself using the builder, you can also use the
|
||||
pre-built configs that are available. Here are a few default configurations you
|
||||
can use.
|
||||
|
||||
```{=include=} chapters
|
||||
default-configs/maximal.md
|
||||
|
|
|
|||
|
|
@ -7,7 +7,5 @@ $ nix shell github:notashelf/nvf#maximal test.nix
|
|||
It is the same fully configured Neovim as with the [Nix](#sec-default-nix)
|
||||
configuration, but with every supported language enabled.
|
||||
|
||||
::: {.note}
|
||||
Running the maximal config will download _a lot_ of packages as it is
|
||||
downloading language servers, formatters, and more.
|
||||
:::
|
||||
::: {.note} Running the maximal config will download _a lot_ of packages as it
|
||||
is downloading language servers, formatters, and more. :::
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
# Hacking nvf {#ch-hacking}
|
||||
|
||||
**nvf** is designed for developers as much as it is for the end user. I would like any potential contributor
|
||||
to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides
|
||||
(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates
|
||||
into **nvf**'s development without leaving question marks in your head.
|
||||
[open issues]: https://github.com/notashelf/nvf/issues
|
||||
[new issue]: https://github.com/notashelf/nvf/issues/new
|
||||
|
||||
This section is mainly directed towards those who wish to contribute code into **nvf**. If you wish to instead
|
||||
report a bug or discuss a potential feature implementation, first look among the
|
||||
already [open issues](https://github.com/notashelf/nvf/issues) and if no matching issue exists you may open
|
||||
a [new issue](https://github.com/notashelf/nvf/issues/new) and describe your problem/request. While creating an
|
||||
issue, please try to include as much information as you can, ideally also include relevant context in which an issue
|
||||
occurs or a feature should be implemented.
|
||||
nvf is designed for the developer as much as it is designed for the end-user. We
|
||||
would like for any contributor to be able to propagate their changes, or add new
|
||||
features to the project with minimum possible friction. As such, below are the
|
||||
guides and guidelines written to streamline the contribution process and to
|
||||
ensure that your valuable input integrates into nvf's development as seamlessly
|
||||
as possible without leaving any question marks in your head.
|
||||
|
||||
This section is directed mainly towards those who wish to contribute code into
|
||||
the project. If you instead wish to report a bug, or discuss a potential new
|
||||
feature implementation (which you do not wish to implement yourself) first look
|
||||
among the already [open issues] and if no matching issue exists you may open a
|
||||
[new issue] and describe your problem/request.
|
||||
|
||||
While creating an issue, please try to include as much information as you can,
|
||||
ideally also include relevant context in which an issue occurs or a feature
|
||||
should be implemented. If you wish to make a contribution, but feel stuck -
|
||||
please do not be afraid to submit a pull request, we will help you get it in.
|
||||
|
||||
```{=include=} sections
|
||||
hacking/getting-started.md
|
||||
|
|
|
|||
|
|
@ -1,10 +1,9 @@
|
|||
# Adding Plugins {#sec-additional-plugins}
|
||||
|
||||
To add a new Neovim plugin, first add the source url in the inputs section of `flake.nix`
|
||||
with the prefix `plugin-`
|
||||
To add a new Neovim plugin, first add the source url in the inputs section of
|
||||
`flake.nix` with the prefix `plugin-`
|
||||
|
||||
```nix
|
||||
|
||||
{
|
||||
inputs = {
|
||||
# ...
|
||||
|
|
@ -17,13 +16,18 @@ with the prefix `plugin-`
|
|||
}
|
||||
```
|
||||
|
||||
Prepending `plugin-` to the name of the input will allow nvf to automatically
|
||||
discover inputs that are marked as plugins, and make them available in
|
||||
`vim.startPlugins` or other areas that require a very specific plugin type as it
|
||||
is defined in `@NVF_REPO@/lib/types/plugins.nix`
|
||||
|
||||
The addition of the `plugin-` prefix will allow **nvf** to autodiscover the
|
||||
input from the flake inputs automatically, allowing you to refer to it in areas
|
||||
that require a very specific plugin type as defined in `lib/types/plugins.nix`
|
||||
|
||||
You can now reference this plugin using its string name, the plugin will be
|
||||
built with the name and source URL from the flake input, allowing you to
|
||||
refer to it as a **string**.
|
||||
built with the name and source URL from the flake input, allowing you to refer
|
||||
to it as a **string**.
|
||||
|
||||
```nix
|
||||
config.vim.startPlugins = ["neodev-nvim"];
|
||||
|
|
@ -33,11 +37,11 @@ config.vim.startPlugins = ["neodev-nvim"];
|
|||
|
||||
Most plugins is initialized with a call to `require('plugin').setup({...})`.
|
||||
|
||||
We use a special function that lets you easily add support for such setup options in a modular way:
|
||||
`mkPluginSetupOption`.
|
||||
We use a special function that lets you easily add support for such setup
|
||||
options in a modular way: `mkPluginSetupOption`.
|
||||
|
||||
Once you have added the source of the plugin as shown above, you can define the setup options like
|
||||
this:
|
||||
Once you have added the source of the plugin as shown above, you can define the
|
||||
setup options like this:
|
||||
|
||||
```nix
|
||||
# in modules/.../your-plugin/your-plugin.nix
|
||||
|
|
@ -86,7 +90,8 @@ require('plugin-name').setup({
|
|||
})
|
||||
```
|
||||
|
||||
Now users can set any of the pre-defined option field, and can also add their own fields!
|
||||
Now users can set any of the pre-defined option field, and can also add their
|
||||
own fields!
|
||||
|
||||
```nix
|
||||
# in user's config
|
||||
|
|
@ -110,8 +115,8 @@ As you've seen above, `toLuaObject` is used to convert our nix attrSet
|
|||
1. nix `null` converts to lua `nil`
|
||||
2. number and strings convert to their lua counterparts
|
||||
3. nix attrSet/list convert into lua tables
|
||||
4. you can write raw lua code using `lib.generators.mkLuaInline`. This
|
||||
function is part of nixpkgs.
|
||||
4. you can write raw lua code using `lib.generators.mkLuaInline`. This function
|
||||
is part of nixpkgs.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -127,8 +132,8 @@ vim.your-plugin.setupOpts = {
|
|||
|
||||
## Lazy plugins {#sec-lazy-plugins}
|
||||
|
||||
If the plugin can be lazy-loaded, `vim.lazy.plugins` should be used to add it. Lazy
|
||||
plugins are managed by `lz.n`.
|
||||
If the plugin can be lazy-loaded, `vim.lazy.plugins` should be used to add it.
|
||||
Lazy plugins are managed by `lz.n`.
|
||||
|
||||
```nix
|
||||
# in modules/.../your-plugin/config.nix
|
||||
|
|
@ -163,6 +168,7 @@ in {
|
|||
```
|
||||
|
||||
This results in the following lua code:
|
||||
|
||||
```lua
|
||||
require('lz.n').load({
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,16 +1,17 @@
|
|||
# Getting Started {#sec-contrib-getting-started}
|
||||
|
||||
You, naturally, would like to start by forking the repository to get started. If
|
||||
you are new to Git and GitHub, do have a look at GitHub's [Fork a repo guide](https://help.github.com/articles/fork-a-repo/)
|
||||
for instructions on how you can do this. Once you have a fork of **nvf**, you
|
||||
should create a separate branch based on the msot recent `main` branch. Give
|
||||
your branch a reasonably descriptive name (e.g. `feature/debugger` or
|
||||
you are new to Git and GitHub, do have a look at GitHub's
|
||||
[Fork a repo guide](https://help.github.com/articles/fork-a-repo/) for
|
||||
instructions on how you can do this. Once you have a fork of **nvf**, you should
|
||||
create a separate branch based on the most recent `main` branch. Give your
|
||||
branch a reasonably descriptive name (e.g. `feature/debugger` or
|
||||
`fix/pesky-bug`) and you are ready to work on your changes
|
||||
|
||||
Implement your changes and commit them to the newly created branch and when you
|
||||
are happy with the result, and positive that it fullfills our [Contributing
|
||||
Guidelines](#sec-guidelines), push the branch to GitHub and [create a pull
|
||||
request](https://help.github.com/articles/creating-a-pull-request). The default
|
||||
pull request template available on the **nvf** repository will guide you through
|
||||
the rest of the process, and we'll gently nudge you in the correct direction if
|
||||
there are any mistakes.
|
||||
are happy with the result, and positive that it fulfills our
|
||||
[Contributing Guidelines](#sec-guidelines), push the branch to GitHub and
|
||||
[create a pull request](https://help.github.com/articles/creating-a-pull-request).
|
||||
The default pull request template available on the **nvf** repository will guide
|
||||
you through the rest of the process, and we'll gently nudge you in the correct
|
||||
direction if there are any mistakes.
|
||||
|
|
|
|||
|
|
@ -3,30 +3,29 @@
|
|||
If your contribution tightly follows the guidelines, then there is a good chance
|
||||
it will be merged without too much trouble. Some of the guidelines will be
|
||||
strictly enforced, others will remain as gentle nudges towards the correct
|
||||
direction. As we have no automated system enforcing those guidelines, please
|
||||
try to double check your changes before making your pull request in order to
|
||||
avoid "faulty" code slipping by.
|
||||
direction. As we have no automated system enforcing those guidelines, please try
|
||||
to double check your changes before making your pull request in order to avoid
|
||||
"faulty" code slipping by.
|
||||
|
||||
If you are uncertain how these rules affect the change you would like to make
|
||||
then feel free to start a discussion in the [discussions tab](https://github.com/NotAShelf/nvf/discussions)
|
||||
ideally (but not necessarily) before you start developing.
|
||||
then feel free to start a discussion in the
|
||||
[discussions tab](https://github.com/NotAShelf/nvf/discussions) ideally (but not
|
||||
necessarily) before you start developing.
|
||||
|
||||
## Adding Documentation {#sec-guidelines-documentation}
|
||||
|
||||
Most, if not all, changes warrant changes to the documentation. Module options
|
||||
should be documented with [Nixpkgs-flavoured Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup),
|
||||
should be documented with
|
||||
[Nixpkgs-flavoured Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup),
|
||||
albeit with exceptions.
|
||||
|
||||
::: {.note}
|
||||
As of **v0.5**, **nvf** is itself documented using full markdown in both module
|
||||
options and the manual. With **v0.6**, this manual has also been converted to
|
||||
markdown in full.
|
||||
:::
|
||||
::: {.note} As of **v0.5**, **nvf** is itself documented using full markdown in
|
||||
both module options and the manual. With **v0.6**, this manual has also been
|
||||
converted to markdown in full. :::
|
||||
|
||||
The HTML version of this manual containing both the module option descriptions
|
||||
and the documentation of **nvf** (such as this page) can be generated and
|
||||
opened by typing the following in a shell within a clone of the **nvf** Git
|
||||
repository:
|
||||
and the documentation of **nvf** (such as this page) can be generated and opened
|
||||
by typing the following in a shell within a clone of the **nvf** Git repository:
|
||||
|
||||
```console
|
||||
$ nix build .#docs-html
|
||||
|
|
@ -35,28 +34,28 @@ $ xdg-open $PWD/result/share/doc/nvf/index.html
|
|||
|
||||
## Formatting Code {#sec-guidelines-formatting}
|
||||
|
||||
Make sure your code is formatted as described in [code-style
|
||||
section](#sec-guidelines-code-style). To maintain consistency throughout the
|
||||
project you are encouraged to browse through existing code and adopt its style
|
||||
also in new code.
|
||||
Make sure your code is formatted as described in
|
||||
[code-style section](#sec-guidelines-code-style). To maintain consistency
|
||||
throughout the project you are encouraged to browse through existing code and
|
||||
adopt its style also in new code.
|
||||
|
||||
## Formatting Commits {#sec-guidelines-commit-message-style}
|
||||
|
||||
Similar to [code style guidelines](#sec-guidelines-code-style) we encourage a
|
||||
consistent commit message format as described in [commit style
|
||||
guidelines](#sec-guidelines-commit-style).
|
||||
consistent commit message format as described in
|
||||
[commit style guidelines](#sec-guidelines-commit-style).
|
||||
|
||||
## Commit Style {#sec-guidelines-commit-style}
|
||||
|
||||
The commits in your pull request should be reasonably self-contained. Which
|
||||
means each and every commit in a pull request should make sense both on its
|
||||
own and in general context. That is, a second commit should not resolve an
|
||||
issue that is introduced in an earlier commit. In particular, you will be
|
||||
asked to amend any commit that introduces syntax errors or similar problems
|
||||
even if they are fixed in a later commit.
|
||||
means each and every commit in a pull request should make sense both on its own
|
||||
and in general context. That is, a second commit should not resolve an issue
|
||||
that is introduced in an earlier commit. In particular, you will be asked to
|
||||
amend any commit that introduces syntax errors or similar problems even if they
|
||||
are fixed in a later commit.
|
||||
|
||||
The commit messages should follow the [seven
|
||||
rules](https://chris.beams.io/posts/git-commit/#seven-rule), except for
|
||||
The commit messages should follow the
|
||||
[seven rules](https://chris.beams.io/posts/git-commit/#seven-rule), except for
|
||||
"Capitalize the subject line". We also ask you to include the affected code
|
||||
component or module in the first line. A commit message ideally, but not
|
||||
necessarily, follow the given template from home-manager's own documentation
|
||||
|
|
@ -69,15 +68,16 @@ necessarily, follow the given template from home-manager's own documentation
|
|||
|
||||
where `{component}` refers to the code component (or module) your change
|
||||
affects, `{description}` is a very brief description of your change, and
|
||||
`{long description}` is an optional clarifying description. As a rare
|
||||
exception, if there is no clear component, or your change affects many
|
||||
components, then the `{component}` part is optional. See [example commit
|
||||
message](#sec-guidelines-ex-commit-message) for a commit message that
|
||||
fulfills these requirements.
|
||||
`{long description}` is an optional clarifying description. As a rare exception,
|
||||
if there is no clear component, or your change affects many components, then the
|
||||
`{component}` part is optional. See
|
||||
[example commit message](#sec-guidelines-ex-commit-message) for a commit message
|
||||
that fulfills these requirements.
|
||||
|
||||
## Example Commit {#sec-guidelines-ex-commit-message}
|
||||
|
||||
The commit [69f8e47e9e74c8d3d060ca22e18246b7f7d988ef](https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef)
|
||||
The commit
|
||||
[69f8e47e9e74c8d3d060ca22e18246b7f7d988ef](https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef)
|
||||
in home-manager contains the following commit message.
|
||||
|
||||
```
|
||||
|
|
@ -93,10 +93,10 @@ the commit followed by the description:
|
|||
```
|
||||
languages/ruby: init module
|
||||
|
||||
Adds a language module for Ruby, adds appropriate formatters and Treesitter grammers
|
||||
Adds a language module for Ruby, adds appropriate formatters and Treesitter grammars
|
||||
```
|
||||
|
||||
Long description can be ommitted if the change is too simple to warrant it. A
|
||||
Long description can be omitted if the change is too simple to warrant it. A
|
||||
minor fix in spelling or a formatting change does not warrant long description,
|
||||
however, a module addition or removal does as you would like to provide the
|
||||
relevant context, i.e. the reasoning behind it, for your commit.
|
||||
|
|
@ -112,21 +112,22 @@ to contain the parent as well - for example `languages/java: some major change`.
|
|||
|
||||
### Treewide {#sec-code-style-treewide}
|
||||
|
||||
Keep lines at a reasonable width, ideally 80 characters or less. This also applies
|
||||
to string literals and module descriptions and documentation.
|
||||
Keep lines at a reasonable width, ideally 80 characters or less. This also
|
||||
applies to string literals and module descriptions and documentation.
|
||||
|
||||
### Nix {#sec-code-style-nix}
|
||||
|
||||
**nvf** is formatted by the [alejandra](https://github.com/kamadorueda/alejandra)
|
||||
tool and the formatting is checked in the pull request and push workflows. Run the
|
||||
`nix fmt` command inside the project repository before submitting your pull request.
|
||||
**nvf** is formatted by the
|
||||
[alejandra](https://github.com/kamadorueda/alejandra) tool and the formatting is
|
||||
checked in the pull request and push workflows. Run the `nix fmt` command inside
|
||||
the project repository before submitting your pull request.
|
||||
|
||||
While Alejandra is mostly opinionated on how code looks after formatting,
|
||||
certain changes are done at the user's discretion based on how the original
|
||||
code was structured.
|
||||
certain changes are done at the user's discretion based on how the original code
|
||||
was structured.
|
||||
|
||||
Please use one line code for attribute sets that contain only one subset.
|
||||
For example:
|
||||
Please use one line code for attribute sets that contain only one subset. For
|
||||
example:
|
||||
|
||||
```nix
|
||||
# parent modules should always be unfolded
|
||||
|
|
@ -158,8 +159,8 @@ module = {
|
|||
```
|
||||
|
||||
For lists, it is mostly up to your own discretion how you want to format them,
|
||||
but please try to unfold lists if they contain multiple items and especially
|
||||
if they are to include comments.
|
||||
but please try to unfold lists if they contain multiple items and especially if
|
||||
they are to include comments.
|
||||
|
||||
```nix
|
||||
# this is ok
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
# Keybinds {#sec-keybinds}
|
||||
|
||||
As of 0.4, there exists an API for writing your own keybinds and a couple of
|
||||
useful utility functions are available in the [extended standard
|
||||
library](https://github.com/NotAShelf/nvf/tree/main/lib). The following
|
||||
section contains a general overview to how you may utilize said functions.
|
||||
useful utility functions are available in the
|
||||
[extended standard library](https://github.com/NotAShelf/nvf/tree/main/lib). The
|
||||
following section contains a general overview to how you may utilize said
|
||||
functions.
|
||||
|
||||
## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings}
|
||||
|
||||
|
|
@ -26,18 +27,18 @@ An example, simple keybinding, can look like this:
|
|||
```
|
||||
|
||||
There are many settings available in the options. Please refer to the
|
||||
[documentation](https://notashelf.github.io/nvf/options.html#opt-vim.keymaps)
|
||||
to see a list of them.
|
||||
[documentation](https://notashelf.github.io/nvf/options.html#opt-vim.keymaps) to
|
||||
see a list of them.
|
||||
|
||||
**nvf** provides a list of helper commands, so that you don't have to write the
|
||||
mapping attribute sets every time:
|
||||
|
||||
- `mkBinding = key: action: desc:` - makes a basic binding, with `silent` set
|
||||
to true.
|
||||
- `mkBinding = key: action: desc:` - makes a basic binding, with `silent` set to
|
||||
true.
|
||||
- `mkExprBinding = key: action: desc:` - makes an expression binding, with
|
||||
`lua`, `silent`, and `expr` set to true.
|
||||
- `mkLuaBinding = key: action: desc:` - makes an expression binding, with
|
||||
`lua`, and `silent` set to true.
|
||||
- `mkLuaBinding = key: action: desc:` - makes an expression binding, with `lua`,
|
||||
and `silent` set to true.
|
||||
|
||||
Do note that the Lua in these bindings is actual Lua, and not pasted into a
|
||||
`:lua` command. Therefore, you should either pass in a function like
|
||||
|
|
@ -57,7 +58,8 @@ attribute sets:
|
|||
- `{ someKey = "some_value" }`
|
||||
- `{ someKey = { description = "Some Description"; }; }`
|
||||
|
||||
and merges them into `{ someKey = { value = "some_value"; description = "Some Description"; }; }`
|
||||
and merges them into
|
||||
`{ someKey = { value = "some_value"; description = "Some Description"; }; }`
|
||||
|
||||
```nix
|
||||
addDescriptionsToMappings = actualMappings: mappingDefinitions:
|
||||
|
|
@ -67,8 +69,8 @@ This function can be used in combination with the same `mkBinding` functions as
|
|||
above, except they only take two arguments - `binding` and `action`, and have
|
||||
different names:
|
||||
|
||||
- `mkSetBinding = binding: action:` - makes a basic binding, with `silent`
|
||||
set to true.
|
||||
- `mkSetBinding = binding: action:` - makes a basic binding, with `silent` set
|
||||
to true.
|
||||
- `mkSetExprBinding = binding: action:` - makes an expression binding, with
|
||||
`lua`, `silent`, and `expr` set to true.
|
||||
- `mkSetLuaBinding = binding: action:` - makes an expression binding, with
|
||||
|
|
@ -79,7 +81,10 @@ usage should look something like this:
|
|||
|
||||
```nix
|
||||
# plugindefinition.nix
|
||||
{lib, ...}: with lib; {
|
||||
{lib, ...}: let
|
||||
inherit (lib.options) mkEnableOption;
|
||||
inherit (lib.nvim.binds) mkMappingOption;
|
||||
in {
|
||||
options.vim.plugin = {
|
||||
enable = mkEnableOption "Enable plugin";
|
||||
|
||||
|
|
@ -109,9 +114,10 @@ usage should look something like this:
|
|||
pkgs,
|
||||
lib,
|
||||
...
|
||||
}:
|
||||
with lib;
|
||||
with builtins; let
|
||||
}: let
|
||||
inherit (lib.modules) mkIf mkMerge;
|
||||
inherit (lib.nvim.binds) mkSetBinding;
|
||||
|
||||
cfg = config.vim.plugin;
|
||||
self = import ./plugindefinition.nix {inherit lib;};
|
||||
mappingDefinitions = self.options.vim.plugin;
|
||||
|
|
@ -157,11 +163,12 @@ in {
|
|||
# ...
|
||||
};
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
::: {.note}
|
||||
|
||||
If you have come across a plugin that has an API that doesn't seem to easily
|
||||
allow custom keybindings, don't be scared to implement a draft PR. We'll help
|
||||
you get it done.
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
# Testing Changes {#sec-testing-changes}
|
||||
|
||||
Once you have made your changes, you will need to test them throughly. If it is
|
||||
Once you have made your changes, you will need to test them thoroughly. If it is
|
||||
a module, add your module option to `configuration.nix` (located in the root of
|
||||
this project) inside `neovimConfiguration`. Enable it, and then run the maximal
|
||||
configuration with `nix run .#maximal -Lv` to check for build errors. If neovim
|
||||
opens in the current directory without any error messages (you can check the
|
||||
output of `:messages` inside neovim to see if there are any errors), then your
|
||||
changes are good to go. Open your pull request, and it will be reviewed as soon
|
||||
as posssible.
|
||||
as possible.
|
||||
|
||||
If it is not a new module, but a change to an existing one, then make sure the
|
||||
module you have changed is enabled in the maximal configuration by editing
|
||||
`configuration.nix`, and then run it with `nix run .#maximal -Lv`. Same procedure
|
||||
as adding a new module will apply here.
|
||||
`configuration.nix`, and then run it with `nix run .#maximal -Lv`. Same
|
||||
procedure as adding a new module will apply here.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,12 @@
|
|||
# Installing nvf {#ch-installation}
|
||||
|
||||
[module installation section]: #ch-module-installation
|
||||
|
||||
There are multiple ways of installing nvf on your system. You may either choose
|
||||
the standalone installation method, which does not depend on a module system and may
|
||||
be done on any system that has the Nix package manager or the appropriate modules
|
||||
for NixOS and home-manager as described in the [module installation section](#ch-module-installation)
|
||||
the standalone installation method, which does not depend on a module system and
|
||||
may be done on any system that has the Nix package manager or the appropriate
|
||||
modules for NixOS and home-manager as described in the
|
||||
[module installation section].
|
||||
|
||||
```{=include=} chapters
|
||||
installation/custom-configuration.md
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Standalone Installation {#ch-standalone-installation}
|
||||
|
||||
It is possible to install **nvf** without depending on NixOS or home-manager as the parent
|
||||
module system, using the `neovimConfiguration` function exposed by **nvf** extended library.
|
||||
It takes in the configuration as a module, and returns an attribute set as a result.
|
||||
It is possible to install nvf without depending on NixOS or Home-Manager as the
|
||||
parent module system, using the `neovimConfiguration` function exposed in the
|
||||
extended library. This function will take `modules` and `extraSpecialArgs` as
|
||||
arguments, and return the following schema as a result.
|
||||
|
||||
```nix
|
||||
{
|
||||
|
|
@ -13,6 +14,55 @@ It takes in the configuration as a module, and returns an attribute set as a res
|
|||
}
|
||||
```
|
||||
|
||||
An example flake that exposes your custom Neovim configuration might look like
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
nvf.url = "github:notashelf/nvf";
|
||||
};
|
||||
|
||||
outputs = {
|
||||
self,
|
||||
nixpkgs,
|
||||
...
|
||||
} @ inputs: {
|
||||
packages."x86_64-linux" = let
|
||||
neovimConfigured = (inputs.nvf.lib.neovimConfiguration {
|
||||
inherit (nixpkgs.legacyPackages."x86_64-linux") pkgs;
|
||||
modules = [{
|
||||
config.vim = {
|
||||
# Enable custom theming options
|
||||
theme.enable = true;
|
||||
|
||||
# Enable Treesitter
|
||||
tree-sitter.enable = true;
|
||||
|
||||
# Other options will go here. Refer to the config
|
||||
# reference in Appendix B of the nvf manual.
|
||||
# ...
|
||||
};
|
||||
}];
|
||||
});
|
||||
in {
|
||||
# Set the default package to the wrapped instance of Neovim.
|
||||
# This will allow running your Neovim configuration with
|
||||
# `nix run` and in addition, sharing your configuration with
|
||||
# other users in case your repository is public.
|
||||
default = neovimConfigured.neovim;
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
<!-- TODO: mention the built-in flake template here when it is added -->
|
||||
|
||||
The above setup will allow to set up nvf as a standalone flake, which you can
|
||||
build independently from your system configuration while also possibly sharing
|
||||
it with others. The next two chapters will detail specific usage of such a setup
|
||||
for a package output in the context of NixOS or Home-Manager installation.
|
||||
|
||||
```{=include=} chapters
|
||||
standalone/nixos.md
|
||||
standalone/home-manager.md
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
# Module Installation {#ch-module-installation}
|
||||
|
||||
The below chapters will describe installing nvf as NixOS and Home-Manager
|
||||
modules. Note that those methods are mutually exclusive, and will likely cause
|
||||
path collisions if used simultaneously.
|
||||
|
||||
```{=include=} chapters
|
||||
modules/nixos.md
|
||||
modules/home-manager.md
|
||||
|
|
|
|||
|
|
@ -77,7 +77,9 @@ configure **nvf**.
|
|||
```
|
||||
|
||||
::: {.note}
|
||||
|
||||
**nvf** exposes a lot of options, most of which are not referenced in the
|
||||
installation sections of the manual. You may find all avaliable options
|
||||
in the [appendix](https://notashelf.github.io/nvf/options)
|
||||
installation sections of the manual. You may find all available options in the
|
||||
[appendix](https://notashelf.github.io/nvf/options)
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -76,7 +76,9 @@ configure **nvf**.
|
|||
```
|
||||
|
||||
::: {.note}
|
||||
|
||||
**nvf** exposes a lot of options, most of which are not referenced in the
|
||||
installation sections of the manual. You may find all avaliable options
|
||||
in the [appendix](https://notashelf.github.io/nvf/options)
|
||||
installation sections of the manual. You may find all available options in the
|
||||
[appendix](https://notashelf.github.io/nvf/options)
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Standalone Installation on Home-Manager {#ch-standalone-hm}
|
||||
|
||||
Your built Neoevim configuration can be exposed as a flake output to make it
|
||||
Your built Neovim configuration can be exposed as a flake output to make it
|
||||
easier to share across machines, repositories and so on. Or it can be added to
|
||||
your system packages to make it available across your system.
|
||||
|
||||
The following is an example installation of `nvf` as a standalone package with
|
||||
the default theme enabled. You may use other options inside `config.vim` in
|
||||
`configModule`, but this example will not cover that.
|
||||
`configModule`, but this example will not cover that extensively.
|
||||
|
||||
```nix
|
||||
{
|
||||
|
|
@ -30,23 +30,22 @@ the default theme enabled. You may use other options inside `config.vim` in
|
|||
};
|
||||
|
||||
customNeovim = nvf.lib.neovimConfiguration {
|
||||
modules = [configModule];
|
||||
inherit pkgs;
|
||||
modules = [configModule];
|
||||
};
|
||||
in {
|
||||
# this will make the package available as a flake input
|
||||
# This will make the package available as a flake output under 'packages'
|
||||
packages.${system}.my-neovim = customNeovim.neovim;
|
||||
|
||||
# this is an example home-manager configuration
|
||||
# using the built neovim package
|
||||
# Example Home-Manager configuration using the configured Neovim package
|
||||
homeConfigurations = {
|
||||
"your-username@your-hostname" = home-manager.lib.homeManagerConfiguration {
|
||||
# ...
|
||||
modules = [
|
||||
./home.nix
|
||||
|
||||
# this will make wrapped neovim available in your system packages
|
||||
{environment.systemPackages = [customNeovim.neovim];}
|
||||
# This will make Neovim available to users using the Home-Manager
|
||||
# configuration. To make the package available to all users, prefer
|
||||
# environment.systemPackages in your NixOS configuration.
|
||||
{home.packages = [customNeovim.neovim];}
|
||||
];
|
||||
# ...
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Standalone Installation on NixOS {#ch-standalone-nixos}
|
||||
|
||||
Your built Neoevim configuration can be exposed as a flake output to make it
|
||||
Your built Neovim configuration can be exposed as a flake output to make it
|
||||
easier to share across machines, repositories and so on. Or it can be added to
|
||||
your system packages to make it available across your system.
|
||||
|
||||
The following is an example installation of `nvf` as a standalone package with
|
||||
the default theme enabled. You may use other options inside `config.vim` in
|
||||
`configModule`, but this example will not cover that.
|
||||
`configModule`, but this example will not cover that extensively.
|
||||
|
||||
```nix
|
||||
{
|
||||
|
|
@ -30,21 +30,19 @@ the default theme enabled. You may use other options inside `config.vim` in
|
|||
};
|
||||
|
||||
customNeovim = nvf.lib.neovimConfiguration {
|
||||
modules = [configModule];
|
||||
inherit pkgs;
|
||||
modules = [configModule];
|
||||
};
|
||||
in {
|
||||
# this will make the package available as a flake input
|
||||
# This will make the package available as a flake output under 'packages'
|
||||
packages.${system}.my-neovim = customNeovim.neovim;
|
||||
|
||||
# this is an example nixosConfiguration using the built neovim package
|
||||
# Example nixosConfiguration using the configured Neovim package
|
||||
nixosConfigurations = {
|
||||
yourHostName = nixpkgs.lib.nixosSystem {
|
||||
# ...
|
||||
modules = [
|
||||
./configuration.nix # or whatever your configuration is
|
||||
|
||||
# this will make wrapped neovim available in your system packages
|
||||
# This will make wrapped neovim available in your system packages
|
||||
{environment.systemPackages = [customNeovim.neovim];}
|
||||
];
|
||||
# ...
|
||||
|
|
|
|||
|
|
@ -17,8 +17,8 @@ configuring.md
|
|||
hacking.md
|
||||
```
|
||||
|
||||
```{=include=} appendix html:into-file=//plugins.html
|
||||
plugins.md
|
||||
```{=include=} appendix html:into-file=//quirks.html
|
||||
quirks.md
|
||||
```
|
||||
|
||||
```{=include=} appendix html:into-file=//options.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,14 @@
|
|||
# Neovim Flake Configuration Options {#ch-options}
|
||||
|
||||
Below are the options provided by nvf provided in no particular order.
|
||||
They may include useful comments and warnings, or examples on how a module option
|
||||
is meant to be used.
|
||||
Below are the module options provided by nvf, in no particular order. Most
|
||||
options will include useful comments, warnings or setup tips on how a module
|
||||
option is meant to be used as well as examples in complex cases.
|
||||
|
||||
<!--
|
||||
In the manual, individual options may be referenced in Hyperlinks as follows:
|
||||
[](#opt-vim.*) If changing the prefix here, do keep in mind the #opt- suffix will have
|
||||
to be changed everywhere.
|
||||
-->
|
||||
|
||||
```{=include=} options
|
||||
id-prefix: opt-
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
# Plugin specific quirks {#ch-plugins}
|
||||
|
||||
At times, certain plugins refuse to play nicely. Be it as a result of generating
|
||||
lua from Nix, or the state of packaging. This page shall list any plugins that
|
||||
are known to misbehave, and potential workarounds.
|
||||
|
||||
```{=include=} chapters
|
||||
plugins/nodejs.md
|
||||
```
|
||||
<!--
|
||||
If adding a new section, uncomment this part and add your page to
|
||||
plugins/<page>.md
|
||||
```{=include=} chapters
|
||||
plugins/page.md
|
||||
```
|
||||
-->
|
||||
|
|
@ -1,7 +1,20 @@
|
|||
# Preface {#ch-preface}
|
||||
|
||||
If you noticed a bug caused by **nvf** then please consider reporting it over
|
||||
[the issue tracker](https://github.com/notashelf/nvf/issues).
|
||||
## What is nvf {#sec-what-is-it}
|
||||
|
||||
Bugfixes, feature additions and upstreamed changes from your local configurations
|
||||
are always welcome in the [the pull requests tab](https://github.com/notashelf/nvf/pulls).
|
||||
nvf is a highly modular, configurable, extensible and easy to use Neovim
|
||||
configuration in Nix. Designed for flexibility and ease of use, nvf allows you
|
||||
to easily configure your fully featured Neovim instance with a few lines of Nix.
|
||||
|
||||
## Bugs & Suggestions {#sec-bugs-suggestions}
|
||||
|
||||
[issue tracker]: https://github.com/notashelf/nvf/issues
|
||||
[discussions tab]: https://github.com/notashelf/nvf/discussions
|
||||
[pull requests tab]: https://github.com/notashelf/nvf/pulls
|
||||
|
||||
If you notice any issues with nvf, or this documentation, then please consider
|
||||
reporting them over at the [issue tracker]. Issues tab, in addition to the
|
||||
[discussions tab] is a good place as any to request new features.
|
||||
|
||||
You may also consider submitting bugfixes, feature additions and upstreamed
|
||||
changes that you think are critical over at the [pull requests tab].
|
||||
|
|
|
|||
13
docs/manual/quirks.md
Normal file
13
docs/manual/quirks.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Known Issues and Quirks {#ch-known-issues-quirks}
|
||||
|
||||
At times, certain plugins and modules may refuse to play nicely with your setup,
|
||||
be it a result of generating Lua from Nix, or the state of packaging. This page,
|
||||
in turn, will list any known modules or plugins that are known to misbehave, and
|
||||
possible workarounds that you may apply.
|
||||
|
||||
<!-- If adding a new known quirk, please create a new page in quirks/ and include
|
||||
the name of the file here.-->
|
||||
|
||||
```{=include=} chapters
|
||||
quirks/nodejs.md
|
||||
```
|
||||
|
|
@ -1,16 +1,22 @@
|
|||
# NodeJS {#ch-plugins-nodejs}
|
||||
# NodeJS {#ch-quirks-nodejs}
|
||||
|
||||
## eslint-plugin-prettier {#sec-eslint-plugin-prettier}
|
||||
|
||||
When working with NodeJS, everything works as expected, but some projects have settings that can fool nvf.
|
||||
When working with NodeJS, everything works as expected, but some projects have
|
||||
settings that can fool nvf.
|
||||
|
||||
If [this plugin](https://github.com/prettier/eslint-plugin-prettier) or similar is included, you might get a situation where your eslint configuration diagnoses your formatting according to its own config (usually `.eslintrc.js`).
|
||||
If [this plugin](https://github.com/prettier/eslint-plugin-prettier) or similar
|
||||
is included, you might get a situation where your eslint configuration diagnoses
|
||||
your formatting according to its own config (usually `.eslintrc.js`).
|
||||
|
||||
The issue there is your formatting is made via prettierd.
|
||||
|
||||
This results in auto-formating relying on your prettier config, while your eslint config diagnoses formatting [which it's not supposed to](https://prettier.io/docs/en/comparison.html))
|
||||
This results in auto-formatting relying on your prettier config, while your
|
||||
eslint config diagnoses formatting
|
||||
[which it's not supposed to](https://prettier.io/docs/en/comparison.html))
|
||||
|
||||
In the end, you get discrepancies between what your editor does and what it wants.
|
||||
In the end, you get discrepancies between what your editor does and what it
|
||||
wants.
|
||||
|
||||
Solutions are:
|
||||
|
||||
|
|
@ -1,25 +1,27 @@
|
|||
# Try it out {#ch-try-it-out}
|
||||
|
||||
Thanks to the portability of Nix, you can try out nvf without actually installing it to your machine.
|
||||
Below are the commands you may run to try out different configurations provided by this flake. As of v0.5, three
|
||||
Thanks to the portability of Nix, you can try out nvf without actually
|
||||
installing it to your machine. Below are the commands you may run to try out
|
||||
different configurations provided by this flake. As of v0.5, two specialized
|
||||
configurations are provided:
|
||||
|
||||
- Nix
|
||||
- Maximal
|
||||
- **Nix** - Nix language server + simple utility plugins
|
||||
- **Maximal** - Variable language servers + utility and decorative plugins
|
||||
|
||||
You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed.
|
||||
You may try out any of the provided configurations using the `nix run` command
|
||||
on a system where Nix is installed.
|
||||
|
||||
```console
|
||||
```bash
|
||||
$ cachix use nvf # Optional: it'll save you CPU resources and time
|
||||
$ nix run github:notashelf/nvf#nix # will run the default minimal configuration
|
||||
```
|
||||
|
||||
Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store
|
||||
once you garbage collect.
|
||||
Do keep in mind that this is **susceptible to garbage collection** meaning it
|
||||
will be removed from your Nix store once you garbage collect.
|
||||
|
||||
## Using Prebuilt Configs {#sec-using-prebuild-configs}
|
||||
## Using Prebuilt Configs {#sec-using-prebuilt-configs}
|
||||
|
||||
```console
|
||||
```bash
|
||||
$ nix run github:notashelf/nvf#nix
|
||||
$ nix run github:notashelf/nvf#maximal
|
||||
```
|
||||
|
|
@ -28,12 +30,19 @@ $ nix run github:notashelf/nvf#maximal
|
|||
|
||||
#### Nix {#sec-configs-nix}
|
||||
|
||||
`Nix` configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
|
||||
By running `nix run .#`, which is the default package, you will build Neovim with this config.
|
||||
`Nix` configuration by default provides LSP/diagnostic support for Nix alongside
|
||||
a set of visual and functional plugins. By running `nix run .#`, which is the
|
||||
default package, you will build Neovim with this config.
|
||||
|
||||
#### Maximal {#sec-configs-maximal}
|
||||
|
||||
`Maximal` is the ultimate configuration that will enable support for more commonly used language as well as additional
|
||||
complementary plugins. Keep in mind, however, that this will pull a lot of dependencies.
|
||||
`Maximal` is the ultimate configuration that will enable support for more
|
||||
commonly used language as well as additional complementary plugins. Keep in
|
||||
mind, however, that this will pull a lot of dependencies.
|
||||
|
||||
You are _strongly_ recommended to use the binary cache if you would like to try the Maximal configuration.
|
||||
::: {.tip}
|
||||
|
||||
You are _strongly_ recommended to use the binary cache if you would like to try
|
||||
the Maximal configuration.
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Release Notes {#ch-release-notes}
|
||||
|
||||
This section lists the release notes for tagged version of **nvf** and
|
||||
the current main current main branch
|
||||
This section lists the release notes for tagged version of **nvf** and the
|
||||
current main current main branch
|
||||
|
||||
```{=include=} chapters
|
||||
rl-0.1.md
|
||||
|
|
|
|||
|
|
@ -1,34 +1,42 @@
|
|||
# Release 0.1 {#sec-release-0.1}
|
||||
|
||||
This is the current master branch and information here is not final. These are changes from the v0.01 tag.
|
||||
This is the current master branch and information here is not final. These are
|
||||
changes from the v0.1 tag.
|
||||
|
||||
Special thanks to [home-manager](https://github.com/nix-community/home-manager/) for this release.
|
||||
Docs/manual generation, the new module evaluation system, and DAG implementation are from them.
|
||||
Special thanks to [home-manager](https://github.com/nix-community/home-manager/)
|
||||
for this release. Docs/manual generation, the new module evaluation system, and
|
||||
DAG implementation are from them.
|
||||
|
||||
## Changelog {#sec-release-0.1-changelog}
|
||||
|
||||
[jordanisaacs](https://github.com/jordanisaacs):
|
||||
|
||||
- Removed hare language support (lsp/tree-sitter/etc). `vim.lsp.hare` is no longer defined.
|
||||
If you use hare and would like it added back, please file an issue.
|
||||
- Removed hare language support (lsp/tree-sitter/etc). `vim.lsp.hare` is no
|
||||
longer defined. If you use hare and would like it added back, please file an
|
||||
issue.
|
||||
|
||||
- [vim.stratPlugins](opt-vim.startPlugins) & [vim.optPlugins](opt-vim.optPlugins) are now
|
||||
an enum of `string` for options sourced from the flake inputs. Users can still provide vim
|
||||
plugin packages.
|
||||
- [](#opt-vim.startPlugins) & [](#opt-vim.optPlugins) are now an enum of
|
||||
`string` for options sourced from the flake inputs. Users can still provide
|
||||
vim plugin packages.
|
||||
|
||||
- If you are contributing and adding a new plugin, add the plugin name to `availablePlugins` in
|
||||
[types-plugin.nix](https://github.com/jordanisaacs/neovim-flake/blob/20cec032bd74bc3d20ac17ce36cd84786a04fd3e/modules/lib/types-plugin.nix).
|
||||
- If you are contributing and adding a new plugin, add the plugin name to
|
||||
`availablePlugins` in [types-plugin.nix].
|
||||
|
||||
- `neovimBuilder` has been removed for configuration. Using an overlay is no longer required.
|
||||
See the manual for the new way to configuration.
|
||||
- `neovimBuilder` has been removed for configuration. Using an overlay is no
|
||||
longer required. See the manual for the new way to configuration.
|
||||
|
||||
- Treesitter grammars are now configurable with [vim.treesitter.grammars](opt-vim.treesitter.grammars).
|
||||
Utilizes the nixpkgs `nvim-treesitter` plugin rather than a custom input in order to take advantage of build support of pinned versions.
|
||||
See [relevant discourse post](https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees)
|
||||
for more information. Packages can be found under the `vimPlugins.nvim-treesitter.builtGrammars` namespace.
|
||||
[relevant discourse post]: https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees
|
||||
|
||||
- [vim.configRC](opt-vim.configRC) and [vim.luaConfigRC](opt-vim.luaConfigRC) are now of type DAG lines.
|
||||
This allows for ordering of the config. Usage is the same is in home-manager's `home.activation` option.
|
||||
- Treesitter grammars are now configurable with
|
||||
[](#opt-vim.treesitter.grammars). Utilizes the nixpkgs `nvim-treesitter`
|
||||
plugin rather than a custom input in order to take advantage of build support
|
||||
of pinned versions. See the [relevant discourse post] for more information.
|
||||
Packages can be found under the `vimPlugins.nvim-treesitter.builtGrammars`
|
||||
namespace.
|
||||
|
||||
- `vim.configRC` and [](#opt-vim.luaConfigRC) are now of type DAG lines. This
|
||||
allows for ordering of the config. Usage is the same is in home-manager's
|
||||
`home.activation` option.
|
||||
|
||||
```nix
|
||||
vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"
|
||||
|
|
@ -36,5 +44,5 @@ vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"
|
|||
|
||||
[MoritzBoehme](https://github.com/MoritzBoehme):
|
||||
|
||||
- `catppuccin` theme is now available as a neovim theme [vim.theme.style](opt-vim.theme.style) and lualine theme
|
||||
[vim.statusline.lualine.theme](opt-vim.statusline.lualine.theme).
|
||||
- `catppuccin` theme is now available as a neovim theme [](#opt-vim.theme.style)
|
||||
and Lualine theme [](#opt-vim.statusline.lualine.theme).
|
||||
|
|
|
|||
|
|
@ -6,48 +6,59 @@ Release notes for release 0.2
|
|||
|
||||
[notashelf](https://github.com/notashelf):
|
||||
|
||||
- Added two minimap plugins under `vim.minimap`. `codewindow.nvim` is enabled by default, while `minimap.vim` is
|
||||
available with its code-minimap dependency.
|
||||
- A complementary plugin, `obsidian.nvim` and the Neovim alternative for Emacs' orgmode with `orgmode.nvim` have been
|
||||
added. Both will be disabled by default.
|
||||
- Added two minimap plugins under `vim.minimap`. `codewindow.nvim` is enabled by
|
||||
default, while `minimap.vim` is available with its code-minimap dependency.
|
||||
- A complementary plugin, `obsidian.nvim` and the Neovim alternative for Emacs'
|
||||
orgmode with `orgmode.nvim` have been added. Both will be disabled by default.
|
||||
|
||||
- Smooth scrolling for ANY movement command is now available with `cinnamon.nvim`
|
||||
- Smooth scrolling for ANY movement command is now available with
|
||||
`cinnamon.nvim`
|
||||
|
||||
- You will now notice a dashboard on startup. This is provided by the `alpha.nvim` plugin. You can use any of the
|
||||
three available dashboard plugins, or disable them entirely.
|
||||
- You will now notice a dashboard on startup. This is provided by the
|
||||
`alpha.nvim` plugin. You can use any of the three available dashboard plugins,
|
||||
or disable them entirely.
|
||||
|
||||
- There is now a scrollbar on active buffers, which can highlight errors by hooking to your LSPs. This is on by
|
||||
default, but can be toggled off under `vim.visuals` if seen necessary.
|
||||
- There is now a scrollbar on active buffers, which can highlight errors by
|
||||
hooking to your LSPs. This is on by default, but can be toggled off under
|
||||
`vim.visuals` if seen necessary.
|
||||
|
||||
- Discord Rich Presence has been added through `presence.nvim` for those who want to flex that they are using
|
||||
the _superior_ text editor.
|
||||
- Discord Rich Presence has been added through `presence.nvim` for those who
|
||||
want to flex that they are using the _superior_ text editor.
|
||||
|
||||
- An icon picker is now available with telescope integration. You can use `:IconPickerInsert` or `:IconPickerYank`
|
||||
to add icons to your code.
|
||||
- An icon picker is now available with telescope integration. You can use
|
||||
`:IconPickerInsert` or `:IconPickerYank` to add icons to your code.
|
||||
|
||||
- A general-purpose cheatsheet has been added through `cheatsheet.nvim`. Forget no longer!
|
||||
- A general-purpose cheatsheet has been added through `cheatsheet.nvim`. Forget
|
||||
no longer!
|
||||
|
||||
- `ccc.nvim` has been added to the default plugins to allow picking colors with ease.
|
||||
- `ccc.nvim` has been added to the default plugins to allow picking colors with
|
||||
ease.
|
||||
|
||||
- Most UI components of Neovim have been replaced through the help of `noice.nvim`. There are also notifications
|
||||
and custom UI elements available for Neovim messages and prompts.
|
||||
- Most UI components of Neovim have been replaced through the help of
|
||||
`noice.nvim`. There are also notifications and custom UI elements available
|
||||
for Neovim messages and prompts.
|
||||
|
||||
- A (floating by default) terminal has been added through `toggleterm.nvim`.
|
||||
|
||||
- Harness the power of ethical (`tabnine.nvim`) and not-so-ethical (`copilot.lua`) AI by those new assistant plugins.
|
||||
Both are off by default, TabNine needs to be wrapped before it's working.
|
||||
- Harness the power of ethical (`tabnine.nvim`) and not-so-ethical
|
||||
(`copilot.lua`) AI by those new assistant plugins. Both are off by default,
|
||||
TabNine needs to be wrapped before it's working.
|
||||
|
||||
- Experimental mouse gestures have been added through `gesture.nvim`. See plugin page and the relevant module for
|
||||
more details on how to use.
|
||||
- Experimental mouse gestures have been added through `gesture.nvim`. See plugin
|
||||
page and the relevant module for more details on how to use.
|
||||
|
||||
- Re-open last visited buffers via `nvim-session-manager`. Disabled by default as deleting buffers seems to be
|
||||
problematic at the moment.
|
||||
- Re-open last visited buffers via `nvim-session-manager`. Disabled by default
|
||||
as deleting buffers seems to be problematic at the moment.
|
||||
|
||||
- Most of NvimTree's configuration options have been changed with some options being toggled to off by default.
|
||||
- Most of NvimTree's configuration options have been changed with some options
|
||||
being toggled to off by default.
|
||||
|
||||
- Lualine had its configuration simplified and style toned down. Less color, more info.
|
||||
- Lualine had its configuration simplified and style toned down. Less color,
|
||||
more info.
|
||||
|
||||
- Modules where multiple plugin configurations were in the same directory have been simplified. Each plugin inside
|
||||
a single module gets its directory to be imported.
|
||||
- Modules where multiple plugin configurations were in the same directory have
|
||||
been simplified. Each plugin inside a single module gets its directory to be
|
||||
imported.
|
||||
|
||||
- Separate config options with the same parent attribute have been merged into one for simplicity.
|
||||
- Separate config options with the same parent attribute have been merged into
|
||||
one for simplicity.
|
||||
|
|
|
|||
|
|
@ -1,67 +1,88 @@
|
|||
# Release 0.3 {#sec-release-0.3}
|
||||
|
||||
Release 0.3 had to come out beore I wanted it to due to Neovim 0.9 dropping into nixpkgs-unstable.
|
||||
The treesitter changes have prompted a treesitter rework, which was followed by reworking the languages system.
|
||||
Most of the changes to those are downstreamed from the original repository. The feature requests that was originally
|
||||
planned for 0.3 have been moved to 0.4, which should come out soon.
|
||||
Release 0.3 had to come out before I wanted it to due to Neovim 0.9 dropping
|
||||
into nixpkgs-unstable. The Treesitter changes have prompted a Treesitter rework,
|
||||
which was followed by reworking the languages system. Most of the changes to
|
||||
those are downstreamed from the original repository. The feature requests that
|
||||
was originally planned for 0.3 have been moved to 0.4, which should come out
|
||||
soon.
|
||||
|
||||
## Changelog {#sec-release-0.3-changelog}
|
||||
|
||||
- We have transitioned to flake-parts, from flake-utils to extend the flexibility of this flake. This means the flake structure
|
||||
is different than usual, but the functionality remains the same.
|
||||
- We have transitioned to flake-parts, from flake-utils to extend the
|
||||
flexibility of this flake. This means the flake structure is different than
|
||||
usual, but the functionality remains the same.
|
||||
|
||||
- We now provide a home-manager module. Do note that it is still far from perfect, but it works.
|
||||
- We now provide a home-manager module. Do note that it is still far from
|
||||
perfect, but it works.
|
||||
|
||||
- `nodejs_16` is now bundled with `Copilot.lua` if the user has enabled Copilot assistant.
|
||||
- `nodejs_16` is now bundled with `Copilot.lua` if the user has enabled Copilot
|
||||
assistant.
|
||||
|
||||
- which-key section titles have been fixed. This is to be changed once again in a possible keybind rewrite, but now it should
|
||||
display the correct titles instad of `+prefix`
|
||||
- which-key section titles have been fixed. This is to be changed once again in
|
||||
a possible keybind rewrite, but now it should display the correct titles
|
||||
instead of `+prefix`
|
||||
|
||||
- Most of `presence.nvim`'s options have been made fully configurable through your configuration file.
|
||||
- Most of `presence.nvim`'s options have been made fully configurable through
|
||||
your configuration file.
|
||||
|
||||
- Most of the modules have been refactored to separate `config` and `options` attributes.
|
||||
- Most of the modules have been refactored to separate `config` and `options`
|
||||
attributes.
|
||||
|
||||
- Darwin has been deprecated as the zig package is marked as broken. We will attempt to use the zig overlay to return Darwin
|
||||
support.
|
||||
- Darwin has been deprecated as the Zig package is marked as broken. We will
|
||||
attempt to use the Zig overlay to return Darwin support.
|
||||
|
||||
- `Fidget.nvim` has been added as a neat visual addition for LSP installations.
|
||||
|
||||
- `diffview.nvim` has been added to provide a convenient diff utility.
|
||||
|
||||
- Treesitter grammars are now configurable with [vim.treesitter.grammars](vim.treesitter.grammars).
|
||||
Utilizes the nixpkgs `nvim-treesitter` plugin rather than a custom input in order to take advantage of build support of pinned versions.
|
||||
See [discourse](https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees) for more information.
|
||||
Packages can be found under the `pkgs.vimPlugins.nvim-treesitter.builtGrammars` attribute. Treesitter grammars for supported languages should be
|
||||
enabled within the module. By default no grammars are installed, thus the following grammars which do not have a language section are not included anymore:
|
||||
**comment**, **toml**, **make**, **html**, **css**, **graphql**, **json**.
|
||||
[discourse]: https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees
|
||||
|
||||
- Treesitter grammars are now configurable with
|
||||
[](#opt-vim.treesitter.grammars). Utilizes the nixpkgs `nvim-treesitter`
|
||||
plugin rather than a custom input in order to take advantage of build support
|
||||
of pinned versions. See [discourse] for more information. Packages can be
|
||||
found under the `pkgs.vimPlugins.nvim-treesitter.builtGrammars` attribute.
|
||||
Treesitter grammars for supported languages should be enabled within the
|
||||
module. By default no grammars are installed, thus the following grammars
|
||||
which do not have a language section are not included anymore: **comment**,
|
||||
**toml**, **make**, **html**, **css**, **graphql**, **json**.
|
||||
|
||||
- A new section has been added for language support: `vim.languages.<language>`.
|
||||
|
||||
- The options [vim.languages.enableLSP](vim.languages.enableLSP), [vim.languages.enableTreesitter](vim.languages.enableTreesitter), etc.
|
||||
will enable the respective section for all languages that have been enabled.
|
||||
- The options [](#opt-vim.languages.enableLSP),
|
||||
[](#opt-vim.languages.enableTreesitter), etc. will enable the respective
|
||||
section for all languages that have been enabled.
|
||||
- All LSP languages have been moved here
|
||||
- `plantuml` and `markdown` have been moved here
|
||||
- A new section has been added for `html`. The old `vim.treesitter.autotagHtml` can be found at <<opt-vim.languages.html.treesitter.autotagHtml>>.
|
||||
- A new section has been added for `html`. The old
|
||||
`vim.treesitter.autotagHtml` can be found at
|
||||
[](#opt-vim.languages.html.treesitter.autotagHtml).
|
||||
|
||||
- [vim.git.gitsigns.codeActions](vim.git.gitsigns.codeActions) has been added allowing you to turn on gitsigns codeactions.
|
||||
- `vim.git.gitsigns.codeActions` has been added, allowing you to turn on
|
||||
Gitsigns' code actions.
|
||||
|
||||
- Removed the plugins document in the docs. Was too unwieldy to keep updated.
|
||||
|
||||
- `vim.visual.lspkind` has been moved to [vim.lsp.lspkind.enable](vim.lsp.lspkind.enable)
|
||||
- `vim.visual.lspkind` has been moved to [](#opt-vim.lsp.lspkind.enable)
|
||||
|
||||
- Improved handling of completion formatting. When setting [vim.autocomplete.sources](vim.autocomplete.sources), can also include optional menu mapping.
|
||||
And can provide your own function with [vim.autocomplete.formatting.format](vim.autocomplete.formatting.format).
|
||||
- Improved handling of completion formatting. When setting
|
||||
`vim.autocomplete.sources`, can also include optional menu mapping. And can
|
||||
provide your own function with `vim.autocomplete.formatting.format`.
|
||||
|
||||
- For [vim.visuals.indentBlankline.fillChar](vim.visuals.indentBlankline.fillChar) and [vim.visuals.indentBlankline.eolChar](vim.visuals.indentBlankline.eolChar)
|
||||
turning them off should use `null` rather than `""` now.
|
||||
- For `vim.visuals.indentBlankline.fillChar` and
|
||||
`vim.visuals.indentBlankline.eolChar` options, turning them off should be done
|
||||
by using `null` rather than `""` now.
|
||||
|
||||
- Transparency has been made optional and has been disabled by default. [vim.theme.transparent](vim.theme.transparent) option can be used to enable or
|
||||
disable transparency for your configuration.
|
||||
- Transparency has been made optional and has been disabled by default.
|
||||
[](#opt-vim.theme.transparent) option can be used to enable or disable
|
||||
transparency for your configuration.
|
||||
|
||||
- Fixed deprecated configuration method for Tokyonight, and added new style "moon"
|
||||
- Fixed deprecated configuration method for Tokyonight, and added new style
|
||||
"moon"
|
||||
|
||||
- Dart language support as well as extended flutter support has been added. Thanks to @FlafyDev for his contributions towards Dart
|
||||
language support.
|
||||
- Dart language support as well as extended flutter support has been added.
|
||||
Thanks to @FlafyDev for his contributions towards Dart language support.
|
||||
|
||||
- Elixir language support has been added through `elixir-tools.nvim`.
|
||||
|
||||
|
|
@ -69,13 +90,14 @@ planned for 0.3 have been moved to 0.4, which should come out soon.
|
|||
|
||||
- `modes.nvim` has been added to the UI plugins as a minor error highlighter.
|
||||
|
||||
- `smartcollumn.nvim` has been added to dynamically display a colorcolumn when the limit has been exceeded, providing
|
||||
per-buftype column position and more.
|
||||
- `smartcollumn.nvim` has been added to dynamically display a colorcolumn when
|
||||
the limit has been exceeded, providing per-buftype column position and more.
|
||||
|
||||
- `project.nvim` has been added for better project management inside Neovim.
|
||||
|
||||
- More configuration options have been added to `nvim-session-manager`.
|
||||
|
||||
- Editorconfig support has been added to the core functionality, with an enable option.
|
||||
- Editorconfig support has been added to the core functionality, with an enable
|
||||
option.
|
||||
|
||||
- `venn-nvim` has been dropped due to broken keybinds.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,16 @@
|
|||
# Release 0.4 {#sec-release-0.4}
|
||||
|
||||
Following the release of v0.3, I have decided to release v0.4 with a massive new change: customizable keybinds.
|
||||
As of the 0.4 release, keybinds will no longer be hardcoded and instead provided by each module's own keybinds section.
|
||||
The old keybind system (`vim.keybinds = {}`) is now considered deprecated and the new lib functions are recommended to be
|
||||
used for adding keybinds for new plugins, or adding keybinds to existing plugins.
|
||||
Following the release of v0.3, I have decided to release v0.4 with a massive new
|
||||
change: customizable keybinds. As of the 0.4 release, keybinds will no longer be
|
||||
hardcoded and instead provided by each module's own keybinds section. The old
|
||||
keybind system (`vim.keybinds = {}`) is now considered deprecated and the new
|
||||
lib functions are recommended to be used for adding keybinds for new plugins, or
|
||||
adding keybinds to existing plugins.
|
||||
|
||||
Alongside customizable keybinds, there are a few quality of life updates, such as `lazygit` integration and the
|
||||
new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who made this update possible during my absence.
|
||||
Alongside customizable keybinds, there are a few quality of life updates, such
|
||||
as `lazygit` integration and the new experimental Lua loader of Neovim 0.9
|
||||
thanks to our awesome contributors who made this update possible during my
|
||||
absence.
|
||||
|
||||
## Changelog {#sec-release-0.4-changelog}
|
||||
|
||||
|
|
@ -18,7 +22,8 @@ new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who
|
|||
|
||||
- Simplified luaConfigRC and configRC setting - they can now just take strings
|
||||
|
||||
- Refactored the resolveDag function - you can just provide a string now, which will default to dag.entryAnywhere
|
||||
- Refactored the resolveDag function - you can just provide a string now, which
|
||||
will default to dag.entryAnywhere
|
||||
|
||||
- Fixed formatting sometimes removing parts of files
|
||||
|
||||
|
|
@ -32,7 +37,8 @@ new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who
|
|||
|
||||
- Added `toggleterm` integration for `lazygit`.
|
||||
|
||||
- Added new option `enableluaLoader` to enable neovim's experimental module loader for faster startup time.
|
||||
- Added new option `enableluaLoader` to enable neovim's experimental module
|
||||
loader for faster startup time.
|
||||
|
||||
- Fixed bug where flutter-tools can't find `dart` LSP
|
||||
|
||||
|
|
@ -40,23 +46,28 @@ new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who
|
|||
|
||||
[notashelf](https://github.com/notashelf):
|
||||
|
||||
- Made Copilot's Node package configurable. It is recommended to keep as default, but providing a different NodeJS version is now possible.
|
||||
- Made Copilot's Node package configurable. It is recommended to keep as
|
||||
default, but providing a different NodeJS version is now possible.
|
||||
|
||||
- Added [vim.cursorlineOpt](vim.cursorlineOpt) for configuring Neovim's cursorlineOpt.
|
||||
- Added [](#opt-vim.cursorlineOpt) for configuring Neovim's cursorlineOpt.
|
||||
|
||||
- Added `filetree.nvimTreeLua.view.cursorline`, default false, to enable cursorline in nvimtre.
|
||||
- Added `filetree.nvimTreeLua.view.cursorline`, default false, to enable
|
||||
cursorline in nvimtre.
|
||||
|
||||
- Added Fidget.nvim support for the Catppuccin theme.
|
||||
|
||||
- Updated bundled NodeJS version used by `Copilot.lua`. v16 is now marked as insecure on Nixpkgs, and we updated to v18
|
||||
- Updated bundled NodeJS version used by `Copilot.lua`. v16 is now marked as
|
||||
insecure on Nixpkgs, and we updated to v18
|
||||
|
||||
- Enabled Catppuccin modules for plugins available by default.
|
||||
|
||||
- Added experimental Svelte support under `vim.languages`.
|
||||
|
||||
- Removed unnecessary scrollbar element from notifications and codeaction warning UI.
|
||||
- Removed unnecessary scrollbar element from notifications and codeaction
|
||||
warning UI.
|
||||
|
||||
- `vim.utility.colorizer` has been renamed to `vim.utility.ccc` after the plugin it uses
|
||||
- `vim.utility.colorizer` has been renamed to `vim.utility.ccc` after the plugin
|
||||
it uses
|
||||
|
||||
- Color preview via `nvim-colorizer.lua`
|
||||
|
||||
|
|
@ -66,7 +77,8 @@ new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who
|
|||
|
||||
- Added a module for enabling Neovim's spellchecker
|
||||
|
||||
- Added prettierd as an alternative formatter to prettier - currently defaults to prettier
|
||||
- Added prettierd as an alternative formatter to prettier - currently defaults
|
||||
to prettier
|
||||
|
||||
- Fixed presence.nvim inheriting the wrong client id
|
||||
|
||||
|
|
|
|||
|
|
@ -16,33 +16,35 @@ Release notes for release 0.5
|
|||
|
||||
- Fixed a bug where cmp's close and scrollDocs mappings wasn't working
|
||||
|
||||
- Streamlined and simplified extra plugin API with the addition of [vim.extraPlugins](vim.extraPlugins)
|
||||
- Streamlined and simplified extra plugin API with the addition of
|
||||
[](#opt-vim.extraPlugins)
|
||||
|
||||
- Allow using command names in place of LSP packages to avoid automatic installation
|
||||
- Allow using command names in place of LSP packages to avoid automatic
|
||||
installation
|
||||
|
||||
- Add lua LSP and treesitter support, and neodev.nvim plugin support
|
||||
- Add lua LSP and Treesitter support, and neodev.nvim plugin support
|
||||
|
||||
- Add [vim.lsp.mappings.toggleFormatOnSave](vim.lsp.mappings.toggleFormatOnSave) keybind
|
||||
- Add [](#opt-vim.lsp.mappings.toggleFormatOnSave) keybind
|
||||
|
||||
[amanse](https://github.com/amanse):
|
||||
|
||||
- Added daily notes options for obsidian plugin
|
||||
|
||||
- Added jdt-language-server for Java
|
||||
- Added `jdt-language-server` for Java
|
||||
|
||||
[yavko](https://github.com/yavko):
|
||||
|
||||
- Added Deno Language Server for javascript/typescript
|
||||
- Added Deno Language Server for Javascript/Typescript
|
||||
|
||||
- Added support for multiple languages [vim.spellChecking.languages](vim.spellChecking.languages), and added
|
||||
vim-dirtytalk through [vim.spellChecking.enableProgrammingWordList](vim.spellChecking.enableProgrammingWordList)
|
||||
- Added support for multiple languages under `vim.spellChecking.languages`, and
|
||||
added vim-dirtytalk through `vim.spellChecking.enableProgrammingWordList`
|
||||
|
||||
[frothymarrow](https://github.com/FrothyMarrow):
|
||||
|
||||
- Renamed `vim.visuals.cursorWordline` to [vim.visuals.cursorline.enable](vim.visuals.cursorline.enable)
|
||||
- Renamed `vim.visuals.cursorWordline` to `vim.visuals.cursorline.enable`
|
||||
|
||||
- Added [vim.visuals.cursorline.lineNumbersOnly](vim.visuals.cursorline.lineNumbersOnly) to display cursorline
|
||||
only in the presence of line numbers
|
||||
- Added `vim.visuals.cursorline.lineNumbersOnly` to display cursorline only in
|
||||
the presence of line numbers
|
||||
|
||||
- Added Oxocarbon to the list of available themes.
|
||||
|
||||
|
|
@ -50,38 +52,44 @@ Release notes for release 0.5
|
|||
|
||||
- Added GitHub Copilot to nvim-cmp completion sources.
|
||||
|
||||
- Added [vim.ui.borders.enable](vim.ui.borders.enable) for global and individual plugin border configuration.
|
||||
- Added [](#opt-vim.ui.borders.enable) for global and individual plugin border
|
||||
configuration.
|
||||
|
||||
- LSP integrated breadcrumbs with [vim.ui.breadcrumbs.enable](vim.ui.breadcrumbs.enable) through nvim-navic
|
||||
- LSP integrated breadcrumbs with [](#opt-vim.ui.breadcrumbs.enable) through
|
||||
nvim-navic
|
||||
|
||||
- LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically enabled if navic is enabled)
|
||||
- LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically
|
||||
enabled if navic is enabled)
|
||||
|
||||
- Addeed nvim-navic integration for catppuccin theme
|
||||
- Added nvim-navic integration for Catppuccin theme
|
||||
|
||||
- Fixed mismatching zig language description
|
||||
- Fixed mismatching Zig language description
|
||||
|
||||
- Added support for `statix` and `deadnix` through [vim.languages.nix.extraDiagnostics.types](vim.languages.nix.extraDiagnostics.types)
|
||||
- Added support for `statix` and `deadnix` through
|
||||
[](#opt-vim.languages.nix.extraDiagnostics.types)
|
||||
|
||||
- Added `lsp_lines` plugin for showing diagnostic messages
|
||||
|
||||
- Added a configuration option for choosing the leader key
|
||||
|
||||
- The package used for neovim is now customizable by the user, using [vim.package](vim.package).
|
||||
For best results, always use an unwrapped package
|
||||
- The package used for neovim is now customizable by the user, using
|
||||
[](#opt-vim.package). For best results, always use an unwrapped package
|
||||
|
||||
- Added highlight-undo plugin for highlighting undo/redo targets
|
||||
|
||||
- Added bash LSP and formatter support
|
||||
|
||||
- Disabled Lualine LSP status indicator for toggleterm buffer
|
||||
- Disabled Lualine LSP status indicator for Toggleterm buffer
|
||||
|
||||
- Added `nvim-docs-view`, a plugin to display lsp hover documentation in a side panel
|
||||
- Added `nvim-docs-view`, a plugin to display LSP hover documentation in a side
|
||||
panel
|
||||
|
||||
- Switched to `nixosOptionsDoc` in option documentation.
|
||||
To quote home-manager commit: "Output is mostly unchanged aside from some minor typographical and
|
||||
- Switched to `nixosOptionsDoc` in option documentation. To quote home-manager
|
||||
commit: "Output is mostly unchanged aside from some minor typographical and
|
||||
formatting changes, along with better source links."
|
||||
|
||||
- Updated indent-blankine.nvim to v3 - this comes with a few option changes, which will be migrated with `renamedOptionModule`
|
||||
- Updated indent-blankine.nvim to v3 - this comes with a few option changes,
|
||||
which will be migrated with `renamedOptionModule`
|
||||
|
||||
[jacekpoz](https://jacekpoz.pl):
|
||||
|
||||
|
|
@ -99,9 +107,11 @@ Release notes for release 0.5
|
|||
|
||||
- Removed redundant "Enable ..." in `mkEnableOption` descriptions
|
||||
|
||||
- Add options to modify LSP key bindings and add proper whichkey descriptions
|
||||
- Add options to modify LSP key bindings and add proper which-key descriptions
|
||||
|
||||
- Changed type of `statusline.lualine.activeSection` and `statusline.lualine.inactiveSection`
|
||||
from `attrsOf str` to `attrsOf (listOf str)`
|
||||
- Changed type of `statusline.lualine.activeSection` and
|
||||
`statusline.lualine.inactiveSection` from `attrsOf str` to
|
||||
`attrsOf (listOf str)`
|
||||
|
||||
- Added `statusline.lualine.extraActiveSection` and `statusline.lualine.extraInactiveSection`
|
||||
- Added `statusline.lualine.extraActiveSection` and
|
||||
`statusline.lualine.extraInactiveSection`
|
||||
|
|
|
|||
|
|
@ -4,17 +4,21 @@ Release notes for release 0.6
|
|||
|
||||
## Breaking Changes and Migration Guide {#sec-breaking-changes-and-migration-guide}
|
||||
|
||||
In v0.6 we are introducing `setupOpts`: many plugin related options are moved into their respective `setupOpts`
|
||||
submodule, e.g. `nvimTree.disableNetrw` is renamed to `nvimTree.setupOpts.disable_netrw`.
|
||||
In v0.6 we are introducing `setupOpts`: many plugin related options are moved
|
||||
into their respective `setupOpts` submodule, e.g. `nvimTree.disableNetrw` is
|
||||
renamed to `nvimTree.setupOpts.disable_netrw`.
|
||||
|
||||
_Why?_ in short, you can now pass in anything to setupOpts and it will be passed to your `require'plugin'.setup{...}`.
|
||||
No need to wait for us to support every single plugin option.
|
||||
_Why?_ in short, you can now pass in anything to setupOpts and it will be passed
|
||||
to your `require'plugin'.setup{...}`. No need to wait for us to support every
|
||||
single plugin option.
|
||||
|
||||
The warnings when you rebuild your config should be enough to guide you through what you need to do, if there's an
|
||||
option that was renamed but wasn't listed in the warning, please file a bug report!
|
||||
The warnings when you rebuild your config should be enough to guide you through
|
||||
what you need to do, if there's an option that was renamed but wasn't listed in
|
||||
the warning, please file a bug report!
|
||||
|
||||
To make your migration process less annoying, here's a keybind that will help you with renaming stuff from camelCase to
|
||||
snake_case (you'll be doing that a lot):
|
||||
To make your migration process less annoying, here's a keybind that will help
|
||||
you with renaming stuff from camelCase to snake_case (you'll be doing that a
|
||||
lot):
|
||||
|
||||
```lua
|
||||
-- paste this in a temp.lua file and load it in vim with :source /path/to/temp.lua
|
||||
|
|
@ -43,8 +47,9 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
|
|||
|
||||
- Added Terraform language support.
|
||||
|
||||
- Added `ChatGPT.nvim`, which can be enabled with [`vim.assistant.chatgpt`](vim.assistant.chatgpt). Do
|
||||
keep in mind that this option requires `OPENAI_API_KEY` environment variable to be set.
|
||||
- Added `ChatGPT.nvim`, which can be enabled with
|
||||
[](#opt-vim.assistant.chatgpt.enable). Do keep in mind that this option
|
||||
requires `OPENAI_API_KEY` environment variable to be set.
|
||||
|
||||
[donnerinoern](https://github.com/donnerinoern):
|
||||
|
||||
|
|
@ -52,11 +57,13 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
|
|||
|
||||
- Added marksman LSP for Markdown.
|
||||
|
||||
- Fixed markdown preview with Glow not working and added an option for changing the preview keybind.
|
||||
- Fixed markdown preview with Glow not working and added an option for changing
|
||||
the preview keybind.
|
||||
|
||||
- colorizer.nvim: switched to a maintained fork.
|
||||
|
||||
- Added `markdown-preview.nvim`, moved `glow.nvim` to a brand new `vim.utility.preview` category.
|
||||
- Added `markdown-preview.nvim`, moved `glow.nvim` to a brand new
|
||||
`vim.utility.preview` category.
|
||||
|
||||
[elijahimmer](https://github.com/elijahimmer)
|
||||
|
||||
|
|
@ -64,7 +71,8 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
|
|||
|
||||
[jacekpoz](https://jacekpoz.pl):
|
||||
|
||||
- Added `vim.autocomplete.alwaysComplete`. Allows users to have the autocomplete window popup only when manually activated.
|
||||
- Added `vim.autocomplete.alwaysComplete`. Allows users to have the autocomplete
|
||||
window popup only when manually activated.
|
||||
|
||||
[horriblename](https://github.com/horriblename):
|
||||
|
||||
|
|
@ -80,11 +88,14 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
|
|||
|
||||
- Added option `vim.luaPackages` to wrap neovim with extra Lua packages.
|
||||
|
||||
- Rewrote the entire `fidget.nvim` module to include extensive configuration options. Option `vim.fidget-nvim.align.bottom` has
|
||||
been removed in favor of [vim.fidget-nvim.notification.window.align](vim.fidget-nvim.notification.window.align), which now supports
|
||||
`top` and `bottom` values. `vim.fidget-nvim.align.right` has no longer any equivalent and also has been removed.
|
||||
- Rewrote the entire `fidget.nvim` module to include extensive configuration
|
||||
options. Option `vim.fidget-nvim.align.bottom` has been removed in favor of
|
||||
`vim.fidget-nvim.notification.window.align`, which now supports `top` and
|
||||
`bottom` values. `vim.fidget-nvim.align.right` has no longer any equivalent
|
||||
and also has been removed.
|
||||
|
||||
- `which-key.nvim` categories can now be customized through [vim.binds.whichKey.register](vim.binds.whichKey.register)
|
||||
- `which-key.nvim` categories can now be customized through
|
||||
[vim.binds.whichKey.register](#opt-vim.binds.whichKey.register)
|
||||
|
||||
- Added `magick` to `vim.luaPackages` for `image.nvim`.
|
||||
|
||||
|
|
@ -94,65 +105,79 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
|
|||
|
||||
[notashelf](https://github.com/notashelf):
|
||||
|
||||
- Finished moving to `nixosOptionsDoc` in the documentation and changelog. All documentation options
|
||||
and files are fully free of Asciidoc, and will now use Nixpkgs flavored markdown.
|
||||
- Finished moving to `nixosOptionsDoc` in the documentation and changelog. All
|
||||
documentation options and files are fully free of Asciidoc, and will now use
|
||||
Nixpkgs flavored markdown.
|
||||
|
||||
- Bumped plugin inputs to their latest versions.
|
||||
|
||||
- Deprecated `presence.nvim` in favor of `neocord`. This means `vim.rich-presence.presence-nvim` is removed and will throw
|
||||
a warning if used. You are recommended to rewrite your neocord configuration from scratch based on the.
|
||||
[official documentation](https://github.com/IogaMaster/neocord)
|
||||
- Deprecated `presence.nvim` in favor of `neocord`. This means
|
||||
`vim.rich-presence.presence-nvim` is removed and will throw a warning if used.
|
||||
You are recommended to rewrite your neocord configuration from scratch based
|
||||
on the. [official documentation](https://github.com/IogaMaster/neocord)
|
||||
|
||||
- Removed Tabnine plugin due to the usage of imperative tarball downloads. If you'd like to see it back, please create an issue.
|
||||
- Removed Tabnine plugin due to the usage of imperative tarball downloads. If
|
||||
you'd like to see it back, please create an issue.
|
||||
|
||||
- Added support for css and tailwindcss through vscode-language-servers-extracted & tailwind-language-server.
|
||||
Those can be enabled through `vim.languages.css` and `vim.languages.tailwind`.
|
||||
- Added support for css and tailwindcss through
|
||||
vscode-language-servers-extracted & tailwind-language-server. Those can be
|
||||
enabled through `vim.languages.css` and `vim.languages.tailwind`.
|
||||
|
||||
- Lualine module now allows customizing `always_divide_middle`, `ignore_focus` and `disabled_filetypes` through the new
|
||||
options: [vim.statusline.lualine.alwaysDivideMiddle](vim.statusline.lualine.alwaysDivideMiddle),
|
||||
[vim.statusline.lualine.ignoreFocus](vim.statusline.lualine.ignoreFocus) and
|
||||
[vim.statusline.lualine.disabledFiletypes](vim.statusline.lualine.disabledFiletypes).
|
||||
- Lualine module now allows customizing `always_divide_middle`, `ignore_focus`
|
||||
and `disabled_filetypes` through the new options:
|
||||
[vim.statusline.lualine.alwaysDivideMiddle](#opt-vim.statusline.lualine.alwaysDivideMiddle),
|
||||
[vim.statusline.lualine.ignoreFocus](#opt-vim.statusline.lualine.ignoreFocus)
|
||||
and
|
||||
[vim.statusline.lualine.disabledFiletypes](#opt-vim.statusline.lualine.disabledFiletypes).
|
||||
|
||||
- Updated all plugin inputs to their latest versions (**21.04.2024**) - this brought minor color changes to the Catppuccin
|
||||
theme.
|
||||
- Updated all plugin inputs to their latest versions (**21.04.2024**) - this
|
||||
brought minor color changes to the Catppuccin theme.
|
||||
|
||||
- Moved home-manager module entrypoint to `flake/modules` and added an experimental Nixos module. This requires further testing
|
||||
before it can be considered ready for use.
|
||||
- Moved home-manager module entrypoint to `flake/modules` and added an
|
||||
experimental Nixos module. This requires further testing before it can be
|
||||
considered ready for use.
|
||||
|
||||
- Made lib calls explicit. E.g. `lib.strings.optionalString` instead of `lib.optionalString`. This is a pattern expected
|
||||
to be followed by all contributors in the future.
|
||||
- Made lib calls explicit. E.g. `lib.strings.optionalString` instead of
|
||||
`lib.optionalString`. This is a pattern expected to be followed by all
|
||||
contributors in the future.
|
||||
|
||||
- Added `image.nvim` for image previews.
|
||||
|
||||
- The final neovim package is now exposed. This means you can build the neovim package that will be added to your
|
||||
package list without rebuilding your system to test if your configuration yields a broken package.
|
||||
- The final neovim package is now exposed. This means you can build the neovim
|
||||
package that will be added to your package list without rebuilding your system
|
||||
to test if your configuration yields a broken package.
|
||||
|
||||
- Changed the tree structure to distinguish between core options and plugin options.
|
||||
- Changed the tree structure to distinguish between core options and plugin
|
||||
options.
|
||||
|
||||
- Added plugin auto-discovery from plugin inputs. This is mostly from
|
||||
[JordanIsaac's neovim-flake](https://github.com/jordanisaacs/neovim-flake). Allows contributors to add plugin inputs
|
||||
with the `plugin-` prefix to have them automatically discovered for the `plugin` type in `lib/types`.
|
||||
[JordanIsaac's neovim-flake](https://github.com/jordanisaacs/neovim-flake).
|
||||
Allows contributors to add plugin inputs with the `plugin-` prefix to have
|
||||
them automatically discovered for the `plugin` type in `lib/types`.
|
||||
|
||||
- Moved internal `wrapLuaConfig` to the extended library, structured its arguments to take `luaBefore`, `luaConfig`
|
||||
and `luaAfter` as strings, which are then concatted inside a lua block.
|
||||
- Moved internal `wrapLuaConfig` to the extended library, structured its
|
||||
arguments to take `luaBefore`, `luaConfig` and `luaAfter` as strings, which
|
||||
are then concatted inside a lua block.
|
||||
|
||||
- Added [`vim.luaConfigBefore`](vim.luaConfigBefore) and [`vim.luaConfigAfter`](vim.luaConfigAfter)
|
||||
for inserting verbatim Lua configuration before and after the resolved Lua DAG respectively. Both of those options
|
||||
take strings as the type, so you may read the contents of a Lua file from a given path.
|
||||
- Added [](#opt-vim.luaConfigPre) and [](#opt-vim.luaConfigPost) for inserting
|
||||
verbatim Lua configuration before and after the resolved Lua DAG respectively.
|
||||
Both of those options take strings as the type, so you may read the contents
|
||||
of a Lua file from a given path.
|
||||
|
||||
- Added [`vim.spellChecking.ignoredFiletypes`](vim.spellChecking.ignoredFiletypes)
|
||||
and [`vim.spellChecking.programmingWordlist.enable`](vim.spellChecking.programmingWordlist.enable) for ignoring certain filetypes
|
||||
in spellchecking and enabling `vim-dirtytalk` respectively. The previously used `vim.spellcheck.vim-dirtytalk` aliases to the latter
|
||||
option.
|
||||
- Added `vim.spellchecking.ignoredFiletypes` and
|
||||
`vim.spellChecking.programmingWordlist.enable` for ignoring certain filetypes
|
||||
in spellchecking and enabling `vim-dirtytalk` respectively. The previously
|
||||
used `vim.spellcheck.vim-dirtytalk` aliases to the latter option.
|
||||
|
||||
- Exposed `withRuby`, `withNodeJs`, `withPython3`, and `python3Packages` from the `makeNeovimConfig` function under their respective options.
|
||||
- Exposed `withRuby`, `withNodeJs`, `withPython3`, and `python3Packages` from
|
||||
the `makeNeovimConfig` function under their respective options.
|
||||
|
||||
- Added [`vim.extraPackages`](vim.extraPackages) for appending additional packages to the wrapper PATH, making said packages available
|
||||
while inside the Neovim session.
|
||||
- Added [](#opt-vim.extraPackages) for appending additional packages to the
|
||||
wrapper PATH, making said packages available while inside the Neovim session.
|
||||
|
||||
- Made treesitter options configurable, and moved `treesitter-context to
|
||||
`setupOpts` while it is enabled.
|
||||
- Made Treesitter options configurable, and moved treesitter-context to
|
||||
`setupOpts` while it is enabled.
|
||||
|
||||
- Added `vim.notify.nvim-notify.setupOpts.render` which takes either a string of enum or
|
||||
a lua function. The default is "compact", but you may change it according to
|
||||
nvim-notify documentation.
|
||||
- Added [](#opt-vim.notify.nvim-notify.setupOpts.render) which takes either a
|
||||
string of enum, or a Lua function. The default is "compact", but you may
|
||||
change it according to nvim-notify documentation.
|
||||
|
|
|
|||
|
|
@ -302,7 +302,7 @@ To migrate to `nixfmt`, simply change `vim.languages.nix.format.type` to
|
|||
[Soliprem](https://github.com/Soliprem):
|
||||
|
||||
- Add LSP and Treesitter support for R under `vim.languages.R`.
|
||||
- Add formatter suppoort for R, with styler and formatR as options
|
||||
- Add formatter support for R, with styler and formatR as options
|
||||
- Add Otter support under `vim.lsp.otter` and an assert to prevent conflict with
|
||||
ccc
|
||||
- Fixed typo in Otter's setupOpts
|
||||
|
|
|
|||
10
docs/static/script/anchor-min.js
vendored
Normal file
10
docs/static/script/anchor-min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
4
docs/static/script/anchor-use.js
vendored
Normal file
4
docs/static/script/anchor-use.js
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
document.addEventListener('DOMContentLoaded', function(event) {
|
||||
anchors.add('h1[id]:not(div.note h1, div.warning h1, div.tip h1, div.caution h1, div.important h1), h2[id]:not(div.note h2, div.warning h2, div.tip h2, div.caution h2, div.important h2), h3[id]:not(div.note h3, div.warning h3, div.tip h3, div.caution h3, div.important h3), h4[id]:not(div.note h4, div.warning h4, div.tip h4, div.caution h4, div.important h4), h5[id]:not(div.note h5, div.warning h5, div.tip h5, div.caution h5, div.important h5), h6[id]:not(div.note h6, div.warning h6, div.tip h6, div.caution h6, div.important h6)');
|
||||
});
|
||||
|
||||
827
docs/static/style.css
vendored
827
docs/static/style.css
vendored
File diff suppressed because one or more lines are too long
4
docs/static/style.scss
vendored
4
docs/static/style.scss
vendored
|
|
@ -1,3 +1,5 @@
|
|||
@use "scss-reset/reset";
|
||||
|
||||
:root {
|
||||
--nmd-color0: #0a3e68;
|
||||
--nmd-color1: #268598;
|
||||
|
|
@ -32,8 +34,6 @@ $color-blue-700: #1d4ed8;
|
|||
$color-blue-800: #1e40af;
|
||||
$color-blue-900: #1e3a8a;
|
||||
|
||||
@use "scss-reset/reset";
|
||||
|
||||
@mixin boxed {
|
||||
background: $color-gray-50;
|
||||
margin: 2rem 16px;
|
||||
|
|
|
|||
97
docs/static/tomorrow-night.min.css
vendored
97
docs/static/tomorrow-night.min.css
vendored
|
|
@ -4,99 +4,4 @@
|
|||
License: ~ MIT (or more permissive) [via base16-schemes-source]
|
||||
Maintainer: @highlightjs/core-team
|
||||
Version: 2021.09.0
|
||||
*/
|
||||
pre code.hljs {
|
||||
display: block;
|
||||
overflow-x: auto;
|
||||
padding: 1em;
|
||||
}
|
||||
code.hljs {
|
||||
padding: 3px 5px;
|
||||
}
|
||||
.hljs {
|
||||
color: #ccc;
|
||||
background: #2d2d2d;
|
||||
}
|
||||
.hljs ::selection,
|
||||
.hljs::selection {
|
||||
background-color: #515151;
|
||||
color: #ccc;
|
||||
}
|
||||
.hljs-comment {
|
||||
color: #999;
|
||||
}
|
||||
.hljs-tag {
|
||||
color: #b4b7b4;
|
||||
}
|
||||
.hljs-operator,
|
||||
.hljs-punctuation,
|
||||
.hljs-subst {
|
||||
color: #ccc;
|
||||
}
|
||||
.hljs-operator {
|
||||
opacity: 0.7;
|
||||
}
|
||||
.hljs-bullet,
|
||||
.hljs-deletion,
|
||||
.hljs-name,
|
||||
.hljs-selector-tag,
|
||||
.hljs-template-variable,
|
||||
.hljs-variable {
|
||||
color: #f2777a;
|
||||
}
|
||||
.hljs-attr,
|
||||
.hljs-link,
|
||||
.hljs-literal,
|
||||
.hljs-number,
|
||||
.hljs-symbol,
|
||||
.hljs-variable.constant_ {
|
||||
color: #f99157;
|
||||
}
|
||||
.hljs-class .hljs-title,
|
||||
.hljs-title,
|
||||
.hljs-title.class_ {
|
||||
color: #fc6;
|
||||
}
|
||||
.hljs-strong {
|
||||
font-weight: 700;
|
||||
color: #fc6;
|
||||
}
|
||||
.hljs-addition,
|
||||
.hljs-code,
|
||||
.hljs-string,
|
||||
.hljs-title.class_.inherited__ {
|
||||
color: #9c9;
|
||||
}
|
||||
.hljs-built_in,
|
||||
.hljs-doctag,
|
||||
.hljs-keyword.hljs-atrule,
|
||||
.hljs-quote,
|
||||
.hljs-regexp {
|
||||
color: #6cc;
|
||||
}
|
||||
.hljs-attribute,
|
||||
.hljs-function .hljs-title,
|
||||
.hljs-section,
|
||||
.hljs-title.function_,
|
||||
.ruby .hljs-property {
|
||||
color: #69c;
|
||||
}
|
||||
.diff .hljs-meta,
|
||||
.hljs-keyword,
|
||||
.hljs-template-tag,
|
||||
.hljs-type {
|
||||
color: #c9c;
|
||||
}
|
||||
.hljs-emphasis {
|
||||
color: #c9c;
|
||||
font-style: italic;
|
||||
}
|
||||
.hljs-meta,
|
||||
.hljs-meta .hljs-keyword,
|
||||
.hljs-meta .hljs-string {
|
||||
color: #a3685a;
|
||||
}
|
||||
.hljs-meta .hljs-keyword,
|
||||
.hljs-meta-keyword {
|
||||
font-weight: 700;
|
||||
}
|
||||
*/pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#ccc;background:#2d2d2d}.hljs ::selection,.hljs::selection{background-color:#515151;color:#ccc}.hljs-comment{color:#999}.hljs-tag{color:#b4b7b4}.hljs-operator,.hljs-punctuation,.hljs-subst{color:#ccc}.hljs-operator{opacity:.7}.hljs-bullet,.hljs-deletion,.hljs-name,.hljs-selector-tag,.hljs-template-variable,.hljs-variable{color:#f2777a}.hljs-attr,.hljs-link,.hljs-literal,.hljs-number,.hljs-symbol,.hljs-variable.constant_{color:#f99157}.hljs-class .hljs-title,.hljs-title,.hljs-title.class_{color:#fc6}.hljs-strong{font-weight:700;color:#fc6}.hljs-addition,.hljs-code,.hljs-string,.hljs-title.class_.inherited__{color:#9c9}.hljs-built_in,.hljs-doctag,.hljs-keyword.hljs-atrule,.hljs-quote,.hljs-regexp{color:#6cc}.hljs-attribute,.hljs-function .hljs-title,.hljs-section,.hljs-title.function_,.ruby .hljs-property{color:#69c}.diff .hljs-meta,.hljs-keyword,.hljs-template-tag,.hljs-type{color:#c9c}.hljs-emphasis{color:#c9c;font-style:italic}.hljs-meta,.hljs-meta .hljs-keyword,.hljs-meta .hljs-string{color:#a3685a}.hljs-meta .hljs-keyword,.hljs-meta-keyword{font-weight:700}
|
||||
|
|
|
|||
20
flake.nix
20
flake.nix
|
|
@ -31,29 +31,25 @@
|
|||
};
|
||||
|
||||
homeManagerModules = {
|
||||
nvf = import ./flake/modules/home-manager.nix self.packages lib;
|
||||
default = self.homeManagerModules.nvf;
|
||||
neovim-flake =
|
||||
lib.warn ''
|
||||
homeManagerModules.neovim-flake has been deprecated.
|
||||
Plese use the homeManagerModules.nvf instead
|
||||
'homeManagerModules.neovim-flake' has been deprecated, and will be removed
|
||||
in a future release. Please use 'homeManagerModules.nvf' instead.
|
||||
''
|
||||
self.homeManagerModules.nvf;
|
||||
|
||||
nvf = import ./flake/modules/home-manager.nix self.packages lib;
|
||||
|
||||
default = self.homeManagerModules.nvf;
|
||||
};
|
||||
|
||||
nixosModules = {
|
||||
nvf = import ./flake/modules/nixos.nix self.packages lib;
|
||||
default = self.nixosModules.nvf;
|
||||
neovim-flake =
|
||||
lib.warn ''
|
||||
nixosModules.neovim-flake has been deprecated.
|
||||
Please use the nixosModules.nvf instead
|
||||
'nixosModules.neovim-flake' has been deprecated, and will be removed
|
||||
in a future release. Please use 'nixosModules.nvf' instead.
|
||||
''
|
||||
self.nixosModules.nvf;
|
||||
|
||||
nvf = import ./flake/modules/nixos.nix self.packages lib;
|
||||
|
||||
default = self.nixosModules.nvf;
|
||||
};
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,20 @@
|
|||
docs-html = docs.manual.html;
|
||||
docs-manpages = docs.manPages;
|
||||
docs-json = docs.options.json;
|
||||
docs-linkcheck = let
|
||||
site = config.packages.docs;
|
||||
in
|
||||
pkgs.testers.lycheeLinkCheck {
|
||||
inherit site;
|
||||
remap = {
|
||||
"https://notashelf.github.io/nvf/" = site;
|
||||
};
|
||||
extraConfig = {
|
||||
exclude = [];
|
||||
include_mail = true;
|
||||
include_verbatim = true;
|
||||
};
|
||||
};
|
||||
|
||||
# Build and open the built manual in your system browser
|
||||
docs-html-wrapped = pkgs.writeScriptBin "docs-html-wrapped" ''
|
||||
|
|
|
|||
|
|
@ -1,31 +1,37 @@
|
|||
{lib}:
|
||||
with lib; let
|
||||
{lib}: let
|
||||
inherit (lib.options) mkOption mkPackageOption;
|
||||
inherit (lib.attrsets) attrNames;
|
||||
inherit (lib.types) listOf either enum submodule package;
|
||||
|
||||
diagnosticSubmodule = _: {
|
||||
options = {
|
||||
type = mkOption {
|
||||
description = "Type of diagnostic to enable";
|
||||
type = attrNames diagnostics;
|
||||
};
|
||||
|
||||
package = mkOption {
|
||||
type = package;
|
||||
description = "Diagnostics package";
|
||||
type = types.package;
|
||||
};
|
||||
};
|
||||
};
|
||||
in {
|
||||
|
||||
diagnostics = {
|
||||
langDesc,
|
||||
diagnosticsProviders,
|
||||
defaultDiagnosticsProvider,
|
||||
}:
|
||||
mkOption {
|
||||
description = "List of ${langDesc} diagnostics to enable";
|
||||
type = with types; listOf (either (enum (attrNames diagnosticsProviders)) (submodule diagnosticSubmodule));
|
||||
type = listOf (either (enum (attrNames diagnosticsProviders)) (submodule diagnosticSubmodule));
|
||||
default = defaultDiagnosticsProvider;
|
||||
description = "List of ${langDesc} diagnostics to enable";
|
||||
};
|
||||
|
||||
mkGrammarOption = pkgs: grammar:
|
||||
mkPackageOption pkgs ["${grammar} treesitter"] {
|
||||
default = ["vimPlugins" "nvim-treesitter" "builtGrammars" grammar];
|
||||
};
|
||||
in {
|
||||
inherit diagnostics diagnosticSubmodule mkGrammarOption;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
inherit (lib.nvim.types) mkPluginSetupOption;
|
||||
in {
|
||||
imports = [
|
||||
(mkRemovedOptionModule ["vim" "autopairs" "nvim-compe"] "nvim-compe is deprecated and no longer suported.")
|
||||
(mkRemovedOptionModule ["vim" "autopairs" "nvim-compe"] "nvim-compe is deprecated and no longer supported.")
|
||||
];
|
||||
|
||||
options.vim.autopairs.nvim-autopairs = {
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ in {
|
|||
|
||||
A `deprio` function and a `kinds`
|
||||
(`require("cmp.types").lsp.CompletionItemKind`) variable is provided
|
||||
above `setupOpts`. By passing a type to the funcion, the returned
|
||||
above `setupOpts`. By passing a type to the function, the returned
|
||||
function will be a comparator that always ranks the specified kind the
|
||||
lowest.
|
||||
'';
|
||||
|
|
@ -88,7 +88,7 @@ in {
|
|||
```
|
||||
'';
|
||||
description = ''
|
||||
The function used to customize the completion menu entires. This is
|
||||
The function used to customize the completion menu entries. This is
|
||||
outside of `setupOpts` to allow for an easier integration with
|
||||
lspkind.nvim.
|
||||
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ in {
|
|||
|
||||
customIndices = mkOption {
|
||||
default = [];
|
||||
description = "Specify a list of default charecters to use instead of numbers";
|
||||
description = "Specify a list of default characters to use instead of numbers";
|
||||
type = listOf str;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ in {
|
|||
};
|
||||
|
||||
mappings = {
|
||||
continue = mkMappingOption "Contiue" "<leader>dc";
|
||||
continue = mkMappingOption "Continue" "<leader>dc";
|
||||
restart = mkMappingOption "Restart" "<leader>dR";
|
||||
terminate = mkMappingOption "Terminate" "<leader>dq";
|
||||
runLast = mkMappingOption "Re-run Last Debug Session" "<leader>d.";
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ in {
|
|||
(entryAnywhere ''
|
||||
vim.api.nvim_create_autocmd("BufEnter", {
|
||||
group = vim.api.nvim_create_augroup("load_neo_tree", {}),
|
||||
desc = "Loads neo-tree when openning a directory",
|
||||
desc = "Loads neo-tree when opening a directory",
|
||||
callback = function(args)
|
||||
local stats = vim.uv.fs_stat(args.file)
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ in {
|
|||
${optionalString (config.vim.lazy.enable && cfg.setupOpts.hijack_netrw && !cfg.openOnSetup) ''
|
||||
vim.api.nvim_create_autocmd("BufEnter", {
|
||||
group = vim.api.nvim_create_augroup("load_nvim_tree", {}),
|
||||
desc = "Loads nvim-tree when openning a directory",
|
||||
desc = "Loads nvim-tree when opening a directory",
|
||||
callback = function(args)
|
||||
local stats = vim.uv.fs_stat(args.file)
|
||||
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ in {
|
|||
};
|
||||
|
||||
package = mkOption {
|
||||
description = "lldb pacakge";
|
||||
description = "lldb package";
|
||||
type = package;
|
||||
default = pkgs.lldb;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -181,8 +181,10 @@ in {
|
|||
extensions = {
|
||||
ts-error-translator = {
|
||||
enable = mkEnableOption ''
|
||||
Typescript error translation with
|
||||
[ts-error-translator.nvim](github.com/dmmulroy/ts-error-translator.nvim)
|
||||
[ts-error-translator.nvim]: https://github.com/dmmulroy/ts-error-translator.nvim
|
||||
|
||||
Typescript error translation with [ts-error-translator.nvim]
|
||||
|
||||
'';
|
||||
|
||||
setupOpts = mkPluginSetupOption "ts-error-translator" {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ in {
|
|||
default_timeout = mkOption {
|
||||
type = int;
|
||||
default = 5000;
|
||||
description = "Default timeout value, in miliseconds";
|
||||
description = "Default timeout value, in milliseconds";
|
||||
};
|
||||
|
||||
sources = mkOption {
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ in {
|
|||
description = ''
|
||||
if set to true, the filetype of the otterbuffers will be set. Other wide only
|
||||
the autocommand of lspconfig that attaches the language server will be
|
||||
executed without stting the filetype
|
||||
executed without setting the filetype
|
||||
'';
|
||||
};
|
||||
write_to_disk = mkOption {
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ in {
|
|||
migration is required.
|
||||
|
||||
Please see neocord documentation and options page on the **nvf** manual
|
||||
for mor einformation
|
||||
for more information
|
||||
'')
|
||||
]
|
||||
++ (map
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ in {
|
|||
autosave_ignore_buftypes = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [];
|
||||
description = "All buffers of these bufer types will be closed before the session is saved";
|
||||
description = "All buffers of these buffer types will be closed before the session is saved";
|
||||
};
|
||||
|
||||
autosave_only_in_session = mkOption {
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ in {
|
|||
type = bool;
|
||||
default = true;
|
||||
description = ''
|
||||
Whether or not to allow highlight groups to be overriden.
|
||||
Whether or not to allow highlight groups to be overridden.
|
||||
|
||||
While false, bufferline.nvim sets highlights as default.
|
||||
'';
|
||||
|
|
@ -101,7 +101,7 @@ in {
|
|||
The indicatotor icon to use for the current buffer.
|
||||
|
||||
::: {.warning}
|
||||
This **must** be ommitted while style is not `icon`
|
||||
This **must** be omitted while style is not `icon`
|
||||
:::
|
||||
'';
|
||||
};
|
||||
|
|
@ -338,17 +338,6 @@ in {
|
|||
description = "Whether or not the move command \"wraps\" at the first or last position";
|
||||
};
|
||||
|
||||
seperator_style = mkOption {
|
||||
type = either (enum ["thick" "thin" "slope" "slant"]) (listOf str);
|
||||
default = [" " " "];
|
||||
description = ''
|
||||
Style of the buffer separator.
|
||||
|
||||
Can be either one of the suspported values, or a list containing
|
||||
**at most** two elements for `focused` and `unfocused` respectively.
|
||||
'';
|
||||
};
|
||||
|
||||
separator_style = mkOption {
|
||||
type = nullOr (either (enum ["slant" "padded_slant" "slope" "padded_slope" "thick" "thin"]) (listOf str));
|
||||
default = "thin";
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
multilineThreshold = "multiline_threshold";
|
||||
trimScope = "trim_scope";
|
||||
mode = "mode";
|
||||
seperator = "separator";
|
||||
separator = "separator";
|
||||
zindex = "z_index";
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
in {
|
||||
options.vim.utility.motion.hop = {
|
||||
mappings = {
|
||||
hop = mkMappingOption "Jump to occurences [hop.nvim]" "<leader>h";
|
||||
hop = mkMappingOption "Jump to occurrences [hop.nvim]" "<leader>h";
|
||||
};
|
||||
|
||||
enable = mkEnableOption "Hop.nvim plugin (easy motion)";
|
||||
|
|
|
|||
|
|
@ -134,7 +134,7 @@
|
|||
default = ["absolute"];
|
||||
};
|
||||
set_env = mkOption {
|
||||
description = "Set an envrionment for term_previewer";
|
||||
description = "Set an environment for term_previewer";
|
||||
type = attrsOf str;
|
||||
default = {
|
||||
COLORTERM = "truecolor";
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ in {
|
|||
|
||||
::: {.warning}
|
||||
All paths passed to this option must be valid. If Neovim cannot
|
||||
resolve the path you are attempting to sourcee, then your configuration
|
||||
resolve the path you are attempting to source, then your configuration
|
||||
will error, and Neovim will not start. Please ensure that all paths
|
||||
are correct before using this option.
|
||||
:::
|
||||
|
|
|
|||
Loading…
Reference in a new issue