Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export ASPHALT_API_KEY=
43 changes: 43 additions & 0 deletions .github/commit-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# <type>(<scope>): <subject>
#
# <body>
#
# <footer>

# Type should be one of the following:
# * feat: a new feature
# * fix: a bug fix
# * docs: documentation only changes
# * style: changes that do not affect the meaning of the code
# * refactor: a code change that neither fixes a bug nor adds a feature
# * perf: a code change that improves performance
# * test: adding missing tests or correcting existing tests
# * build: changes that affect the build system or external dependencies
# * ci: changes to our ci configuration files and scripts
# * chore: other changes that don't modify src or test files
# * revert: reverts a previous commit
#
# Scope is optional, but should be one of the following:
# * assets: changes to assets (images, fonts, etc.)
# * audio: changes relating to sound or music
# * core: changes to the core game functionality
# * deps: changes to dependencies
# * dev: changes to the development environment
# * lint: changes that only affect linting such as auto-formatting
# * mtx: changes to monetization or in-game purchases
#
# Subject line rules:
# * Use imperative mood: "change" not "changed" nor "changes"
# * No dot (.) at the end
# * Limit to 72 characters
# * No capitilization in the subject aside from issue references
#
# Body rules:
# * Wrap at 72 characters
# * Use imperative mood
# * Explain what and why vs. how
#
# Footer rules:
# * Reference issues and pull requests liberally
# * Use "Fixes #123" or "Closes #123" for issues
# * Use "BREAKING CHANGE:" for breaking changes
15 changes: 1 addition & 14 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,15 @@ env:
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [20]

steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Install pnpm
uses: pnpm/action-setup@v3

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
with:
node-version: ${{ matrix.node-version }}
cache: pnpm
- uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2

- name: Install dependencies
run: pnpm install

- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2

- name: Lint
run: pnpm lint

Expand Down
18 changes: 5 additions & 13 deletions .github/workflows/release-development.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,19 @@ jobs:
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Install pnpm
uses: pnpm/action-setup@v3

- name: Use Node.js 20
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
with:
node-version: 20
cache: pnpm
- uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2

- name: Install dependencies
run: pnpm install
run: corepack pnpm install

- name: Install roblox-ts
run: pnpm add roblox-ts
run: corepack pnpm add roblox-ts

Comment thread
christopher-buss marked this conversation as resolved.
- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2

Comment on lines 37 to 39
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove Rokit step here as well.

To fully deprecate Rokit in development releases.

Apply this diff:

-      - name: Setup Rokit
-        uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2
🤖 Prompt for AI Agents
.github/workflows/release-development.yaml around lines 37 to 39: remove the
"Setup Rokit" job step (the uses: CompeyDev/setup-rokit@... line and its name)
from the workflow so Rokit is no longer invoked for development releases; ensure
you also remove any related step-level keys (name, uses) and fix surrounding
indentation/sequence so the remaining steps form a valid steps list.

- name: Compile
run: npx rbxtsc --verbose
run: nlx rbxtsc --verbose
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use pnpm exec instead of nlx.

nlx may not be present on the runner; pnpm exec is guaranteed after install.

Apply this diff:

-      - name: Compile
-        run: nlx rbxtsc --verbose
+      - name: Compile
+        run: corepack pnpm exec rbxtsc --verbose
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
run: nlx rbxtsc --verbose
- name: Compile
run: corepack pnpm exec rbxtsc --verbose
🤖 Prompt for AI Agents
.github/workflows/release-development.yaml around line 41: the workflow uses
"nlx rbxtsc --verbose" which may not exist on the runner; replace the nlx
invocation with "pnpm exec rbxtsc --verbose" so the command runs via pnpm's
guaranteed exec shim after dependencies are installed.


- name: Build project
run: rojo build ./default.project.json --output place.rbxlx
Expand All @@ -65,8 +58,7 @@ jobs:
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2
- uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2

- name: Download place artifact
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
Expand Down
21 changes: 5 additions & 16 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,16 @@ jobs:
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Install pnpm
uses: pnpm/action-setup@v3

- name: Use Node.js 20
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
with:
node-version: 20
cache: pnpm
- uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2

- name: Install dependencies
run: pnpm install
run: corepack pnpm install

- name: Install roblox-ts
run: pnpm add roblox-ts

- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2
run: corepack pnpm add roblox-ts

- name: Compile
run: pnpm prod:build --verbose
run: corepack pnpm prod:build --verbose

- name: Build project
run: rojo build ./build.project.json --output place.rbxlx
Expand All @@ -68,8 +58,7 @@ jobs:
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Setup Rokit
uses: CompeyDev/setup-rokit@d49be92bd9502180218c3f43e7988faa945217b0 # v0.1.2
- uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2

- name: Download place artifact
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
Expand Down
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ sourcemap.json
*.rbxl
*.rbxlx

# Bundled eslint config
*.mjs
.env

.env
.vscode/mise-tools/
2 changes: 1 addition & 1 deletion .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pnpm dlx commitlint --edit \
corepack pnpm dlx commitlint --edit "$1"
2 changes: 1 addition & 1 deletion .husky/post-merge
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
. "$(dirname "$0")/_/husky.sh"

# matches only the package-lock.json inside project directory
npx git-pull-run --pattern "pnpm-lock.yaml" --command "pnpm install"
npx git-pull-run --pattern "pnpm-lock.yaml" --command "corepack pnpm install"
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pnpm lint-staged
corepack pnpm lint-staged
3 changes: 2 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ enable-pre-post-scripts=true
ignore-workspace-root-check=true
save-exact=true
shell-emulator=true
strict-peer-dependencies=false
strict-peer-dependencies=false
public-hoist-pattern[]=*@rbxts*
13 changes: 12 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,16 @@
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
"npm.packageManager": "pnpm"
"npm.packageManager": "pnpm",

// Mise Tools settings
"debug.javascript.defaultRuntimeExecutable": {
"pwa-node": "${workspaceFolder}\\.vscode\\mise-tools\\node"
},

"github.copilot.chat.commitMessageGeneration.instructions": [
{
"file": ".github/commit-instructions.md"
}
]
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ alphabetical order):
- [Asphalt](https://github.com/jackTabsCode/asphalt)
- [Darklua](https://darklua.com/)
- [Mantle](https://mantledeploy.vercel.app/)
- [Mise](https://mise.jdx.dev/)
- [Rojo](https://rojo.space/)
- [Rokit](https://github.com/rojo-rbx/rokit)
- [rbxts-build](https://www.npmjs.com/package/rbxts-build)
- [roblox-ts](https://roblox-ts.com/)

Expand Down
11 changes: 11 additions & 0 deletions mise.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[env]
_.path = [ '{{config_root}}/node_modules/.bin' ]
_.file = { path = ".env", redact = true }

[tools]
"ubi:blake-mealey/mantle" = "0.11.17-prerelease"
"ubi:jacktabscode/asphalt" = "0.9.1"
"ubi:lune-org/lune" = "0.8.9"
"ubi:rojo-rbx/rojo" = "7.4.4"
"ubi:seaofvoices/darklua" = "0.14.0"
node = { version = "lts", postinstall = "corepack enable" }
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"rbxts-transform-env": "catalog:prod"
},
"devDependencies": {
"@antfu/ni": "catalog:dev",
"@commitlint/cli": "catalog:dev",
"@commitlint/config-conventional": "catalog:dev",
"@commitlint/prompt-cli": "catalog:dev",
Expand All @@ -82,7 +83,7 @@
"roblox-ts": "catalog:dev",
"typescript": "catalog:dev"
},
"packageManager": "pnpm@10.8.1",
"packageManager": "pnpm@10.15.1+sha512.34e538c329b5553014ca8e8f4535997f96180a1d0f614339357449935350d924e22f8614682191264ec33d1462ac21561aff97f6bb18065351c162c7e8f6de67",
"rbxts-build": {
"syncLocation": "src/types/services.d.ts",
"names": {
Expand Down
Loading