mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2025-01-07 17:26:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
10158 commits 790 branches 804 tags 226 MiB
Rust 92.2%
JSON-with-Comments 5.8%
Scheme 0.7%
Shell 0.4%
JavaScript 0.2%
Other 0.4%
Find a file
Nate Butler c7c38c7da2
snake_case theme (#2661) 
This PR moves the theme / `/styles` typescript app to use snake_case to
better align with the rust app and make it easier to reference things
across both apps.

It also configures ESLint in the styles app and fixes many ESLint
errors.

Going forward from this PR we will use `snake_case` throughout the
theme.

Release Notes:

- N/A (No public facing changes)
2023-06-29 12:47:15 -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 Use nextest instead of test (#2639) 2023-06-22 16:50:26 +02:00
.vscode
assets Collab UI v2 (#2618) 2023-06-28 09:14:39 -07:00
crates Stub out for language plugin 2023-06-28 17:06:50 -04:00
docs Update local-collaboration.md 2023-06-27 10:52:38 -04:00
plugins
script Added muted and currently speaking tracking 2023-06-27 19:23:13 -07:00
styles Delete snake_case.ts 2023-06-29 11:56:14 -04: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 Merge branch 'main' into fix-broken-lsp-installations 2023-06-28 16:46:06 -04:00
Cargo.toml Merge branch 'main' into collab-titlebar-2 2023-06-27 15:40:43 +02:00
Dockerfile chore: bump MSRV to 1.70, add rust-toolchain (#2580) 2023-06-06 23:49:34 +02:00
Procfile
README.md Clarify GH Token scope requirements 2023-05-02 12:12:57 +03: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:

    cd ..
git clone https://github.com/zed-industries/zed.dev

  • Initialize submodules

    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.