mirror of
https://github.com/nix-community/nixvim.git
synced 2025-11-08 19:46:06 +01:00
dev/list-plugins: drop
As no more plugins are declared using the legacy approach, the list-plugins.py script has lost its use. Let's drop it altogether.
This commit is contained in:
Gaetan Lepage
Gaétan Lepage
parent
beba0820c3
commit
d01e1c17e2
6 changed files with 0 additions and 285 deletions
|
|
@ -182,9 +182,6 @@ cd nixvim
|
||||||
|
|
||||||
# Either setup nix-direnv, or manually enter a devshell using:
|
# Either setup nix-direnv, or manually enter a devshell using:
|
||||||
nix develop
|
nix develop
|
||||||
|
|
||||||
# List all created plugins with `mkVimPlugin`
|
|
||||||
list-plugins -k vim
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Writing option examples
|
#### Writing option examples
|
||||||
|
|
|
||||||
|
|
@ -52,7 +52,6 @@
|
||||||
# Propagate `packages` from the `dev` partition:
|
# Propagate `packages` from the `dev` partition:
|
||||||
inherit (config.partitions.dev.module.flake.packages.${system})
|
inherit (config.partitions.dev.module.flake.packages.${system})
|
||||||
generate-all-maintainers
|
generate-all-maintainers
|
||||||
list-plugins
|
|
||||||
;
|
;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,6 @@
|
||||||
./fmt.nix
|
./fmt.nix
|
||||||
./generate-all-maintainers
|
./generate-all-maintainers
|
||||||
./git-hooks.nix
|
./git-hooks.nix
|
||||||
./list-plugins
|
|
||||||
./package-tests.nix
|
./package-tests.nix
|
||||||
./template-tests.nix
|
./template-tests.nix
|
||||||
./tests.nix
|
./tests.nix
|
||||||
|
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
{ self, ... }:
|
|
||||||
{
|
|
||||||
perSystem =
|
|
||||||
{
|
|
||||||
lib,
|
|
||||||
pkgs,
|
|
||||||
...
|
|
||||||
}:
|
|
||||||
let
|
|
||||||
package = pkgs.writers.writePython3Bin "list-plugins" {
|
|
||||||
# Disable flake8 checks that are incompatible with the ruff ones
|
|
||||||
flakeIgnore = [
|
|
||||||
# Thinks shebang is a block comment
|
|
||||||
"E265"
|
|
||||||
# line too long
|
|
||||||
"E501"
|
|
||||||
# line break before binary operator
|
|
||||||
"W503"
|
|
||||||
];
|
|
||||||
} (builtins.readFile ./list-plugins.py);
|
|
||||||
in
|
|
||||||
{
|
|
||||||
packages.list-plugins = package;
|
|
||||||
|
|
||||||
checks.list-plugins-test =
|
|
||||||
pkgs.runCommand "list-plugins-test"
|
|
||||||
{
|
|
||||||
nativeBuildInputs = [ package ];
|
|
||||||
}
|
|
||||||
''
|
|
||||||
list-plugins --root-path ${self} > $out
|
|
||||||
'';
|
|
||||||
|
|
||||||
devshells.default.commands = [
|
|
||||||
{
|
|
||||||
name = "list-plugins";
|
|
||||||
command = ''${lib.getExe package} "$@"'';
|
|
||||||
help = "List plugins and get implementation infos";
|
|
||||||
}
|
|
||||||
];
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
@ -1,237 +0,0 @@
|
||||||
#!/usr/bin/env nix-shell
|
|
||||||
#!nix-shell -i python3 -p python3
|
|
||||||
|
|
||||||
import glob
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
from argparse import ArgumentParser, RawTextHelpFormatter
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from enum import Enum
|
|
||||||
from typing import Optional
|
|
||||||
|
|
||||||
# Ignore files that are not plugin definitions
|
|
||||||
EXCLUDES: list[str] = [
|
|
||||||
# Patterns
|
|
||||||
"TEMPLATE.nix",
|
|
||||||
"deprecations.nix",
|
|
||||||
"helpers.nix",
|
|
||||||
"renamed-options",
|
|
||||||
"settings-options.nix",
|
|
||||||
# Specific files
|
|
||||||
"colorschemes/base16/theme-list.nix",
|
|
||||||
"plugins/by-name/blink-cmp/provider-config.nix",
|
|
||||||
"plugins/by-name/conform-nvim/auto-install.nix",
|
|
||||||
"plugins/by-name/conform-nvim/formatter-packages.nix",
|
|
||||||
"plugins/by-name/dap/dapHelpers.nix",
|
|
||||||
"plugins/by-name/efmls-configs/packages.nix",
|
|
||||||
"plugins/by-name/hydra/hydras-option.nix",
|
|
||||||
"plugins/by-name/hydra/settings-options.nix",
|
|
||||||
"plugins/by-name/neotest/adapters-list.nix",
|
|
||||||
"plugins/by-name/neotest/adapters.nix",
|
|
||||||
"plugins/by-name/none-ls/_mk-source-plugin.nix",
|
|
||||||
"plugins/by-name/none-ls/packages.nix",
|
|
||||||
"plugins/by-name/none-ls/prettier.nix",
|
|
||||||
"plugins/by-name/none-ls/prettierd.nix",
|
|
||||||
"plugins/by-name/none-ls/settings.nix",
|
|
||||||
"plugins/by-name/none-ls/sources.nix",
|
|
||||||
"plugins/by-name/openscad/fuzzy-finder-plugin-option.nix",
|
|
||||||
"plugins/by-name/rustaceanvim/renamed-options.nix",
|
|
||||||
"plugins/by-name/telescope/extensions/_mk-extension.nix",
|
|
||||||
"plugins/by-name/telescope/extensions/default.nix",
|
|
||||||
"plugins/by-name/telescope/extensions/zf-native.nix",
|
|
||||||
"plugins/cmp/auto-enable.nix",
|
|
||||||
"plugins/cmp/options/",
|
|
||||||
"plugins/cmp/sources/cmp-fish.nix",
|
|
||||||
"plugins/cmp/sources/default.nix",
|
|
||||||
"plugins/default.nix",
|
|
||||||
"plugins/deprecation.nix",
|
|
||||||
"plugins/lsp/language-servers/",
|
|
||||||
"plugins/lsp/lsp-packages.nix",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class Kind(Enum):
|
|
||||||
NEOVIM = 1
|
|
||||||
VIM = 2
|
|
||||||
MISC = 3
|
|
||||||
|
|
||||||
|
|
||||||
KNOWN_PATHS: dict[
|
|
||||||
str,
|
|
||||||
tuple[
|
|
||||||
Kind, # Vim / Neovim / misc
|
|
||||||
bool, # Has deprecation warnings
|
|
||||||
],
|
|
||||||
] = {}
|
|
||||||
for telescope_extension_name, has_depr_warnings in {
|
|
||||||
"advanced-git-search": False,
|
|
||||||
"file-browser": True,
|
|
||||||
"frecency": True,
|
|
||||||
"fzf-native": True,
|
|
||||||
"fzy-native": True,
|
|
||||||
"live-greps-args": False,
|
|
||||||
"manix": False,
|
|
||||||
"media-files": True,
|
|
||||||
"project": False,
|
|
||||||
"ui-select": False,
|
|
||||||
"undo": True,
|
|
||||||
"zoxide": False,
|
|
||||||
}.items():
|
|
||||||
KNOWN_PATHS[
|
|
||||||
f"plugins/by-name/telescope/extensions/{telescope_extension_name}.nix"
|
|
||||||
] = (
|
|
||||||
Kind.MISC,
|
|
||||||
has_depr_warnings,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
DEPRECATION_REGEX: list[re.Pattern] = [
|
|
||||||
re.compile(rf".*{pattern}", re.DOTALL)
|
|
||||||
for pattern in [
|
|
||||||
"deprecateExtra",
|
|
||||||
"mkRemovedOptionModule",
|
|
||||||
"mkRenamedOptionModule",
|
|
||||||
"optionsRenamedToSettings",
|
|
||||||
]
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Plugin:
|
|
||||||
path: str
|
|
||||||
kind: Kind
|
|
||||||
dep_warnings: bool
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
kind_icon: str
|
|
||||||
match self.kind:
|
|
||||||
case Kind.NEOVIM:
|
|
||||||
kind_icon = "\033[94m" + " "
|
|
||||||
case Kind.VIM:
|
|
||||||
kind_icon = "\033[92m" + " "
|
|
||||||
case Kind.MISC:
|
|
||||||
kind_icon = "\033[92m" + "🟢"
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
deprecation_icon: str = "⚠️ " if self.dep_warnings else " "
|
|
||||||
|
|
||||||
return f"| {kind_icon}\033[0m | {deprecation_icon} | {self.path}"
|
|
||||||
|
|
||||||
def print_markdown(self) -> None:
|
|
||||||
print(f"- [ ] {self.path} ({self.kind.name.lower()})")
|
|
||||||
|
|
||||||
|
|
||||||
def has_deprecation_warnings(string: str) -> bool:
|
|
||||||
for regex in DEPRECATION_REGEX:
|
|
||||||
if re.match(regex, string):
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def parse_file(path: str) -> Optional[Plugin]:
|
|
||||||
file_content: str = ""
|
|
||||||
with open(path, "r") as f:
|
|
||||||
file_content = f.read()
|
|
||||||
|
|
||||||
known_path: str
|
|
||||||
props: tuple[Kind, bool]
|
|
||||||
for known_path, props in KNOWN_PATHS.items():
|
|
||||||
if known_path in path:
|
|
||||||
return Plugin(
|
|
||||||
path=path,
|
|
||||||
kind=props[0],
|
|
||||||
dep_warnings=props[1],
|
|
||||||
)
|
|
||||||
|
|
||||||
kind: Kind
|
|
||||||
if re.match(
|
|
||||||
re.compile(r".*mkNeovimPlugin", re.DOTALL),
|
|
||||||
file_content,
|
|
||||||
):
|
|
||||||
kind = Kind.NEOVIM
|
|
||||||
elif re.match(
|
|
||||||
re.compile(r".*mkVimPlugin", re.DOTALL),
|
|
||||||
file_content,
|
|
||||||
):
|
|
||||||
kind = Kind.VIM
|
|
||||||
else:
|
|
||||||
raise ValueError(
|
|
||||||
f"I was not able to categorize `{path}`. Consider adding it to `EXCLUDES` or `KNOWN_PATHS`."
|
|
||||||
)
|
|
||||||
|
|
||||||
return Plugin(
|
|
||||||
path=path,
|
|
||||||
kind=kind,
|
|
||||||
dep_warnings=has_deprecation_warnings(string=file_content),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _is_excluded(path: str) -> bool:
|
|
||||||
for exclude_pattern in EXCLUDES:
|
|
||||||
if exclude_pattern in path:
|
|
||||||
return False
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
def main(args) -> None:
|
|
||||||
pathname: str = os.path.join(args.root_path, "plugins/**/*.nix")
|
|
||||||
paths: list[str] = glob.glob(pathname=pathname, recursive=True)
|
|
||||||
filtered_paths: list[str] = list(filter(_is_excluded, paths))
|
|
||||||
filtered_paths.sort()
|
|
||||||
|
|
||||||
if not args.markdown:
|
|
||||||
print("| Typ | Sty | DW | path")
|
|
||||||
print(
|
|
||||||
"|-----|-----|----|--------------------------------------------------------"
|
|
||||||
)
|
|
||||||
|
|
||||||
for plugin_path in filtered_paths:
|
|
||||||
plugin: Optional[Plugin] = parse_file(path=plugin_path)
|
|
||||||
if plugin is not None:
|
|
||||||
if (args.kind is None or plugin.kind.name.lower() == args.kind) and (
|
|
||||||
not args.deprecation_warnings or plugin.dep_warnings
|
|
||||||
):
|
|
||||||
if args.markdown:
|
|
||||||
plugin.print_markdown()
|
|
||||||
else:
|
|
||||||
print(plugin)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
parser: ArgumentParser = ArgumentParser(
|
|
||||||
description="""
|
|
||||||
Analyze Nixvim plugin files
|
|
||||||
Output formats a table showing:
|
|
||||||
If a plugin is written for Neovim or Vim.
|
|
||||||
If the plugin has been updated to latest style standards.
|
|
||||||
If a plugin contains any deprecation warnings.
|
|
||||||
""",
|
|
||||||
formatter_class=RawTextHelpFormatter,
|
|
||||||
)
|
|
||||||
# TODO: consider automatically localizing the flake's root.
|
|
||||||
parser.add_argument(
|
|
||||||
"--root-path",
|
|
||||||
type=str,
|
|
||||||
default="./",
|
|
||||||
help="The path to the root of the nixvim repo",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"-k",
|
|
||||||
"--kind",
|
|
||||||
choices=[k.name.lower() for k in Kind],
|
|
||||||
help="Filter plugins by kind (neovim, vim, misc)",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"-d",
|
|
||||||
"--deprecation-warnings",
|
|
||||||
action="store_true",
|
|
||||||
help="Show only plugins with deprecation warnings",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"-m",
|
|
||||||
"--markdown",
|
|
||||||
action="store_true",
|
|
||||||
help="Markdown output",
|
|
||||||
)
|
|
||||||
|
|
||||||
main(parser.parse_args())
|
|
||||||
|
|
@ -16,7 +16,6 @@ tro = "tro" # ./plugins/utils/spectre.nix
|
||||||
protols = "protols" # ./plugins/lsp/lsp-packages.nix
|
protols = "protols" # ./plugins/lsp/lsp-packages.nix
|
||||||
compatibilty = "compatibilty" # ./plugins/by-name/visual-multi/default.nix
|
compatibilty = "compatibilty" # ./plugins/by-name/visual-multi/default.nix
|
||||||
Maco = "Maco" # ./plugins/by-name/femaco
|
Maco = "Maco" # ./plugins/by-name/femaco
|
||||||
Typ = "Typ" # ./flake/dev/list-plugins/list-plugins.py
|
|
||||||
|
|
||||||
[type.patch]
|
[type.patch]
|
||||||
extend-glob = ["*.patch"]
|
extend-glob = ["*.patch"]
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue