You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-17Lines changed: 22 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ A build backend for installing [lua-language-server](https://github.com/LuaLS/lu
4
4
5
5
Its effects are as follows:
6
6
7
-
-Compile a "patch" that describes what settings will be added to LuaLS config files.
8
-
-paths can be customized
9
-
-Look for LuaLS config files in the project directory by default, prioritizing `./.luarc.json`, then looking for a `./.vscode/settings.json`, and defaulting to creating a new `.luarc.json` otherwise.
10
-
-can be customized
11
-
-If the `--no-install` option is given, processing stops here.
12
-
-Apply the "patch" into every discovered file. File entries may be overwritten
13
-
-Install any other assets (`library/` and `plugin.lua`)
7
+
- Compile a "patch" that describes what settings will be added to LuaLS config files.
8
+
- paths can be customized
9
+
- Look for LuaLS config files in the project directory by default, prioritizing `./.luarc.json`, then looking for a `./.vscode/settings.json`, and defaulting to creating a new `.luarc.json` otherwise.
10
+
- can be customized
11
+
- If the `--no-install` option is given, processing stops here.
12
+
- Apply the "patch" into every discovered file. File entries may be overwritten
13
+
- Install any other assets (`library/` and `plugin.lua`)
14
14
15
15
## Usage for End-Users
16
16
@@ -19,21 +19,21 @@ Its effects are as follows:
19
19
20
20
End-users can manage addon installations using the LuaRocks CLI.
21
21
22
-
-`luarocks install an-addon` - install `an-addon`
23
-
-`luarocks remove an-addon` - remove `an-addon`
24
-
-`luarocks show an-addon` - view information about `an-addon`
25
-
-etc.
22
+
-`luarocks install an-addon` - install `an-addon`
23
+
-`luarocks remove an-addon` - remove `an-addon`
24
+
-`luarocks show an-addon` - view information about `an-addon`
25
+
- etc.
26
26
27
27
Users can also browse addons online from https://luarocks.org/m/lls-addons.
28
28
29
29
### Variables
30
30
31
31
You can change the behavior of the installer by defining these variables in a `config-5.X.lua` file or on the command-line as `luarocks VAR=VALUE -- ...`. See the [config file format](https://github.com/luarocks/luarocks/blob/main/docs/config_file_format.md#variables) for more information.
32
32
33
-
-**LLSADDON_LUARCPATH** (`;`-separated paths) - a list of paths indicating which `.luarc.json`-style files to modify when installing the addon.
34
-
-**LLSADDON_VSCSETTINGSPATH** (`;`-separated paths) - a list of paths indicating which `.vscode/settings.json`-style files to modify when installing the addon. This is useful for creating VSCode settings files if they don't exist, since `.luarc.json` usually takes priority. Set this to `.vscode/settings.json` if you want this behavior.
35
-
-If at least one of the above variables is set to anything but the empty string, the installer will not look for default config locations. Set to `;` to prohibit modifying any config files.
36
-
-**LLSADDON_ABSPATH** (boolean) - If set to any value _other than_`false`, `no`, `off`, or `0`, any paths added to the config file will be absolute paths instead of relative ones.
33
+
-**LLSADDON_LUARCPATH** (`;`-separated paths) - a list of paths indicating which `.luarc.json`-style files to modify when installing the addon.
34
+
-**LLSADDON_VSCSETTINGSPATH** (`;`-separated paths) - a list of paths indicating which `.vscode/settings.json`-style files to modify when installing the addon. This is useful for creating VSCode settings files if they don't exist, since `.luarc.json` usually takes priority. Set this to `.vscode/settings.json` if you want this behavior.
35
+
- If at least one of the above variables is set to anything but the empty string, the installer will not look for default config locations. Set to `;` to prohibit modifying any config files.
36
+
-**LLSADDON_ABSPATH** (boolean) - If set to any value _other than_`false`, `no`, `off`, or `0`, any paths added to the config file will be absolute paths instead of relative ones.
37
37
38
38
## Usage for Addon Developers
39
39
@@ -43,7 +43,12 @@ Addon developers should use an addon file structure like this:
See the [Creating an Addon](https://luals.github.io/wiki/addons/#creating-an-addon) section for more information on the individual components.
@@ -61,7 +66,7 @@ Addons can be developed in a similar way to any other rock. Dependencies to othe
61
66
62
67
### Build Rules
63
68
64
-
-**build.settings** (table?) - May contain a key-value dictionary of [settings](https://luals.github.io/wiki/settings/) to be merged into the LuaLS configuration. The `config.json` file will be ignored if this entry exists.
69
+
-**build.settings** (table?) - May contain a key-value dictionary of [settings](https://luals.github.io/wiki/settings/) to be merged into the LuaLS configuration. The `config.json` file will be ignored if this entry exists.
0 commit comments