Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 0
chore: add AGENTS.md, drop dead JavaScript-era files#4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,4 @@ | ||
| /.* | ||
| !/.gitignore | ||
| !/.eslintrc.json | ||
| !/.github/ | ||
| /bower_components/ | ||
| /node_modules/ | ||
| /output/ | ||
| package-lock.json |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # AGENTS.md | ||
| A PureScript→Lua FFI fork in the [`purescript-lua`](https://github.com/Unisay/purescript-lua) package set. Generated code targets **Lua 5.1**. | ||
| ## Commands | ||
| All commands run inside the nix dev shell: | ||
| - Build: `nix develop -c ./scripts/build` | ||
| - Test (only if the fork has `scripts/test`): `nix develop -c bash ./scripts/test` | ||
| - Lint: `nix develop -c luacheck --quiet --std lua51 --no-unused-args src/` | ||
| ## Lua 5.1 target | ||
| The output runs on Lua 5.1, which is stricter than 5.3: | ||
| - No `table.unpack`, `bit32`, `utf8`, or the `//` operator. `math.pow` and `math.atan2` do exist. | ||
| - Array-style tables are 1-indexed: the first element is `t[1]`, not `t[0]`. | ||
| - `unit` is `{}`, never `nil`: a `nil` table element silently disappears, which would collapse `Array Unit` into an empty table. | ||
| - Lua 5.1 mangles some Lua 5.3 string escapes, so keep FFI string escapes 5.1-safe. | ||
| ## FFI files (under `src/`) | ||
| pslua's foreign-file parser needs every exported value wrapped in parentheses: | ||
| ```lua | ||
| return { | ||
| identity = (function(x) return x end), | ||
| answer = (42), | ||
| } | ||
| ``` | ||
| A bare `function … end` or an unparenthesised expression fails to parse. | ||
| ## Toolchain | ||
| `flake.nix` pins everything through [`purescript-overlay`](https://github.com/thomashoneyman/purescript-overlay): purs 0.15.16 (`purs-bin.purs-0_15_16`), spago 0.21.0 (`spago-bin.spago-0_21_0`), Lua 5.1 (`lua51Packages`). The `pslua` input tracks `github:Unisay/purescript-lua`; keep `flake.lock` reasonably current, since a long-stale pslua pin won't create the `--lua-output-file` directory and CI fails. | ||
| ## Releasing | ||
| Tag-driven, with no GitHub Release or changelog entry. The full conventions live in the [package-set repo](https://github.com/Unisay/purescript-lua-package-sets/blob/master/CONTRIBUTING.md): push an annotated tag on `master`, bump this fork's `version` in the package set's `src/packages.dhall`, refresh `latest-compatible-sets.json`, and push a `psc-*` set tag. | ||
| ## Decisions | ||
| Cross-cutting decisions are recorded as ADRs in the [package-set repo](https://github.com/Unisay/purescript-lua-package-sets/tree/master/docs/adr). Read them before a decision that affects the set, and add one after making such a decision. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @AGENTS.md |
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.