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

Add a description of abstract module paths per feedback from @vrn-sn.

Browse source
This commit is contained in:
Andy Friesen 2025-03-27 15:24:41 -07:00
parent 3bacc99acb
commit 74cd1a76a7
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/adjust-meaning-of-init-dot-luau.md → docs/abstract-module-paths-and-init-dot-luau.md
View file

@ -1,4 +1,4 @@
# Adjust the meaning of `init.luau` # Abstract module paths and `init.luau`
## Summary ## Summary
@ -65,9 +65,27 @@ project, we would like to rectify this.
## Design ## Design
Luau will no longer consider relative requires from a package `init.luau` file First, we introduce a new abstraction: a _module path_. Module paths refer
to resolve relative to the script itself. It will instead resolve relative to the either to _modules_ or _directories_.
script's parent, i.e. the folder containing the module.
For the purposes of navigation, both modules and directories are functionally
identical: modules and directories can both have children, which could
themselves be modules or directories, and both types can have at most one
parent, which could also be either a module or a directory.
The thing that separates a module from a directory is precisely that modules
represent source code that can be imported via the `require()` function.
Directories, by contrast, are merely organizational units.
The central feature of this RFC is about how module paths correspond to
filesystem paths: A module path refers to a module if it corresponds either to a
`.luau` file or to a directory that contains a file named `init.luau`. A module
path refers to a directory if it refers to a filesystem directory that lacks an
`init.luau` file.
More concretely, Luau will no longer consider relative requires from a package
`init.luau` file to resolve relative to the script itself. It will instead
resolve relative to the script's parent, i.e. the folder containing the module.
Secondly, we recognize an unfortunate side effect of this change: code within Secondly, we recognize an unfortunate side effect of this change: code within
`package/init.luau` is forced to write `require('./package/dependency')` when it `package/init.luau` is forced to write `require('./package/dependency')` when it
@ -75,7 +93,7 @@ specifically wants to carry out the ordinary task of importing a subordinate
module. module.
We propose to alleviate this with a special import alias `@self` that resolves We propose to alleviate this with a special import alias `@self` that resolves
to the current module. to the path to the current module.
```lua ```lua
-- package/init.luau -- package/init.luau