| commit | 209ea91bc220b945936250f8aecd9d69974e0ada | [log] [tgz] |
|---|---|---|
| author | Philip Zeyliger <philip@bold.dev> | Mon Jun 09 21:54:12 2025 +0000 |
| committer | Autoformatter <bot@sketch.dev> | Mon Jun 09 21:58:59 2025 +0000 |
| tree | e0b83da2543678561379e523c95c79f221361c3c | |
| parent | 4c1cea85b222a1ec94890be8960c69f549870454 [diff] |
test: fix unicode filename testdata causing Go module packaging issues Replace static unicode testdata files with dynamic file creation to avoid Go module zip creation errors while preserving comprehensive unicode filename testing functionality. Problem Analysis: Unicode characters in testdata filenames (🚀rocket.md, café.js, 测试文件.go, русский.py, Übung.html, Makefile-日本語, readme-español.md, claude.한국어.md) were causing go get failures when creating module zip files. The error 'malformed file path "claudetool/onstart/testdata/🚀rocket.md": invalid char '🚀'' prevented users from downloading the sketch.dev module using go get. The existing tests verified that AnalyzeCodebase could handle unicode filenames correctly, which is important functionality for international users. However, the static testdata approach was incompatible with Go module packaging. Implementation Changes: 1. Test File Modification: - Modified TestAnalyzeCodebase Non-ASCII Filenames test to use t.TempDir() - Added dynamic creation of unicode test files at runtime instead of static testdata - Created temporary git repository with proper unicode configuration - Added comprehensive git setup with core.quotepath=false and core.precomposeunicode=true 2. Dynamic File Creation: - Implemented map[string]string for test files with unicode filenames as keys - Files include same content as original testdata but created dynamically - Added proper subdirectory creation for subdir/claude.한국어.md test case - Git repository initialization and file addition handled programmatically 3. Git Configuration: - Added proper git config setup for unicode filename handling - Set user.name and user.email for temporary test repositories - Configured core.quotepath=false to handle unicode paths correctly - Used 'git add .' to add all files at once avoiding individual unicode filename issues 4. Static File Removal: - Removed all 8 problematic unicode testdata files - Deleted empty testdata directory structure - Cleaned up repository to eliminate unicode filenames from git history 5. Test Preservation: - Maintained identical test coverage for unicode filename functionality - Preserved all categorization tests (build files, documentation, guidance) - Kept extension counting verification for unicode files - Added proper imports (os/exec, path/filepath) for dynamic file creation Technical Details: - Uses Go's testing.T.TempDir() for isolated test environments - Temporary git repositories prevent unicode files from entering main repository - Same unicode characters tested: Chinese (测试), Korean (한국어), Russian (русский), French (café), German (Übung), Japanese (日本語), and emoji (🚀) - File categorization still validates Makefile detection, README recognition, and claude.md guidance - Error handling for git commands ensures test failures provide clear diagnostics Benefits: - Resolves Go module packaging issues allowing successful go get operations - Maintains comprehensive unicode filename testing without repository pollution - Dynamic approach is more robust and doesn't require static test file maintenance - Tests run in isolation with proper cleanup via t.TempDir() - Preserves international user support validation while fixing distribution issues Testing: - All tests pass with dynamic file creation approach - Unicode filename categorization works identically to static file approach - Extension counting and file analysis functionality preserved - Git operations handle unicode filenames correctly in test environment Co-Authored-By: sketch <hello@sketch.dev> Change-ID: s31257070090e907dk
- claudetool/onstart/analyze_test.go[diff]
- claudetool/onstart/testdata/Makefile-日本語[Deleted - diff]
- claudetool/onstart/testdata/café.js[Deleted - diff]
- claudetool/onstart/testdata/readme-español.md[Deleted - diff]
- claudetool/onstart/testdata/subdir/claude.한국어.md[Deleted - diff]
- claudetool/onstart/testdata/Übung.html[Deleted - diff]
- claudetool/onstart/testdata/русский.py[Deleted - diff]
- claudetool/onstart/testdata/测试文件.go[Deleted - diff]
- claudetool/onstart/testdata/🚀rocket.md[Deleted - diff]
- .github/
- .vscode/
- bin/
- browser/
- claudetool/
- cmd/
- dockerimg/
- experiment/
- git_tools/
- httprr/
- llm/
- loop/
- skabandclient/
- skribe/
- termui/
- test/
- webui/
- .clabot
- .dockerignore
- .gitignore
- CONTRIBUTING.md
- dear_llm.md
- go.mod
- go.sum
- LICENSE
- README.md
Sketch
Sketch is an agentic coding tool. It draws the 🦉
🚀 Overview
Sketch runs in your terminal, has a web UI, understands your code, and helps you get work done. To keep your environment pristine, sketch starts a docker container and outputs its work onto a branch in your host git repository.
Sketch helps with most programming environments, but Sketch has extra goodies for Go.
📋 Quick Start
go install sketch.dev/cmd/sketch@latest sketch
🔧 Requirements
Currently, Sketch runs on macOS and Linux. It uses Docker for containers.
| Platform | Installation |
|---|---|
| macOS | brew install colima (or Docker Desktop/Orbstack) |
| Linux | apt install docker.io (or equivalent for your distro) |
| WSL2 | Install Docker Desktop for Windows (docker entirely inside WSL2 is tricky) |
The sketch.dev service is used to provide access to an LLM service and give you a way to access the web UI from anywhere.
🤝 Community & Feedback
- Discord: Join our community at https://discord.gg/6w9qNRUDzS
- GitHub Issues: Submit feedback at https://github.com/boldsoftware/sketch/issues
📖 User Guide
Getting Started
Start Sketch by running sketch in a Git repository. It will open your browser to the Sketch chat interface, but you can also use the CLI interface. Use -open=false if you want to use just the CLI interface.
Ask Sketch about your codebase or ask it to implement a feature. It may take a little while for Sketch to do its work, so hit the bell (🔔) icon to enable browser notifications. We won't spam you or anything; it will notify you when the Sketch agent's turn is done, and there's something to look at.
How Sketch Works
When you start Sketch, it:
- Creates a Dockerfile
- Builds it
- Copies your repository into it
- Starts a Docker container with the "inside" Sketch running
This design lets you run multiple sketches in parallel since they each have their own sandbox. It also lets Sketch work without worry: it can trash its own container, but it can't trash your machine.
Sketch's agentic loop uses tool calls (mostly shell commands, but also a handful of other important tools) to allow the LLM to interact with your codebase.
Getting Your Git Changes Out
Sketch is trained to make Git commits. When those happen, they are automatically pushed to the git repository where you started sketch with branch names sketch/*.
Finding Sketch branches:
git branch -a --sort=creatordate | grep sketch/ | tail
The UI keeps track of the latest branch it pushed and displays it prominently. You can use standard Git workflows to pull those branches into your workspace:
git cherry-pick $(git merge-base origin/main sketch/foo)
or merge the branch
git merge sketch/foo
or reset to the branch
git reset --hard sketch/foo
Ie use the same workflows you would if you were pulling in a friend's Pull Request.
Advanced: You can ask Sketch to git fetch sketch-host and rebase onto another commit. This will also fetch where you started Sketch, and we do a bit of "git fetch refspec configuration" to make origin/main work as a git reference.
Don't be afraid of asking Sketch to help you rebase, merge/squash commits, rewrite commit messages, and so forth; it's good at it!
Reviewing Diffs
The diff view shows you changes since Sketch started. Leaving comments on lines adds them to the chat box, and, when you hit Send (at the bottom of the page), Sketch goes to work addressing your comments.
Connecting to Sketch's Container
You can interact directly with the container in three ways:
- Web UI Terminal: Use the "Terminal" tab in the UI
- SSH: Look at the startup logs or click the information icon to see a command like
ssh sketch-ilik-eske-tcha-lott. We have automatically configured your SSH configuration to make these special hostnames work. - Visual Studio Code: Look for a command line or magic link behind the information icon, or when Sketch starts up. This starts a new VSCode session "remoted into" the container. You can edit the code, use the terminal, review diffs, and so forth.
Using SSH (and/or VSCode) allows you to forward ports from the container to your machine. For example, if you want to start your development webserver, you can do something like this:
# Forward container port 8888 to local port 8000 ssh -L8000:localhost:8888 sketch-ilik-epor-tfor-ward go run ./cmd/server
This makes http://localhost:8000/ on your machine point to localhost:8888 inside the container.
Using Browser Tools
You can ask Sketch to browse a web page and take screenshots. There are tools both for taking screenshots and "reading images", the latter of which sends the image to the LLM. This functionality is handy if you're working on a web page and want to see what the in-progress change looks like.
❓ FAQ
"No space left on device"
Docker images, containers, and so forth tend to pile up. Ask Docker to prune unused images and containers:
docker system prune -a
🛠️ Development
See CONTRIBUTING.md for development guidelines.
📄 Open Source
Sketch is open source. It is right here in this repository! Have a look around and mod away.
If you want to run Sketch entirely without the sketch.dev service, you can set the flag -skaband-addr="" and then provide an ANTHROPIC_API_KEY environment variable. (More LLM services coming soon!)