feat(web): share project actions via t3.json #4363
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import { describe, expect, it } from "vite-plus/test"; | ||
|
|
||
| import { upsertT3ProjectFileScript } from "./t3ProjectFileScripts"; | ||
|
|
||
| const script = { | ||
| id: "script-test", | ||
| name: "Test", | ||
| command: "vp test", | ||
| icon: "test" as const, | ||
| runOnWorktreeCreate: false, | ||
| autoOpenPreview: false, | ||
| }; | ||
|
|
||
| describe("upsertT3ProjectFileScript", () => { | ||
| it("creates a project file for the first shared action", () => { | ||
| const result = JSON.parse( | ||
| upsertT3ProjectFileScript({ | ||
| contents: null, | ||
| script, | ||
| }), | ||
| ); | ||
|
|
||
| expect(result).toEqual({ | ||
| $schema: "https://t3.codes/schema/t3.json", | ||
| scripts: [ | ||
| { | ||
| name: "Test", | ||
| command: "vp test", | ||
| icon: "test", | ||
| runOnWorktreeCreate: false, | ||
| }, | ||
| ], | ||
| }); | ||
| }); | ||
|
|
||
| it("appends an action while preserving existing project settings", () => { | ||
| const result = JSON.parse( | ||
| upsertT3ProjectFileScript({ | ||
| contents: JSON.stringify({ | ||
| $schema: "https://t3.codes/schema/t3.json", | ||
| iconPath: "assets/logo.svg", | ||
| futureSetting: { enabled: true }, | ||
| scripts: [{ name: "Dev", command: "vp dev" }], | ||
| }), | ||
| script, | ||
| }), | ||
| ); | ||
|
|
||
| expect(result.iconPath).toBe("assets/logo.svg"); | ||
| expect(result.futureSetting).toEqual({ enabled: true }); | ||
| expect(result.scripts).toEqual([ | ||
| { name: "Dev", command: "vp dev" }, | ||
| { | ||
| name: "Test", | ||
| command: "vp test", | ||
| icon: "test", | ||
| runOnWorktreeCreate: false, | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
| it("updates an edited shared action instead of duplicating it", () => { | ||
| const previousScript = { ...script, name: "Checks", command: "vp check" }; | ||
| const result = JSON.parse( | ||
| upsertT3ProjectFileScript({ | ||
| contents: JSON.stringify({ | ||
| scripts: [{ name: "Checks", command: "vp check" }], | ||
| }), | ||
| previousScript, | ||
| script, | ||
| }), | ||
| ); | ||
|
|
||
| expect(result.scripts).toHaveLength(1); | ||
| expect(result.scripts[0]).toMatchObject({ name: "Test", command: "vp test" }); | ||
| }); | ||
|
|
||
| it("rejects an invalid existing project file", () => { | ||
| expect(() => | ||
| upsertT3ProjectFileScript({ | ||
| contents: "{ invalid", | ||
| script, | ||
| }), | ||
| ).toThrow("t3.json is invalid"); | ||
| }); | ||
|
|
||
| it("does not exceed the shared action limit", () => { | ||
| expect(() => | ||
| upsertT3ProjectFileScript({ | ||
| contents: JSON.stringify({ | ||
| scripts: Array.from({ length: 50 }, (_, index) => ({ | ||
| name: `Action ${index}`, | ||
| command: `echo ${index}`, | ||
| })), | ||
| }), | ||
| script, | ||
| }), | ||
| ).toThrow("maximum of 50 shared actions"); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Share skips unread t3.json
High Severity
Sharing a project script can overwrite the
t3.jsonfile. This happens becausegetProjectFileQueryDatareturnsnullif the file read query is pending or failed.upsertT3ProjectFileScriptthen interprets thisnullas an empty file, leading to a new, minimalt3.jsonbeing written that discards existing shared actions and settings.Reviewed by Cursor Bugbot for commit d98df4f. Configure here.