From cacd6228b509ee91e945b4420654258e36b36339 Mon Sep 17 00:00:00 2001 From: diniamo Date: Mon, 15 Jul 2024 21:31:01 +0200 Subject: [PATCH] docs: add dag-entries chapter, add release note entry --- docs/manual/configuring.md | 1 + docs/manual/configuring/dag-entries.md | 20 ++++++++++++++++++++ docs/release-notes/rl-0.7.md | 4 ++++ 3 files changed, 25 insertions(+) create mode 100644 docs/manual/configuring/dag-entries.md diff --git a/docs/manual/configuring.md b/docs/manual/configuring.md index 8f5e240..5a3c96f 100644 --- a/docs/manual/configuring.md +++ b/docs/manual/configuring.md @@ -5,4 +5,5 @@ configuring/custom-package.md configuring/custom-plugins.md configuring/languages.md configuring/dags.md +configuring/dag-entries.md ``` diff --git a/docs/manual/configuring/dag-entries.md b/docs/manual/configuring/dag-entries.md new file mode 100644 index 0000000..9f8f292 --- /dev/null +++ b/docs/manual/configuring/dag-entries.md @@ -0,0 +1,20 @@ +# DAG entries in nvf {#ch-dag-entries} + +From the previous chapter, it should be clear that DAGs are useful, because you +can add code that relies on other code. However, if you don't know what the +entries are called, it's hard to do that, so here is a list of the internal +entries in nvf: + +`vim.luaConfigRC` (top-level DAG): + +1. (`luaConfigPre`) - not a part of the actual DAG, instead, it's simply + inserted before the rest of the DAG +2. `globalsScript` - used to set globals defined in `vim.globals` +3. `basic` - used to set basic configuration options +4. `theme` - used to set up the theme, which has to be done before other plugins +5. `pluginConfigs` - the result of the nested `vim.pluginRC` (internal option, + see the [Custom Plugins](./custom-plugins.md) page for adding your own + plugins) DAG, used to set up internal plugins +6. `extraPluginConfigs` - the result of `vim.extraPlugins`, which is not a + direct DAG, but is converted to, and resolved as one internally +7. `mappings` - the result of `vim.maps` diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index d5f3853..61fbf7b 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -69,6 +69,10 @@ Release notes for release 0.7 yourself by adding `vim.opt.listchars:append({ eol = '' })` to your lua configuration +- Make the entire configuration lua based. This comes with a few breaking changes: + - `vim.configRC` has been removed, migrate your entries to lua code, and add them to `vim.luaConfigRC` instead + - `vim.luaScriptRC` is now the top-level DAG, and the internal `vim.pluginRC` has been introduced for setting up internal plugins. See the "DAG entries in nvf" manual page for more information. + [NotAShelf](https://github.com/notashelf): [ts-error-translator.nvim]: https://github.com/dmmulroy/ts-error-translator.nvim