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

Undid @ for paths

Browse source
This commit is contained in:
Menarul Alam 2023-12-11 09:34:08 -08:00
parent 82906ea178
commit b61371760f
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/require-by-string-aliases.md
View file

@ -34,7 +34,7 @@ Or even a sub-module:
local createElement = require("@Roact/createElement")
```
Aliases are overrides. Whenever the first component of a path exactly matches a pre-defined alias, it will be replaced before the path is resolved to a file. Alias names are also restricted to the charset `[A-Za-z0-9.\-_]`. We restrict the charset and make them case insensitive because we envision alias names to be primarily used as package names, which tend to be case insensitive and alphanumeric. They also must be preceded with an `@` symbol.
Aliases are overrides. Whenever the first component of a path exactly matches a pre-defined alias, it will be replaced before the path is resolved to a file. Alias names are also restricted to the charset `[A-Za-z0-9.\-_]`. We restrict the charset and make them case insensitive because we envision alias names to be primarily used as package names, which tend to be case insensitive and alphanumeric. They also must be preceded by an `@` symbol.
### Package management
@ -131,7 +131,7 @@ If `.luaurc` contained the following `paths` array:
Then, `module.luau` could simply require `dependency.luau` like this:
```lua
local dependency = require("@dependency")
local dependency = require("dependency")
-- Instead of: require("../dependencies/dependency")
```