Giter Club home page Giter Club logo

buck2-lsp-adapter's Introduction

Buck2 LSP ๐Ÿš€

An VSCode LSP Adapter to use Buck2's built-in LSP Server.

This extension is still work in progress and require a lot more changes to properly work, but it's a good basis. Don't worry, we're not judging you if you use it as is. We all have to start somewhere, right? ๐Ÿ˜Š

contributions are welcomed. ๐Ÿ™

Introduction ๐Ÿ“

This project is a VSCode extension that provides a client-side implementation of the Buck2 Language Server Protocol (LSP). It enables features such as code completion, diagnostics, and find references to be available in the editor/IDE.

Features ๐ŸŽ‰

This extension provides the following features:

Code Completion โœ…

Not fully implemented!

Code completion is a feature that suggests possible code completions as you type. This feature is powered by Buck2's Language Server Protocol (LSP) server, which analyzes your code and provides suggestions based on the context.

Diagnostics ๐Ÿšจ

Not implemented at all!

Diagnostics are a feature that highlights errors and warnings in your code. This feature is also powered by Buck2's LSP server, which analyzes your code and provides feedback on any issues it finds.

Find References ๐Ÿ”

Find References is a feature that allows you to find all references to a particular symbol in your code. This feature is also powered by Buck2's LSP server, which analyzes your code and provides a list of all references to the symbol you're interested in.

Getting Started ๐Ÿ

To get started with this extension, you need to have Buck2 installed on your system. Once installed, you can install this extension via the VSCode marketplace.

Building the Extension ๐Ÿ› ๏ธ

To build the extension from source, follow these steps:

  1. Clone the repository: git clone https://github.com/PeerStudios/buck2-lsp-adapter.git
  2. Navigate to the project directory: cd buck2-lsp-adapter
  3. Install the dependencies: pnpm install
  4. Build the extension: pnpm package

This will create a .vsix file in the project directory, which you can install in VSCode by running the Extensions: Install from VSIX command.

Configuration โš™๏ธ

Configuration options for this extension are available in the VS Code settings under the buck2-lsp-adapter section. Available options include:

  • buck2-lsp-adapter.buck2Path: Path to the buck2 binary, should either be buck2 or absolute.
  • buck2-lsp-adapter.lspArguments: Arguments to pass to the buck2 lsp server.
  • buck2-lsp-adapter.enableGotoDefinition: Enable goto definition.

Contributing ๐Ÿค

Contributions to this project are welcome! Please see the CONTRIBUTING.md file for more information.

License ๐Ÿ“œ

This project is licensed under the "MIT" License. See the LICENSE file for more information.

TL;DR: You can do whatever you want with this extension, including using it to take over the world, but I take no responsibility if your plans fail. However, you must credit me and send me a postcard from your secret lair! ๐ŸŒ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ“ฌ

buck2-lsp-adapter's People

Contributors

mempler avatar

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.