luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-05-04 10:43:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

Enforced relative path formatting

Browse source
This commit is contained in:
menarulalam 2023-11-14 15:04:39 -08:00 • committed by GitHub
parent f83470d97b
commit 87d367d68b
Signed by: DevComp
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/require-by-string-relative-paths.md
View file

@ -48,10 +48,6 @@ Modules can be required relative to the requiring file's location in the filesys
If we are trying to require a module called `MyModule.luau` in `C:/MyLibrary`: If we are trying to require a module called `MyModule.luau` in `C:/MyLibrary`:
```lua ```lua
-- From C:/MyLibrary/SomeModule.luau
local MyModule = require("MyModule")
-- Same as above, identical behavior
local MyModule = require("./MyModule") local MyModule = require("./MyModule")
-- From C:/MyLibrary/SubDirectory/SubModule.luau -- From C:/MyLibrary/SubDirectory/SubModule.luau
@ -61,7 +57,7 @@ local MyModule = require("../MyModule")
local MyModule = require("../MyLibrary/MyModule") local MyModule = require("../MyLibrary/MyModule")
``` ```
Relative paths can begin with `./` or `../`, which denote the directory of the requiring file and its parent directory, respectively. When a relative path does begin with one of these prefixes, it will only be resolved relative to the requiring file. If these prefixes are not provided, path resolution will fallback to checking the paths in the `paths` configuration variable, as described later. Relative paths must begin with `./` or `../`, which denote the directory of the requiring file and its parent directory, respectively. When a relative path does begin with one of these prefixes, it will only be resolved relative to the requiring file. If these prefixes are not provided, path resolution will fallback to checking the paths in the `paths` configuration variable, as described later.
When a require statement is executed directly in a REPL input prompt (not in a file), relative paths will be evaluated in relation to the pseudo-file `stdin`, located in the current working directory. If the code being executed is not tied to a file (e.g. using `loadstring`), executing any require statements in this code will result in an error. When a require statement is executed directly in a REPL input prompt (not in a file), relative paths will be evaluated in relation to the pseudo-file `stdin`, located in the current working directory. If the code being executed is not tied to a file (e.g. using `loadstring`), executing any require statements in this code will result in an error.