mirror of
https://github.com/hanzoai/gui.git
synced 2026-10-25 02:31:41 +00:00
docs: fix outdated instructions in CLAUDE.md, CONTRIBUTING.md, README.md, and using-ios.md
This commit is contained in:
+18
-6
@@ -35,7 +35,7 @@ There's a few ways to run code in the repo, generally for native, there's two wa
|
||||
bun run sandbox
|
||||
```
|
||||
|
||||
Is a bit easier but runs on One, it should work with Expo Go.
|
||||
Is a bit easier but runs on One (the One framework, `one dev`).
|
||||
|
||||
If you are ok to build the native apps, then:
|
||||
|
||||
@@ -43,10 +43,7 @@ If you are ok to build the native apps, then:
|
||||
bun run kitchen-sink
|
||||
```
|
||||
|
||||
Note that kitchen-sink needs react 18 so you do this profile switch first.
|
||||
But if you're working on the sandbox you'll want to run `bun install` again to clear it.
|
||||
|
||||
But that requires building the native apps:
|
||||
That requires building the native apps:
|
||||
|
||||
```bash
|
||||
# Android
|
||||
@@ -62,7 +59,7 @@ You can run `bun run sandbox` or `bun run dev` (the tamagui website).
|
||||
|
||||
### Fixing libraries
|
||||
|
||||
All compiler and CSS generation tests live in `code/static/static-tests`.
|
||||
All compiler and CSS generation tests live in `code/compiler/static-tests`.
|
||||
|
||||
There are many native tests in `code/kitchen-sink/tests`.
|
||||
|
||||
@@ -70,6 +67,21 @@ A variety of core tests live in `code/core/core-test`.
|
||||
|
||||
Before submitting a PR, please check everything works across every combination of environments.
|
||||
|
||||
### Linting & Formatting
|
||||
|
||||
The project uses [oxfmt](https://oxc.rs) + [oxlint](https://oxc.rs) (Rust-based, fast):
|
||||
|
||||
```bash
|
||||
# check formatting + lint
|
||||
bun run lint
|
||||
|
||||
# auto-fix
|
||||
bun run lint:fix
|
||||
|
||||
# format only
|
||||
bun run format
|
||||
```
|
||||
|
||||
## Other ways to Contribute
|
||||
|
||||
Join the [Discord](https://discord.gg/vhEKmdCZw6).
|
||||
|
||||
@@ -54,4 +54,4 @@ The compiler optimizes most and ultimately flattens a majority of styled compone
|
||||
|
||||
To contribute to Tamagui reference the [contributing guide](https://github.com/tamagui/tamagui/blob/main/CONTRIBUTING.md).
|
||||
|
||||
To contribute to documentation reference the [writing guide](https://github.com/tamagui/tamagui/blob/main/code/tamagui.dev/WRITING-GUIDE.md).
|
||||
To contribute to documentation, see the docs source in `code/tamagui.dev/data/docs/`.
|
||||
|
||||
@@ -43,19 +43,16 @@ The kitchen-sink package contains the main integration tests for Tamagui compone
|
||||
bun run test:web
|
||||
```
|
||||
|
||||
This runs tests with CSS, React Native, and Reanimated animation drivers.
|
||||
This uses `run-tests-parallel.ts` which first runs `default` + `webkit` projects sequentially, then runs all four animated driver projects (`css`, `native`, `reanimated`, `motion`) in parallel against a single shared dev server.
|
||||
|
||||
3. **Run tests with a specific animation driver**:
|
||||
|
||||
```bash
|
||||
# CSS animations driver
|
||||
bun run test:web:driver-css
|
||||
# Using env var + playwright --project flag
|
||||
cd code/kitchen-sink
|
||||
NODE_ENV=test TAMAGUI_TEST_ANIMATION_DRIVER=css npx playwright test --project=animated-css
|
||||
|
||||
# React Native animations driver
|
||||
bun run test:web:driver-rn
|
||||
|
||||
# Reanimated animations driver
|
||||
bun run test:web:driver-reanimated
|
||||
# Available projects: animated-css, animated-native, animated-reanimated, animated-motion
|
||||
```
|
||||
|
||||
4. **Run a specific test file**:
|
||||
@@ -66,7 +63,7 @@ The kitchen-sink package contains the main integration tests for Tamagui compone
|
||||
npx playwright test tests/PopoverFocusScope.test.tsx
|
||||
|
||||
# Or with a specific driver
|
||||
NODE_ENV=test TAMAGUI_TEST_ANIMATION_DRIVER=css npx playwright test tests/YourTest.test.tsx
|
||||
NODE_ENV=test TAMAGUI_TEST_ANIMATION_DRIVER=css npx playwright test tests/YourTest.animated.test.tsx --project=animated-css
|
||||
```
|
||||
|
||||
5. **Debug tests**:
|
||||
|
||||
+1
-1
@@ -8,7 +8,7 @@ Run Metro separately for faster iteration:
|
||||
|
||||
```bash
|
||||
cd code/kitchen-sink
|
||||
yarn start > /tmp/metro.log 2>&1 &
|
||||
bun run start > /tmp/metro.log 2>&1 &
|
||||
```
|
||||
|
||||
Then run detox with `--reuse` to use existing Metro:
|
||||
|
||||
Reference in New Issue
Block a user