Skip to content

Conversation

@imnotpoz
Copy link
Contributor

found these in :checkhealth

Sanity Checking

  • I have updated the changelog as per my changes
  • I have tested, and self-reviewed my code
  • My changes fit guidelines found in hacking nvf
  • 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
  • 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
  • Package(s) built:
    • .#nix (default package)
    • .#maximal
    • .#docs-html (manual, must build)
    • .#docs-linkcheck (optional, please build if adding links)
  • Tested on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin

Add a 👍 reaction to pull requests you find important.

@github-actions
Copy link

🚀 Live preview deployed from 4555319

View it here:

Debug Information

Triggered by: imnotpoz

HEAD at: main

Reruns: 1746

Comment on lines +576 to +582
default = false;
visible = false;
apply = warn ''
Option `vim.visuals.fidget-nvim.setupOpts.integration.xcodebuild-nvim.enable`
has been deprecated upstream. Use
`vim.visuals.fidget-nvim.setupOpts.notification.window.avoid = ["TestExplorer"]` instead.
'';
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the correct way to warn on an option. You'll want to use mkRemovedOptionModule as the rest of the codebase. Apply does work, but it's a really fragile way of doing this. Also applies to the vim.visuals.fidget-nvim.setupOpts.integration.nvim-tree.enable warning above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately not possible due to mkPluginSetupOption, see #1305

Comment on lines +544 to +552
tabstop = mkOption {
description = "Width of each tab character in the notification window";
type = int;
default = 8;
};
avoid = mkOption {
description = "Filetypes the notification window should avoid";
type = listOf str;
default = [];
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please order mkOption args as

  1. type
  2. default
  3. (optional) example
  4. Description

Also fwiw the setupOpts block is freeform so new options are not strictly necessary. Though if you do want to type-check those or for those to show up on documentation, it's fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

every single option in this module is ordered description -> type -> default, should I change all of them to this ordering?

Copy link
Owner

@NotAShelf NotAShelf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments on formatting and introduction of new options. I'd appreciate it if you could follow the "convention" for mkOption.

Also, this requires a changelog entry after v0.9. LGTM otherwise. Though CC @horriblename for the HLS changes.

@imnotpoz
Copy link
Contributor Author

Also, this requires a changelog entry after v0.9. LGTM otherwise. Though CC @horriblename for the HLS changes.

changelog for both commits? I can add it once the comments above are resolved

Copy link
Collaborator

@horriblename horriblename left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty this will trigger the deprecation warning regardless of whether the user has set this option

I think removing the default value works? (I don't remember if it allows not giving a default without one)

# see https://github.com/mrcjkb/haskell-tools.nvim/blob/v6.2.0/lua/haskell-tools/lsp/init.lua#L131-L173
# for the real ones
hls = {
enable = false;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from my understanding, we're relying on haskell-tools to start the lsp, so we should set this to false? (enable = true, which is the default, calls vim.lsp.enable("server_name")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants