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

Changed use of .luaurc to luauconfig.json

Browse source
This commit is contained in:
Brad Sharp 2022-02-11 13:39:25 +00:00 • committed by GitHub
parent 4bac2c82de
commit 8a9a2ac08d
Signed by: DevComp
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
rfcs/libraries.md
View file

@ -49,7 +49,7 @@ All relative paths will start with either `./` or `../` which denote the direc
Aliases can be used to bind an absolute or relative path to a convenient name that can be required directly. They are always prefixed with `$` to make it obvious they are not the same as a regular path.
Each library has its own map which will be stored in the `.luaurc` file. Since libraries can be embedded inside of one another, any aliases which are not overriden will be inherited from the parent library.
Each library has its own map which will be stored in a `luauconfig.json` file. Since libraries can be embedded inside of one another, any aliases which are not overriden will be inherited from the parent library.
```json
"Aliases": {
@ -113,11 +113,27 @@ Luau libraries are not compatible with existing Lua libraries. This is because L
- Libraries are fully compatible with the Roblox engine as string-syntax is unsupported.
- Compatibility with existing Luau is TBD.
### luauconfig.json
As part of this proposal we will introduce a new `luauconfig.json` file. Initially, this file will only include library configuration data but in the future could be expanded to contain more.
The proposed structure for this file is:
```json
{
"aliases": {
"alias": "./path/of/alias"
}
}
```
Where a field is missing from `luauconfig.json` it will be taken from the parent library (if one exists).
### Defining a Library
Any directory containing a `.luaurc` file is considered a library.
Any directory containing a `luauconfig.json` file is considered a library.
Since we don't support `.luaurc` files in the DataModel we will introduce a new `Library` instance which contains the alias map and other properties.
Since we don't support `.json` files in the DataModel we will introduce a new `Library` instance which contains the alias map and other properties.
## Drawbacks