mirror of https://github.com/zed-industries/zed.git synced 2024-12-31 21:36:26 +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

Nate Butler 08418618ab Generate `script/storybook` (#3652 ) [[PR Description]] This PR adds the ability to run stories with `script/storybook`. Running it directly will give you a selector like this: ```zsh ➜ zed git:(add-storybook-script) script/storybook 1) auto_height_editor 9) icon 17) scroll 2) avatar 10) icon_button 18) tab 3) button 11) keybinding 19) tab_bar 4) checkbox 12) label 20) text 5) context_menu 13) list 21) viewport_units 6) cursor 14) list_header 22) z_index 7) disclosure 15) list_item 23) picker 8) focus 16) overflow_scroll ``` You can also provide a value like: `script/storybook {STORY_NAME}` - Example: `script/storybook text` OR `script/storybook components/{STORY_NAME}` - Example: `script/storybook components/text` I just wanted an easier way to interface with stories quickly to make using them a bit easier, and enable discovery of what exists easier with the selector. This was a really quick hack, in the future we can extend this to a proper CLI. Release Notes: - N/A		2023-12-14 11:52:06 -05:00
.cargo
.config
.github
.vscode
.zed
assets	Rework the way project panel auto reveals entries	2023-12-12 11:38:51 +02:00
crates	Generate `script/storybook`	2023-12-14 11:42:08 -05:00
docs	Add note	2023-12-13 10:35:54 -05:00
plugins
script	Generate `script/storybook`	2023-12-14 11:42:08 -05:00
styles
.dockerignore
.gitignore
.gitmodules
Cargo.lock	Vcs menu2 (#3648 )	2023-12-14 12:36:53 +01:00
Cargo.toml	Vcs menu2 (#3648 )	2023-12-14 12:36:53 +01:00
docker-compose.sql	Add config files for running Postgres inside Docker Compose (#3637 )	2023-12-13 17:25:07 -05:00
docker-compose.yml	Add config files for running Postgres inside Docker Compose (#3637 )	2023-12-13 17:25:07 -05:00
Dockerfile
Procfile
Procfile.zed2
README.md
rust-toolchain.toml

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-local

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.