Skip to content

Commit

Permalink
feat!: rename to care.nvim
Browse files Browse the repository at this point in the history
  • Loading branch information
max397574 committed Jul 22, 2024
1 parent e8de597 commit fe5d1e4
Show file tree
Hide file tree
Showing 63 changed files with 516 additions and 516 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug Report
description: Report a problem with neocomplete.nvim
description: Report a problem with care.nvim
title: "bug: "
labels: [bug]
body:
Expand All @@ -20,9 +20,9 @@ body:
required: true
- type: textarea
attributes:
label: "neocomplete.nvim setup"
label: "care.nvim setup"
description: |
- Copy your entire `require("neocomplete").setup` function
- Copy your entire `require("care").setup` function
validations:
required: true
- type: textarea
Expand All @@ -40,12 +40,12 @@ body:
- type: textarea
attributes:
label: "Healthcheck"
description: "Output of `:checkhealth neocomplete`"
description: "Output of `:checkhealth care`"
render: markdown
placeholder: |
neocomplete: require("neocomplete.health").check()
care: require("care.health").check()
========================================================================
## neocomplete.nvim
## care.nvim
- type: textarea
attributes:
label: "Steps to reproduce"
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/max397574/neocomplete.nvim/discussions
url: https://github.com/max397574/care.nvim/discussions
about: Use discussions to ask questions
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: Feature request
description: Request a feature for neocomplete.nvim
description: Request a feature for care.nvim
labels: [feature]
body:
- type: checkboxes
id: issue-prerequisite
attributes:
label: Issues
options:
- label: I have checked [existing issues](https://github.com/max397574/neocomplete.nvim/issues) and there are no existing ones with the same request.
- label: I have checked [existing issues](https://github.com/max397574/care.nvim/issues) and there are no existing ones with the same request.
required: true
- type: textarea
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/auto_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
with:
token: ${{ secrets.PAT }}
release-type: simple
package-name: neocomplete.nvim
package-name: care.nvim
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ It can be setup with the following options:
{ path = "luvit-meta/library", words = { "vim%.uv" } },
{ path = "luassert/library", words = { "vim%.uv" } },
{ path = "busted/library", words = { "vim%.uv" } },
{ path = "neocomplete.nvim/lua/neocomplete/types/" },
{ path = "care.nvim/lua/care/types/" },
},
},
},
Expand All @@ -66,7 +66,7 @@ Run
nix develop
```

You can test-drive a minimal Neovim package with only neocomplete.nvim and its dependencies
You can test-drive a minimal Neovim package with only care.nvim and its dependencies
installed by running
```bash
nix run .#nvim
Expand Down
4 changes: 2 additions & 2 deletions neocomplete.nvim-scm-1.rockspec → care.nvim-scm-1.rockspec
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
rockspec_format = '3.0'
package = "neocomplete.nvim"
package = "care.nvim"
version = "scm-1"
source = {
url = "git+https://github.com/max397574/neocomplete.nvim"
url = "git+https://github.com/max397574/care.nvim"
}
dependencies = {
"fzy",
Expand Down
54 changes: 27 additions & 27 deletions docs/config.norg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@document.meta
title: Source
description: Type description of neocomplete.nvim config
description: Type description of care.nvim config
authors: [
max397574
]
Expand All @@ -10,7 +10,7 @@ categories: [
]
tangle: {
languages: {
lua: ../lua/neocomplete/types/config.lua
lua: ../lua/care/types/config.lua
}
scope: tagged
delimiter: none
Expand All @@ -21,23 +21,23 @@ version: 1.1.1
@end

* General
The config of neocomplete is used to configure the ui and neocomplete itself.
The config of care is used to configure the ui and care itself.
#tangle
@code lua
--- Configuration for neocomplete.nvim
---@class neocomplete.config
--- Configuration for care.nvim
---@class care.config
@end

There are two main parts to the config. The first one is the `ui` field and the second on is the
rest of the configuration which is for configuring neocomplete itself.
rest of the configuration which is for configuring care itself.

** UI
In the ui field the completion menu, the docs view and the format of the entries are configured.
There is also a field for configuring type icons.
#tangle
@code lua
--- Configuration for the ui of neocomplete
---@field ui neocomplete.config.ui
--- Configuration for the ui of care
---@field ui care.config.ui
@end

** Snippet expansion
Expand Down Expand Up @@ -76,43 +76,43 @@ version: 1.1.1
@end

** Enabled
This function can be used to disable neocomplete in certain contexts. By default this disables
neocomplete in prompts.
This function can be used to disable care in certain contexts. By default this disables
care in prompts.
#tangle
@code lua
--- Configuration for the ui of neocomplete
--- Configuration for the ui of care
---@field enabled fun(): boolean
@end

* UI
The ui configuration is used to configure the whole ui of neocomplete. One of the main goals of
The ui configuration is used to configure the whole ui of care. One of the main goals of
this is to be as extensible as possible. This is especially important for the completion entries.
Read more about that under {:./design:**** Configuraton of item display}.
#tangle
@code lua
--- The main class for the ui configuration of neocomplete.nvim
---@class neocomplete.config.ui
--- The main class for the ui configuration of care.nvim
---@class care.config.ui
@end
The most important part for many users will be the `menu` field. It's used to configure the
completion menu.
#tangle
@code lua
--- Configuration of the completion menu of neocomplete.nvim
---@field menu neocomplete.config.ui.menu
--- Configuration of the completion menu of care.nvim
---@field menu care.config.ui.menu
@end

You can also configure the documentation view just like the main menu.
#tangle
@code lua
--- Configuration of the documentation view of neocomplete.nvim
---@field docs_view neocomplete.config.ui.docs
--- Configuration of the documentation view of care.nvim
---@field docs_view care.config.ui.docs
@end

Lastly the users can also configure the icons which will be used for the different items.
#tangle
@code lua
--- The icons for the different compltion item kinds
---@field type_icons neocomplete.config.ui.type_icons
---@field type_icons care.config.ui.type_icons
@end

** Ghost text
Expand All @@ -121,9 +121,9 @@ version: 1.1.1
#tangle
@code lua
--- Configuration of ghost text
---@field ghost_text neocomplete.config.ui.ghost_text
---@field ghost_text care.config.ui.ghost_text

---@class neocomplete.config.ui.ghost_text
---@class care.config.ui.ghost_text
---@field enabled boolean
---@field position "inline"|"overlay"
@end
Expand All @@ -132,8 +132,8 @@ version: 1.1.1
This configuration should allow you to completely adapt the completion menu to your likings.
#tangle
@code lua
--- Configuration of the completion menu of neocomplete.nvim
---@class neocomplete.config.ui.menu
--- Configuration of the completion menu of care.nvim
---@class care.config.ui.menu
@end

It includes some basic window properties like the border and the maximum height of the window. It
Expand Down Expand Up @@ -187,7 +187,7 @@ version: 1.1.1
#tangle
@code lua
--- How an entry should be formatted
---@field format_entry fun(entry: neocomplete.entry): { [1]: string, [2]: string }[][]
---@field format_entry fun(entry: care.entry): { [1]: string, [2]: string }[][]
--- How the sections in the menu should be aligned
---@field alignment ("left"|"center"|"right")[]
@end
Expand All @@ -196,8 +196,8 @@ version: 1.1.1
This configuration allows you to configure the documentation view.
#tangle
@code lua
--- Configuration of the completion menu of neocomplete.nvim
---@class neocomplete.config.ui.docs
--- Configuration of the completion menu of care.nvim
---@class care.config.ui.docs
@end
It consists of some basic window properties like the border and the maximum height of the window.
It also has a field to define the character used for the scrollbar.
Expand All @@ -218,5 +218,5 @@ version: 1.1.1
#tangle
@code lua
--- The icons used for the different completion item types
---@alias neocomplete.config.ui.type_icons table<string, string>
---@alias care.config.ui.type_icons table<string, string>
@end
16 changes: 8 additions & 8 deletions docs/context.norg
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ created: 2023-11-15T17:42:46+0100
updated: 2024-06-18T18:18:38+0100
tangle: {
languages: {
lua: ../lua/neocomplete/types/context.lua
lua: ../lua/care/types/context.lua
}
scope: tagged
delimiter: none
Expand All @@ -26,7 +26,7 @@ version: 1.1.1
#tangle
@code lua
--- Context provided to completion sources
---@class neocomplete.context
---@class care.context
@end

* Methods
Expand All @@ -36,7 +36,7 @@ version: 1.1.1
#tangle
@code lua
--- Context changed since previous
---@field changed fun(neocomplete.context): boolean
---@field changed fun(care.context): boolean
@end

** New
Expand All @@ -47,7 +47,7 @@ version: 1.1.1
#tangle
@code lua
--- Create a new context
---@field new fun(previous: neocomplete.context?): neocomplete.context
---@field new fun(previous: care.context?): care.context
@end

* Fields
Expand All @@ -56,15 +56,15 @@ version: 1.1.1
#tangle
@code lua
--- The previous context
---@field previous neocomplete.context?
---@field previous care.context?
@end

** Cursor
The cursor positon.
#tangle
@code lua
--- The cursor position
---@field cursor neocomplete.context.cursor
---@field cursor care.context.cursor
@end

** Bufnr
Expand All @@ -80,7 +80,7 @@ version: 1.1.1
#tangle
@code lua
--- Reason for triggering completion
---@field reason neocomplete.completionReason?
---@field reason care.completionReason?
@end

** Current line
Expand All @@ -103,7 +103,7 @@ version: 1.1.1
#tangle
@code lua
--- A cursor position
---@class neocomplete.context.cursor
---@class care.context.cursor
---@field row integer
---@field col integer
@end
Loading

0 comments on commit fe5d1e4

Please sign in to comment.