Skip to content

Commit 9679594

Browse files
committed
Add configuration value for what auto-require adds
Auto-require always adds the `require` function specifically. However, it's common in projects to have their own special `require` functions, like `import` or `include` -- so this PR adds a configuration option which lets you change what it imports.
1 parent 119355c commit 9679594

File tree

13 files changed

+81
-1
lines changed

13 files changed

+81
-1
lines changed

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* `FIX` Prevent class methods from triggering missing-fields diagnostics
99
* `ADD` missing locale
1010
* `FIX` updates the EmmyLuaCodeStyle submodule reference to a newer commit, ensuring compatibility with GCC 15
11+
* `NEW` Setting: `Lua.completion.requireFunction`: What the auto-require completion should add (e.g. `import` instead of `require`)
1112

1213
## 3.14.0
1314
`2025-4-7`

doc/en-us/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ string
148148
"@"
149149
```
150150

151+
# completion.requireFunction
152+
153+
The function to insert when an auto-require is triggered.
154+
155+
## type
156+
157+
```ts
158+
string
159+
```
160+
161+
## default
162+
163+
```jsonc
164+
"require"
165+
```
166+
151167
# completion.requireSeparator
152168

153169
The separator used when `require`.

doc/pt-br/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ string
148148
"@"
149149
```
150150

151+
# completion.requireFunction
152+
153+
The function to insert when an auto-require is triggered.
154+
155+
## type
156+
157+
```ts
158+
string
159+
```
160+
161+
## default
162+
163+
```jsonc
164+
"require"
165+
```
166+
151167
# completion.requireSeparator
152168

153169
The separator used when `require`.

doc/zh-cn/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ string
148148
"@"
149149
```
150150

151+
# completion.requireFunction
152+
153+
The function to insert when an auto-require is triggered.
154+
155+
## type
156+
157+
```ts
158+
string
159+
```
160+
161+
## default
162+
163+
```jsonc
164+
"require"
165+
```
166+
151167
# completion.requireSeparator
152168

153169
`require` 时使用的分隔符。

doc/zh-tw/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ string
148148
"@"
149149
```
150150

151+
# completion.requireFunction
152+
153+
The function to insert when an auto-require is triggered.
154+
155+
## type
156+
157+
```ts
158+
string
159+
```
160+
161+
## default
162+
163+
```jsonc
164+
"require"
165+
```
166+
151167
# completion.requireSeparator
152168

153169
`require` 時使用的分隔符。

locale/en-us/setting.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ config.completion.autoRequire =
180180
"When the input looks like a file name, automatically `require` this file."
181181
config.completion.showParams =
182182
"Display parameters in completion list. When the function has multiple definitions, they will be displayed separately."
183+
config.completion.requireFunction =
184+
"The function to insert when an auto-require is triggered."
183185
config.completion.requireSeparator =
184186
"The separator used when `require`."
185187
config.completion.postfix =

locale/es-419/setting.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,8 @@ config.completion.autoRequire =
182182
"Agrega automáticamente el `require` correspondiente cuando la entrada se parece a un nombre de archivo."
183183
config.completion.showParams =
184184
"Muestra los parámetros en la lista de completado. Cuando la función tiene múltiples definiciones, se mostrarán por separado."
185+
config.completion.requireFunction = -- TODO: need translate!
186+
"The function to insert when an auto-require is triggered."
185187
config.completion.requireSeparator =
186188
"Separador usado en `require`."
187189
config.completion.postfix =

locale/ja-jp/setting.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ config.completion.autoRequire = -- TODO: need translate!
180180
"When the input looks like a file name, automatically `require` this file."
181181
config.completion.showParams = -- TODO: need translate!
182182
"Display parameters in completion list. When the function has multiple definitions, they will be displayed separately."
183+
config.completion.requireFunction = -- TODO: need translate!
184+
"The function to insert when an auto-require is triggered."
183185
config.completion.requireSeparator = -- TODO: need translate!
184186
"The separator used when `require`."
185187
config.completion.postfix = -- TODO: need translate!

locale/pt-br/setting.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ config.completion.autoRequire = -- TODO: need translate!
180180
"When the input looks like a file name, automatically `require` this file."
181181
config.completion.showParams = -- TODO: need translate!
182182
"Display parameters in completion list. When the function has multiple definitions, they will be displayed separately."
183+
config.completion.requireFunction = -- TODO: need translate!
184+
"The function to insert when an auto-require is triggered."
183185
config.completion.requireSeparator = -- TODO: need translate!
184186
"The separator used when `require`."
185187
config.completion.postfix = -- TODO: need translate!

locale/zh-cn/setting.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,8 @@ config.completion.autoRequire =
179179
"输入内容看起来是个文件名时,自动 `require` 此文件。"
180180
config.completion.showParams =
181181
"在建议列表中显示函数的参数信息,函数拥有多个定义时会分开显示。"
182+
config.completion.requireFunction = -- TODO: need translate!
183+
"The function to insert when an auto-require is triggered."
182184
config.completion.requireSeparator =
183185
"`require` 时使用的分隔符。"
184186
config.completion.postfix =

0 commit comments

Comments
 (0)