mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-12-26 02:37:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
10740 commits 774 branches 798 tags 251 MiB
Rust 92.2%
JSON-with-Comments 5.9%
Scheme 0.7%
Shell 0.4%
JavaScript 0.2%
Other 0.3%
Find a file
Julia 2d8159998d Put our downloaded copy of Node in the env for every NPM action 
Intelephense (PHP language server) has a dependency on `protobufjs`
which invokes `node` in the `postinstall` script and if the user did
not have a system Node runtime installed that would fail. Have this
use our downloaded installation too
2023-07-21 16:13:00 -04:00
.cargo Use xtask for theme generation 2023-06-21 18:48:09 +02:00
.config tests: Test 'db' package sequentially (#2654) 2023-06-28 15:00:43 +02:00
.github Update another deprecated plugin 2023-07-13 11:52:35 +03:00
.vscode
assets Vim shortcuts (#2760) 2023-07-21 10:31:18 -06:00
crates Put our downloaded copy of Node in the env for every NPM action 2023-07-21 16:13:00 -04:00
docs Update building-zed.md 2023-07-12 14:09:21 -04:00
plugins
script Update icons to new zed file icon set 2023-07-19 11:10:30 -07:00
styles bump the brightness of the active wrap guide 2023-07-20 16:45:41 -07:00
.dockerignore
.gitignore Merge branch 'main' into sergey/z-2308-create-a-proof-of-concept-of-exporting-a-type-from-rust-and 2023-06-22 17:58:56 +02:00
.gitmodules
Cargo.lock Mute mics by default (#2754) 2023-07-19 12:42:30 -07:00
Cargo.toml Update cargo.toml 2023-07-18 12:15:03 -04:00
Dockerfile
Procfile
README.md Update README.md 2023-07-12 11:35:38 -06:00
rust-toolchain.toml chore: add targets to rust-toolchain.toml (#2581) 2023-06-07 00:12:47 +02:00

README.md

Zed

CI

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

Development tips

Dependencies

  • Install Postgres.app and start it.

  • Install the LiveKit server and the foreman process supervisor:

    brew install livekit
brew install foreman

  • Ensure the Zed.dev website is checked out in a sibling directory and install it's 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

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.