diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index be97db2a..4361d9f9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -90,6 +90,15 @@ body: validations: required: true + - type: input + id: nix-metadata + attributes: + label: "💻 Metadata" + description: 'Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.' + placeholder: '[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"' + validations: + required: true + - type: textarea attributes: label: System Information @@ -110,7 +119,7 @@ body: id: logs attributes: render: bash - label: "Relevant log output" + label: "📝 Relevant log output" description: >- Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 819891df..d7ed2654 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,72 +1,58 @@ name: 🚀 Feature Request description: "Propose a new feature" -title: "" +#title: "[Feature] " labels: [feature-request] body: - type: checkboxes + id: no-duplicate-issues attributes: - label: I have verified that this feature request has not been made before - description: >- - Before opening a new issue for feature requests, please consider searching through currently - open issues [here](https://github.com/notashelf/nvf/issues). If you would like to discuss a - new addition beforehand, you may first want to create a new discussion threat and discuss it - with the maintainers [on the discussions tab](https://github.com/notashelf/nvf/discussions) + label: "⚠️ Please verify that this feature request has NOT been suggested before." + description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake/issues?q=)" options: - - required: true - label: >- - I have checked the [issues tab](https://github.com/notashelf/nvf/issues?q=is%3Aissue), - and did not find a similar feature request. I understand that my issue will be closed - if it is a duplicate. - + - label: "I checked and didn't find a similar feature request" + required: true - type: dropdown id: feature-area attributes: - label: Feature Type - description: Please describe the kind of addition this is + label: "🏷️ Feature Type" + description: "What kind of a feature request is this?" multiple: true options: - - New Plugin - - Update Request (Plugin/Nixpkgs) - - Documentation Updates + - New Command + - New Addon + - API Additions - Other validations: required: true - - - type: textarea id: feature-description - attributes: - label: Feature description - description: >- - Please provide a clear and concise description of the desired addition. If this is a plugin - addition, please also include a link to the desired plugin and the reason why you think this - is a good addition. Keep in mind that we may refuse plugin requests as nvf already provides - appropriate methods of installing plugins in user configurations. - placeholder: >- - "nvf currently does [...], which really frustrates me" or "You should add [...] because I think - [...]" validations: required: true - + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what your feature request is." + placeholder: "'You should add [...]' or '[...] has always frustrated me' " + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✔️ Solution" + description: "A clear and concise description of what you want to happen." + placeholder: "In my use-case, I would like [...]" - type: textarea id: alternatives - attributes: - label: Alternatives - description: >- - If you have tried anything before creating this issue, please give us a clear and concise - description of any alternative solutions or methods you have considered. - placeholder: "I have considered [...]" validations: required: false - + attributes: + label: "❓ Alternatives" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "I have considered [...]" - type: textarea id: additional-context - attributes: - label: Additional Context - description: >- - If there is anything else you would like to mention, such as additional context or screenshots - demonstrating the requested feature, please add them here. This field is optional, but you may - be requested to provide further context. Please ensure that your feature request clearly describes - the requested feature in good detail. validations: required: false + attributes: + label: "📝 Additional Context" + description: "Add any other context or screenshots about the feature request here." + placeholder: "..." diff --git a/.github/README.md b/.github/README.md index 395a9320..3fc7ffdf 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,4 +1,3 @@ -
nvf Logo
@@ -47,10 +46,11 @@ [Features]: #features [Get Started]: #get-started [Documentation]: #documentation -[Help]: #getting-help +[Help]: #help [Contribute]: #contributing [FAQ]: #frequently-asked-questions [Credits]: #credits +[License]: #license **[
 Features
][Features]** **[
 Get Started 
][Get Started]** @@ -84,22 +84,21 @@ 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. - - Lazyloading? We got it! Lazyload both internal and external plugins at will - 💤 . + - Lazyloading 💤? We got it! Lazyload both internal and external plugins at + will. - nvf allows _ordering configuration bits_ using [DAG] (_Directed acyclic graph_)s. It has never been easier to construct an editor configuration deterministically! - nvf exposes everything you need to avoid a vendor lock-in. Which means you can add new modules, plugins and so on without relying on us adding a module for them! Though, of course, feel free to request them. - - Use plugins from anywhere: inputs, npins, nixpkgs... You name it. - - Add your own modules with ease. It's all built-in! + - Use plugins from anywhere. Inputs, npins, nixpkgs... You name it. + - Add your own modules, with ease. It's all built-in! - **Well-documented**: Documentation is priority. You will _never_ face undocumented, obscure behaviour. - - Any and all changes, breaking or otherwise, will be communicated in the - [release notes]. + - Changes, breaking or otherwise, will be communicated in the [release notes] - Refer to the [FAQ section] for answers to common questions. - - Your question not there? Head to the [discussions tab]! + - Your question not there? Head to the to the [discussions tab]! - **Idiomatic**: nvf does things ✨ _the right way_ ✨ - the codebase is, and will, remain maintainable for myself and any contributors. - **Community-Led**: we would like nvf to be fully capable of accomplishing what @@ -130,17 +129,12 @@ of the configuration options are final as **nvf** is designed to be modular and configurable. > [!TIP] -> The flake exposes `nix` as the default package, which will be evaluated when -> you run `nix build` or `nix run` on this repo. It is minimal, and providing -> limited language support and various utilities. We also expose the `maximal` -> package, which you may choose to build if you'd like to see more of nvf's -> built-in modules. Please keep in mind that those are demo packages, nvf does -> not ship a default configuration if installed as a NixOS/Home-Manager module -> or via standalone method. +> The flake exposes `#nix` as the default package, providing minimal language +> support and various utilities. You may also use the `#nix` or `#maximal` +> packages provided by the this flake to get try out different configurations. -It is as simple as changing the target output in your `nix run` command to get a -different configuration. For example, to get a configuration with large language -coverage, run: +It is as simple as changing the target output to get a different configuration. +For example, to get a configuration with large language coverage, run: ```bash # Run the maximal package @@ -148,7 +142,7 @@ nix run github:notashelf/nvf#maximal ``` Similar instructions will apply for `nix profile install`. However, you are -recommended to instead use the module system as described in the [nvf manual]. +recommended to instead use the module system as described in the manual. > [!NOTE] > The `maximal` configuration is quite large, and might take a while to build. @@ -161,10 +155,6 @@ instructions. ## Documentation -**nvf** prides itself in its rich, intuitive documentation. The chapter below -covers several methods through which you can install **nvf**. If you believe -something is missing, or could be done better, please feel free to contact us! - ### Installation The _recommended_ way of installing nvf is using either the NixOS or the @@ -173,7 +163,7 @@ install **nvf** as a standalone package, or a flake output. See the rendered [nvf manual] for detailed and up-to-date installation guides, configurations, available options, release notes and more. Tips for installing -userspace plugins are also contained in the documentation. +userspace plugins is also contained in the documentation. > [!TIP] > While using NixOS or Home-Manager modules, @@ -190,9 +180,8 @@ requests are also welcome, and appreciated. 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 yet on spaces like matrix or IRC, so please use the issue tracker for -now. The [discussions tab] can also be a place to request help from community -members, or engage in productive discussion with the maintainers. +We are not not yet on spaces like matrix or IRC, so please use the issue tracker +for now. ## Contributing @@ -236,7 +225,7 @@ in the most comfortable way possible for the end user. If you have not noticed any activity on the main branch, consider taking a look at the [list of branches] or the [list of open pull requests]. You may also consider _testing_ those release branches to get access to new features ahead of time and -better prepare for breaking changes. +better prepare to breaking changes. **Q**: Will you support non-flake installations? @@ -251,8 +240,8 @@ of a configuration generated from Nix? **A**: Yes! Add `"~/.config/nvim"` to `vim.additionalRuntimePaths = [ ... ]` and any plugins you want to load to `vim.startPlugins`. This will load your -configuration from `~/.config/nvim`. You may still use `vim.*` options in Nix to -further configure Neovim. +configuration from `~/.config/nvim`. You may still use `vim.*` to modify +Neovim's behaviour with Nix. ## Credits diff --git a/configuration.nix b/configuration.nix index 62c3e2f1..ac0ad32b 100644 --- a/configuration.nix +++ b/configuration.nix @@ -154,6 +154,7 @@ isMaximal: { binds = { whichKey.enable = true; cheatsheet.enable = true; + hardtime-nvim.enable = isMaximal; }; telescope.enable = true; diff --git a/flake.lock b/flake.lock index 5a09ce8a..d33a8f7d 100644 --- a/flake.lock +++ b/flake.lock @@ -23,11 +23,11 @@ ] }, "locked": { - "lastModified": 1753121425, - "narHash": "sha256-TVcTNvOeWWk1DXljFxVRp+E0tzG1LhrVjOGGoMHuXio=", + "lastModified": 1749398372, + "narHash": "sha256-tYBdgS56eXYaWVW3fsnPQ/nFlgWi/Z2Ymhyu21zVM98=", "owner": "hercules-ci", "repo": "flake-parts", - "rev": "644e0fc48951a860279da645ba77fe4a6e814c5e", + "rev": "9305fe4e5c2a6fcf5ba6a3ff155720fbe4076569", "type": "github" }, "original": { @@ -73,11 +73,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1752997324, - "narHash": "sha256-vtTM4oDke3SeDj+1ey6DjmzXdq8ZZSCLWSaApADDvIE=", + "lastModified": 1750215678, + "narHash": "sha256-Rc/ytpamXRf6z8UA2SGa4aaWxUXRbX2MAWIu2C8M+ok=", "owner": "nixos", "repo": "nixpkgs", - "rev": "7c688a0875df5a8c28a53fb55ae45e94eae0dddb", + "rev": "5395fb3ab3f97b9b7abca147249fa2e8ed27b192", "type": "github" }, "original": { diff --git a/flake/pkgs/by-name/avante-nvim/package.nix b/flake/pkgs/by-name/avante-nvim/package.nix index 61ab21cc..4f8cdd9d 100644 --- a/flake/pkgs/by-name/avante-nvim/package.nix +++ b/flake/pkgs/by-name/avante-nvim/package.nix @@ -55,8 +55,8 @@ in ext = stdenv.hostPlatform.extensions.sharedLibrary; in '' mkdir -p $out/build - for lib in "avante_repo_map" "avante_templates" "avante_tokenizers" "avante_html2md"; do - ln -s ${avante-nvim-lib}/lib/lib$lib${ext} $out/build/$lib${ext} + for lib in avante_repo_map avante_templates avante_tokenizers avante_html2md; do + ln -s ${avante-nvim-lib}/lib/lib$lib${ext} $out/build/$$lib${ext} done '';