Migrate from "Projects" to "Vals" (#119)

* Migrate to new sdk

* Change use of 'project' to 'val'

* Change capitalization

* Update readme

* Remove more 'project' references

* Fix remix tests

* Fix interactive clone test

* Remix without editor files

* Fix spelling case issue

* Fix remix tests

* Fix push test

* Fix casing for remixing

* Have tests inherit permissions

* Fix remix tests again

* Fix tests that required editor prompt

* Fix vt watch test

* Don't do concurrent cmd test

* Make watch simulation faster

* Improve watch test

* Add more grace

* Add a deadline to tests

* Continue using project on state for now, but inject vals

* Change how zod recasting works

* Slow down watch test

* Cap val listing count

* Reduce concurrency amount

* Fix list test

* Clean up modified files deadline method

* Add another deadline

* Provide multiple yeses

* Improve tests

* Make autoconfirmation more robust

* Increase deadline

* Slow down watch

* Add retry to test

* Fix uncaught writer close error

* Do concurrent test

* Change delays

* Make sequential again

* Fix modified test

* Load from .env before config json

* Allow listing all

* Fix checkout message spacing

* Fix checkout test

* Improve resource sanitization

* Format code

* Clean up code

* Restore disabling resource sanitization

* Increase timeout

* Make bearer checking more accurate

* Clean up tests

* Fix checkout test confirmation

* Remove weird catch

* Change casing of 'val'

* No more parallel cli tests

* Restore parallel tests

* Fix test workflow

* A --paralleldd schema migration test

* Tick version

* Don't do concurrent cmd test

Author: 404Wolf

.github/workflows/test.yaml

@@ -22,7 +22,7 @@ jobs:
       - name: Run deno tests
         uses: nick-fields/retry@v3
         with:
-          command: deno task test:lib --parallel
+          command: deno task test:lib
           max_attempts: 2
           timeout_seconds: 2000
         env:
@@ -44,7 +44,7 @@ jobs:
           max_attempts: 2
           timeout_seconds: 2000
         env:
-          VAL_TOWN_API_KEY: ${{ secrets.VAL_TOWN_API_KEY }}
+          VAL_TOWN_API_KEY: ${{ secrets.VAL_TOWN_API_KEY_2 }}
 
   test-publish:
     runs-on: ubuntu-latest

README.md

@@ -1,13 +1,10 @@
 # Val Town CLI
 
-`vt` is the official CLI to work with projects on the
-[Val Town](https://val.town) platform.
-
-![Vt in action!](https://wolf-imagedumper.web.val.run/blob/blob_file_1744915159083_recording.gif)
+VT is a cli to work with Vals in the [Val Town](https://val.town) platform.
 
 ```
 Usage:   vt    
-Version: x.x.xx
+Version:x0.x.xx
 
 Options:
 
@@ -16,19 +13,19 @@ Options:
 
 Commands:
 
-  clone     [projectUri] [targetDir] [branchName]          - Clone a val town project                              
-  push                                                     - Push local changes to a val town project              
-  pull                                                     - Pull the latest changes for a val town project        
-  status                                                   - Show the working tree status                          
-  branch                                                   - List or delete branches                               
-  checkout  [existingBranchName]                           - Check out a different branch                          
-  watch                                                    - Watch for changes and automatically sync with Val Town
-  browse                                                   - Open a project in a web browser                       
-  create    <projectName> [targetDir]                      - Create a new Val Town project                         
-  remix     <fromProjectUri> [newProjectName] [targetDir]  - Remix a Val Town project                              
-  config                                                   - Manage vt configuration                               
-  delete                                                   - Delete a Val Town project                             
-  list                                                     - List all your Val Town projects
+  clone     [valUri] [targetDir] [branchName]      - Clone a Val                                           
+  push                                             - Push local changes to a Val                           
+  pull                                             - Pull the latest changes for the current Val           
+  status                                           - Show the working tree status                          
+  branch                                           - List or delete branches                               
+  checkout  [existingBranchName]                   - Check out a different branch                          
+  watch                                            - Watch for changes and automatically sync with Val Town
+  browse                                           - Open a Val's main page in a web browser               
+  create    <valName> [targetDir]                  - Create a new Val                                      
+  remix     <fromValUri> [newValName] [targetDir]  - Remix a Val                                           
+  config                                           - Manage vt configuration                               
+  delete                                           - Delete the current Val                                
+  list                                             - List all your Vals
 ```
 
 ## Installation
@@ -50,10 +47,10 @@ To authenticate with `val.town`, just run `vt`, and you should get the dialog
 ```
 Welcome to the Val Town CLI!
 
-  VT is a companion CLI to interface with Val Town projects.
+  VT is a companion CLI to interface with Val Town vals.
 
   With this CLI, you can:
-  - Create and manage Val Town projects
+  - Create and manage Val Town vals
   - Push and pull changes between your local system and Val Town
   - Watch a directory to keep it automatically synced with Val Town
   - And more!
@@ -63,12 +60,12 @@ Welcome to the Val Town CLI!
 ? Would you like to open val.town/settings/api in a browser to get an API key? (y/n) ›
 ```
 
-Respond yes, and ensure you select to create an API key with user read & project
+Respond yes, and ensure you select to create an API key with user read & val
 read+write permissions.
 
 Alternatively, you can set the `VAL_TOWN_API_KEY` environment variable to
 authenticate. Either as an environment variable, or place it in a .env in your
-project.
+val.
 
 Now you can run `vt` again to confirm everything is working:
 
@@ -83,24 +80,24 @@ vt x.x.xx
 Let's walk through a complete workflow to get you familiar with the Val Town
 CLI.
 
-First, let's remix a nice starting project.
+First, let's remix a nice starting val.
 
 ```bash
 $ vt remix std/reactHonoStarter myNewWebsite
 
-√ Remixed "@std/reactHonoStarter" to public project "@you/myNewWebsite"
+√ Remixed "@std/reactHonoStarter" to public Val "@you/myNewWebsite"
 
 $ cd myNewWebsite
 ```
 
-![Your new project!](https://wolf-imagedumper.web.val.run/blob/blob_file_1744521935175_7f04c371-d619-4062-8bc6-941d56a23eed.png)
+![Your new val!](https://wolf-imagedumper.web.val.run/blob/blob_file_1744521935175_7f04c371-d619-4062-8bc6-941d56a23eed.png)
 
-Alternatively, you can use `vt create` to create a new empty project. If you
-don't specify a path, the name of the project will automatically be used.
+Alternatively, you can use `vt create` to create a new empty val. If you don't
+specify a path, the name of the Val will automatically be used.
 
-When you `remix`, `create`, or `clone` a project, `vt` creates a `.vt` that
-tracks your project metadata. You can think of this like `.git`, it is not meant
-to be manually edited and is used for internal bookkeeping.
+When you `remix`, `create`, or `clone` a val, `vt` creates a `.vt` that tracks
+your Val metadata. You can think of this like `.git`, it is not meant to be
+manually edited and is used for internal bookkeeping.
 
 `vt` also creates an ignore file, `.vtignore`, which works like `.gitignore`,
 and a `deno.json`. By having a `deno.json`, your editor will be able to make use
@@ -112,17 +109,17 @@ If you use some other editor, you'll want to head over to
 [Deno's editor set up](https://docs.deno.com/runtime/getting_started/setup_your_environment/)
 guide and find how to configure yours.
 
-If you use packages in your project, your editor may warn you that you do not
-have those packages installed (or "cached"). Occasionally you'll want to run
-`deno cache .` to make sure that all the libraries you use in your Val Town
-project are installed locally.
+If you use packages in your val, your editor may warn you that you do not have
+those packages installed (or "cached"). Occasionally you'll want to run
+`deno cache .` to make sure that all the libraries you use in your Val Town val
+are installed locally.
 
 ![Making changes](https://wolf-imagedumper.web.val.run/blob/blob_file_1744522002151_95d9436e-9e8b-4361-880f-bf6d7e970741.png)
 
-Let's start editing our project! Fire up your favorite editor, and then make a
+Let's start editing our val! Fire up your favorite editor, and then make a
 change to `README.md`.
 
-Now, let's upload this file to your project with `vt push`
+Now, let's upload this file to your Val with `vt push`
 
 ```bash
 Pushed:
@@ -152,7 +149,7 @@ until you run `vt push`. If you don't want this behavior, then you can delete
 them and add `deno.json` and `.vtignore` to the `.vtignore`(the `.vtignore` will
 respect itself being ignored!).
 
-![Browse the project on the website](https://wolf-imagedumper.web.val.run/blob/blob_file_1744522722640_recording.gif)
+![Browse the Val on the website](https://wolf-imagedumper.web.val.run/blob/blob_file_1744522722640_recording.gif)
 
 Now run `vt browse` to see your file in the Val Town website UI. We advise you
 use `vt` in conjunction with the Val Town website. The CLI can do a lot, but not
@@ -182,7 +179,7 @@ Changes pushed:
 √ Successfully pushed local changes
 ```
 
-Now, if we return to our browser we can see that an http val has been created.
+Now, if we return to our browser we can see that an http Val has been created.
 It's erroring, let's fix that. Write a simple handler to the file:
 
 ```ts
@@ -210,16 +207,15 @@ Oftentimes you'll end up in a workflow that looks like
 4. Repeat
 
 `vt`'s solution to tightening this loop is `vt watch`. With `vt watch`, `vt`
-will automatically run `vt push` when any project files are modified
-**locally**.
+will automatically run `vt push` when any Val files are modified **locally**.
 
 To get automatic website reloading, check out
 [this live reload middleware](https://www.val.town/x/stevekrouse/live-reload)
 that works by polling Val Town for updates.
 
 ### Branching Out
 
-One common Val Town project workflow is branching out. `vt`'s `checkout` and
+One common Val Town Val workflow is branching out. `vt`'s `checkout` and
 `branch` command work the same as `git`'s.
 
 - `vt checkout <branchName>` checks out the branch as it is on Val Town. You
@@ -234,8 +230,8 @@ One common Val Town project workflow is branching out. `vt`'s `checkout` and
 
 ### Management
 
-- `vt list` lists all your Val Town projects
-- `vt delete` deletes the current project of the folder you are in (with
+- `vt list` lists all your Val Town vals
+- `vt delete` deletes the current Val of the folder you are in (with
   confirmation).
 
 ## Configuration
@@ -244,18 +240,18 @@ One common Val Town project workflow is branching out. `vt`'s `checkout` and
 `<System Configuration Directory>/vt/config.yaml`. Right now, this file only
 stores your `config.yaml`, and some experimental options.
 
-This config can also be overridden locally for specific projects by, when you
-are in a `.vt` directory, using `vt config set [-g for global]` (otherwise the
-global config is modified). This can be useful if someone shares an API key with
-you so you can collaborate on a project. You can view all configuration options
-with `vt config`, and all the ones you've set with `vt config get`.
+This config can also be overridden locally for specific vals by, when you are in
+a `.vt` directory, using `vt config set [-g for global]` (otherwise the global
+config is modified). This can be useful if someone shares an API key with you so
+you can collaborate on a val. You can view all configuration options with
+`vt config`, and all the ones you've set with `vt config get`.
 
 Right now, we offer the following configuration options:
 
 - `dangerousOperations.confirmation`: Whether to do confirmations on actions
   that might cause you to lose local state, like `vt pull`.
-- `editorTemplate`: The project URI for the editor files that you are prompted
-  about when you run a `vt clone`, `vt remix`, or `vt create`.
+- `editorTemplate`: The Val URI for the editor files that you are prompted about
+  when you run a `vt clone`, `vt remix`, or `vt create`.
 
 ## LLMs
 

deno.json

@@ -2,14 +2,14 @@
   "$schema": "https://raw.githubusercontent.com/denoland/deno/348900b8b79f4a434cab4c74b3bc8d4d2fa8ee74/cli/schemas/config-file.v1.json",
   "name": "@valtown/vt",
   "description": "The Val Town CLI",
-  "version": "0.1.24",
+  "version": "0.1.25",
   "exports": "./vt.ts",
   "license": "MIT",
   "tasks": {
     "run": "./vt.ts",
-    "test": "deno task test:lib --parallel && deno task test:cmd",
-    "test:cmd": "env DENO_NO_PROMPT=1 deno test -A ./src/cmd",
-    "test:lib": "env DENO_NO_PROMPT=1 deno test -A ./src/vt/lib",
+    "test": "deno task test:lib && deno task test:cmd",
+    "test:cmd": "env DENO_NO_PROMPT=1 deno test -A --trace-leaks --fail-fast ./src/cmd",
+    "test:lib": "env DENO_NO_PROMPT=1 deno test -A --trace-leaks --parallel ./src/vt/lib",
     "check": "env DENO_NO_PROMPT=1 deno check .",
     "fmt:check": "env DENO_NO_PROMPT=1 deno fmt --check"
   },
@@ -31,7 +31,7 @@
     "@std/encoding": "jsr:@std/encoding@^1.0.7",
     "@std/fs": "jsr:@std/fs@^1.0.13",
     "@std/path": "jsr:@std/path@^1.0.8",
-    "@valtown/sdk": "jsr:@valtown/sdk@^0.38.0",
+    "@valtown/sdk": "jsr:@valtown/sdk@^1.0.0",
     "xdg-portable": "jsr:@404wolf/xdg-portable@^0.1.0",
     "highlight.js": "npm:highlight.js@^11.11.1",
     "strip-ansi": "npm:strip-ansi@^7.1.0",

deno.lock

@@ -22,15 +22,15 @@ function welcomeToVt(): void {
 
   console.log(wrap(
     colors.bold("VT") +
-      " is a companion CLI to interface with Val Town projects.",
+      " is a companion CLI to interface with Val Town vals.",
     { width: DEFAULT_WRAP_WIDTH },
   ));
   console.log();
 
   console.log(wrap("With this CLI, you can:", { width: DEFAULT_WRAP_WIDTH }));
 
   [
-    "Create and manage Val Town projects",
+    "Create and manage Val Town vals",
     "Push and pull changes between your local system and Val Town",
     "Watch a directory to keep it automatically synced with Val Town",
     "And more!",
@@ -68,15 +68,15 @@ export async function onboardFlow(
   });
 
   if (goToWebsite) {
-    console.log("Ensure you select user read & project read+write permissions");
+    console.log("Ensure you select user read & Val read+write permissions");
     await delay(500);
     await open(GET_API_KEY_URL);
     console.log(`Browser opened to ${GET_API_KEY_URL}`);
   } else {
     console.log();
     console.log(
       "You can get an API key at " + GET_API_KEY_URL +
-        " with project read/write permissions",
+        " with Val read/write permissions",
     );
   }
 

src/cmd/flows/onboard.ts

@@ -11,9 +11,9 @@ async function listBranches(vt: VTClient) {
   return await doWithSpinner("Loading branches...", async (spinner) => {
     const meta = await vt.getMeta().loadVtState();
 
-    const branches: ValTown.Projects.BranchListResponse[] = [];
+    const branches: ValTown.Vals.BranchListResponse[] = [];
     // deno-fmt-ignore
-    for await (const file of (await sdk.projects.branches.list(meta.project.id, {}))) branches.push(file);
+    for await (const file of (await sdk.vals.branches.list(meta.val.id, {}))) branches.push(file);
 
     const formatter = new Intl.DateTimeFormat("en-US", {
       year: "numeric",
@@ -67,7 +67,7 @@ async function deleteBranch(vt: VTClient, toDeleteName: string) {
 
   await doWithSpinner("Deleting branch...", async (spinner) => {
     const toDeleteBranch = await branchNameToBranch(
-      meta.project.id,
+      meta.val.id,
       toDeleteName,
     );
     if (toDeleteBranch.id === meta.branch.id) {
@@ -76,7 +76,7 @@ async function deleteBranch(vt: VTClient, toDeleteName: string) {
       );
     }
 
-    await sdk.projects.branches.delete(meta.project.id, toDeleteBranch.id);
+    await sdk.vals.branches.delete(meta.val.id, toDeleteBranch.id);
     spinner.succeed(`Branch '${toDeleteName}' has been deleted.`);
   });
 }

src/cmd/lib/branch.ts

@@ -8,22 +8,22 @@ import { delay } from "@std/async";
 
 export const browseCmd = new Command()
   .name("browse")
-  .description("Open a project in a web browser")
+  .description("Open a Val's main page in a web browser")
   .option("--no-browser", "Print destination url instead of opening browser")
   .action(async ({ browser }: { browser?: boolean }) => {
     const vt = VTClient.from(await findVtRoot(Deno.cwd()));
 
-    const state = await vt.getMeta().loadVtState();
-    const branch = await sdk.projects.branches.retrieve(
-      state.project.id,
-      state.branch.id,
+    const vtState = await vt.getMeta().loadVtState();
+    const branch = await sdk.vals.branches.retrieve(
+      vtState.val.id,
+      vtState.branch.id,
     );
 
     if (browser) {
-      await doWithSpinner("Opening project url...", async (spinner) => {
+      await doWithSpinner("Opening Val url...", async (spinner) => {
         await open(branch.links.html);
         await delay(150);
-        spinner.succeed(`Project url opened in browser:\n${branch.links.html}`);
+        spinner.succeed(`Val url opened in browser:\n${branch.links.html}`);
       });
     } else console.log(`${branch.links.html}`);
   });