mirror of https://github.com/zed-industries/zed.git synced 2025-01-27 04:44:30 +00:00

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

gpui text-editor zed

Find a file

Marshall Bowers 66358f2900 Update storybook to support stories for individual components (#3010 ) This PR updates the `storybook` with support for adding stories for individual components. ### Motivation Right now we just have one story in the storybook that renders an entire `WorkspaceElement`. While iterating on the various UI components, it will be helpful to be able to create stories of those components just by themselves. This is especially true for components that have a number of different states, as we can render the components in all of the various states in a single layout. ### Explanation We achieve this by adding a simple CLI to the storybook. The `storybook` binary now accepts an optional `[STORY]` parameter that can be used to indicate which story should be loaded. If this parameter is not provided, it will load the workspace story as it currently does. Passing a story name will load the corresponding story, if it exists. For example: ``` cargo run -- elements/avatar ``` <img width="723" alt="Screenshot 2023-09-21 at 10 29 52 PM" src="https://github.com/zed-industries/zed/assets/1486634/5df489ed-8607-4024-9c19-c5f4541f97c9"> ``` cargo run -- components/facepile ``` <img width="785" alt="Screenshot 2023-09-21 at 10 30 07 PM" src="https://github.com/zed-industries/zed/assets/1486634/e04a4577-7403-405d-b23c-e765b7a06229"> Release Notes: - N/A		2023-09-21 22:41:53 -04:00
.cargo	chore: Enable v0 symbol mangling (#2985 )	2023-09-18 18:58:59 +02:00
.config	tests: Test 'db' package sequentially (#2654 )	2023-06-28 15:00:43 +02:00
.github	Add `docker system prune` command	2023-08-23 14:54:39 -04:00
.vscode	Hit the local server when debugging	2021-08-24 17:11:40 -06:00
.zed	Ensure json uses a tab size of 4	2023-07-31 13:08:40 -04:00
assets	fix default keybindings for select all matches	2023-09-20 17:14:19 -07:00
crates	Update storybook to support stories for individual components (#3010 )	2023-09-21 22:41:53 -04:00
docs	Fix some typos in `tools.md`	2023-09-21 17:21:40 -04:00
plugins	Use the same serde version across the entire workspace	2023-03-28 09:42:00 -07:00
script	catchup with main	2023-09-15 09:31:33 -04:00
styles	Correct icon_margin_scale	2023-09-21 11:57:35 -04:00
.dockerignore	Removed old experiments settings and staff mode flag, added new StaffMode global that is set based on the webserver's staff bit	2023-01-27 15:43:12 -08:00
.gitignore	Ignore .idea directory	2023-09-15 11:17:02 -04:00
.gitmodules	WIP: start on live_kit_server	2022-10-17 09:59:16 +02:00
Cargo.lock	Update storybook to support stories for individual components (#3010 )	2023-09-21 22:41:53 -04:00
Cargo.toml	Extract UI elements from `storybook` into new `ui` crate (#3008 )	2023-09-21 19:25:35 -04:00
Dockerfile	Upgrade to rust 1.72	2023-08-25 09:59:16 -07:00
Procfile	Run postgrest as part of foreman	2023-09-13 12:32:15 -07:00
README.md	Fix some typos in `README.md`	2023-09-21 16:56:04 -04:00
rust-toolchain.toml	Bump rust from 1.72.0 to 1.72.1	2023-09-21 10:17:55 -07:00
test.rs	Split playground into gpui2 and storybook	2023-08-30 16:12:14 -06:00

README.md

Zed

Welcome to Zed, a lightning-fast, collaborative code editor that makes your dreams come true.

Development tips

Dependencies

Install Xcode from https://apps.apple.com/us/app/xcode/id497799835?mt=12, and accept the license:
```
sudo xcodebuild -license
```

Install homebrew, node and rustup-init (rustup, rust, cargo, etc.)

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install node rustup-init
rustup-init # follow the installation steps

Install postgres and configure the database

brew install postgresql@15
brew services start postgresql@15
psql -c "CREATE ROLE postgres SUPERUSER LOGIN" postgres
psql -U postgres -c "CREATE DATABASE zed"

Install the LiveKit server, the PostgREST API server, and the foreman process supervisor:
```
brew install livekit
brew install postgrest
brew install foreman
```

Ensure the Zed.dev website is checked out in a sibling directory and install its dependencies:

cd ..
git clone https://github.com/zed-industries/zed.dev
cd zed.dev && npm install
npm install -g vercel

Return to Zed project directory and Initialize submodules
```
cd zed
git submodule update --init --recursive
```
Set up a local zed database and seed it with some initial users:

Create a personal GitHub token to run script/bootstrap once successfully: the token needs to have an access to private repositories for the script to work (repo OAuth scope). Then delete that token.
```
GITHUB_TOKEN=<$token> script/bootstrap
```
Now try running zed with collaboration disabled:
```
cargo run
```

Common errors

xcrun: error: unable to find utility "metal", not a developer tool or in PATH
- You need to install Xcode and then run: xcode-select --switch /Applications/Xcode.app/Contents/Developer
- (see https://github.com/gfx-rs/gfx/issues/2309)

Testing against locally-running servers

Start the web and collab servers:

foreman start

If you want to run Zed pointed at the local servers, you can run:

script/zed-with-local-servers
# or...
script/zed-with-local-servers --release

Dump element JSON

If you trigger cmd-alt-i, Zed will copy a JSON representation of the current window contents to the clipboard. You can paste this in a tool like DJSON to navigate the state of on-screen elements in a structured way.

Licensing

We use cargo-about to automatically comply with open source licenses. If CI is failing, check the following:

Is it showing a no license specified error for a crate you've created? If so, add publish = false under [package] in your crate's Cargo.toml.
Is the error failed to satisfy license requirements for a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to the accepted array in script/licenses/zed-licenses.toml.
Is cargo-about unable to find the license for a dependency? If so, add a clarification field at the end of script/licenses/zed-licenses.toml, as specified in the cargo-about book.

Wasm Plugins

Zed has a Wasm-based plugin runtime which it currently uses to embed plugins. To compile Zed, you'll need to have the wasm32-wasi toolchain installed on your system. To install this toolchain, run:

rustup target add wasm32-wasi

Plugins can be found in the plugins folder in the root. For more information about how plugins work, check the Plugin Guide in crates/plugin_runtime/README.md.