Git Product home page Git Product logo

zed-vale's Introduction

Zed vale extension

This extension adds Vale spelling and grammar checking to Zed.

Installation

Go to Zed's extension manager and search for vale. Click install.

Configuration

Configure Vale by creating a .vale.ini file in the project root. An example would look like:

StylesPath = .github/styles
MinAlertLevel = suggestion

# Packages = Microsoft, proselint, write-good, alex, Readability, Joblint
Packages = write-good

[*.md]
BasedOnStyles = Vale, write-good

Synchronize all configured styles by running: vale sync.

Contributing

Please see the contributing guide.

License

Apache 2.0

zed-vale's People

Contributors

koozz avatar

Stargazers

Erick Duarte avatar John avatar

Watchers

 avatar

zed-vale's Issues

Custom CLI binary path setting

I have a setup where my tooling is sandboxed in a way that may require providing a custom path to some of the binaries. In the case of vale, when I start the LSP I get this server log:

initialized!
configuration changed!
Vale CLI not installed!

I tried to specify the path to the CLI binary in both the binary and settings lsp Zed settings fields, but to no avail.

"lsp": {
  "vale": {
    "binary": {
      "path": "/<absolute-path-to-vale-dir>/bin/vale"
    },
    "settings": {
      "valeCLI": {
        "path": "/<absolute-path-to-vale-dir>/bin/vale"
      }
    }
  }
}

Do you think the extension would need to handle this in addition to the current setup?

vale server crashes

Thanks for writing this zed extension, I have also tried to do this myself but I did not quite succeed and you beat me to it ๐Ÿ˜…

But I seem to be getting some errors in the language server logs when hitting โŒ˜+. to fix the spelling issues.

Here the logs:

initialized!
configuration changed!
stderr: thread 'main' panicked at src/server.rs:318:61:
stderr: called `Option::unwrap()` on a `None` value
stderr: note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Sadly it seems to be an issue with the vale language server itself. Have you also experienced this issue?

Missing permission for vale-ls executable

On a fresh install, vale-ls was failing to start per Zed logs.
I had to manually add execution permission to the binary to fix it

chmod u+x "/Users/me/Library/Application Support/Zed/extensions/work/vale/vale-ls-v0.3.7/vale-ls"

Specs

Zed: v0.145.0 (Zed Preview)
OS: macOS 14.4.1
Memory: 16 GiB
Architecture: aarch64

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.