@tilua-types/roblox 1.0.0

package/README.md

@@ -0,0 +1,60 @@
+# @tilua-types/roblox
+
+Luau and the whole Roblox API as tilua types: every class (921 of them), enum
+(633), data type, service and global, plus what Luau adds to Lua — `typeof`,
+`buffer`, `bit32`, `utf8`, `table.create`, `string.split`, `math.clamp`, ...
+
+Luau is Roblox's language, so the two ship together. Underneath is
+[`@tilua-types/lua`](../lua), the Lua 5.1 standard library, which this depends
+on and is loaded along with it — so this is the only package a Roblox project
+installs.
+
+```bash
+npm i -D @tilua-types/roblox
+```
+
+```json
+{ "types": ["roblox"], "paths": {}, "sourceMap": "sourcemap.json" }
+```
+
+With `sourceMap` pointing at a Rojo sourcemap (`rojo sourcemap -o sourcemap.json`),
+`game`, `workspace` and each file's `script` are typed from the real instance
+tree, down to `script.Parent`.
+
+## What you get
+
+- **Classes with Roblox's own hierarchy.** Every type is a nominal
+  `declare class` (`Part extends FormFactorPart extends BasePart ...`). A
+  `Part` passes wherever a `BasePart` or `Instance` is expected, but a
+  `Folder` does not pass as a `Part`, and a table never passes as an
+  `Instance`. `typeof(instance)` is `"Instance"`.
+- **Events with typed arguments.** In `Players.PlayerAdded:Connect(function(player) ... end)`,
+  `player` is a `Player`. Callbacks assigned to a property, such as
+  `remote.OnServerInvoke = function(player, ...)`, are typed the same way.
+- **Enums.** `Enum.KeyCode.E` is an `Enum.KeyCode`, `Enum.Material` works as
+  a type, and one enum's items do not pass as another's.
+- **Data types with their operators.** `Vector3 + Vector3`, `CFrame * Vector3`
+  and `2 * vector` get their types from the declared metamethods.
+- **Names checked against the API.** `game:GetService("Players")`,
+  `inst:IsA("BasePart")` (which also narrows), `Instance.new("Part")` and
+  `FindFirstChildOfClass("Humanoid")` all return the class they name, and a
+  misspelt name is an error.
+
+Deprecated members are left out. Deprecated globals such as `wait` and
+`spawn` stay.
+
+## Where it comes from
+
+`index.d.tilua` is generated. Don't edit it by hand; change
+`scripts/generate-roblox.mjs` instead — or `scripts/luau.d.tilua`, the
+hand-written Luau layer the generator copies into the head of the file. The generator converts the definitions
+[luau-lsp](https://github.com/JohnnyMorganz/luau-lsp) builds from the Roblox
+API dump, at a pinned commit, into tilua syntax. To pick up a newer API:
+
+```bash
+npm run generate:roblox                                      # the pinned commit
+node scripts/generate-roblox.mjs --commit <luau-lsp commit>  # a newer one
+```
+
+luau-lsp is MIT licensed. Its notice is in
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,30 @@
+# Third-party notices
+
+`index.d.tilua` is generated from the Roblox definitions in
+[luau-lsp](https://github.com/JohnnyMorganz/luau-lsp)
+(`scripts/globalTypes.d.luau`), converted to tilua syntax by
+`scripts/generate-roblox.mjs` in the tilua-types repository.
+
+## luau-lsp
+
+MIT License
+
+Copyright (c) 2022 JohnnyMorganz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.