AstroNvim / AstroNvim/docs

Docs: Clarify Extending Core Plugin Config Functions

オープン
#67 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation good first issue help wanted
主要言語
MDX
スター
30
フォーク
72
PR マージ指標
30日以内にマージされた PR はありません

説明

### 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!

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

リンクされている custom_plugins レシピ、user_example/plugins/null-ls.lua、および AstroNvim/lua/plugins/lsp.lua の30行目付近から始めます。2つの拡張アプローチを比較し、それぞれがいつ適用されるのかを、返される設定オブジェクトと null-ls のセットアップの関係も含めて説明します。ドキュメントに適用可能なプラグインが一覧またはリンクとして記載され、opts-pattern の明確な例が含まれていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。