AstroNvim / AstroNvim/docs

Docs: Clarify Extending Core Plugin Config Functions

Ouverte
#67 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation good first issue help wanted
Langage dominant
MDX
Étoiles
30
Forks
72
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

### Is your feature related to a problem?

The existing documentation is not clear on which plugins have a `require("plugins.configs.X")`. One might assume that all plugins inside astronvim have them but they don't. Which means the plugins that don't have this configuration must be set in a different way.

example:

If you want to set telescope you can follow the example in the [official doc](https://astronvim.com/Recipes/custom_plugins#extending-core-plugin-config-functions) but if you want to setup null-ls sources the user_example configuration suggests a different approach https://github.com/AstroNvim/user_example/blob/main/plugins/null-ls.lua

It is not clear to me what happens with the `config` object returned in the example and how is that related to the [code that sets null-ls](https://github.com/AstroNvim/AstroNvim/blob/291c43b0bdd551ebaf4de11e4f41ff7ddb38559a/lua/plugins/lsp.lua#L30) in astronvim.

In general terms there are really two different ways to extend core plugins and they are not clearly documented.

### Describe the new feature

* A list (or link) pointing to the plugins that have a `plugins.configs` defined and should follow the require pattern
* An additional examples for plugins that don't have their own `plugin.configs` and should follow the `opts` function pattern.

I understand that you point to the lazy.nvim documentation but the link is to a general readme file and it is hard to know how much of the work is done by lazy.nvim and how much by astronvim code which ends up on multiple trial and error to see what works.

### Additional context

Thanks for such a nice work in Astronvim!

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la recette custom_plugins liée, user_example/plugins/null-ls.lua et AstroNvim/lua/plugins/lsp.lua autour de la ligne 30. Comparez les deux approches d’extension et expliquez quand chacune s’applique, notamment comment l’objet de configuration renvoyé est lié à la configuration de null-ls. C’est terminé lorsque la documentation répertorie ou lie les plugins applicables et contient un exemple clair du modèle opts.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.