Language server protocol and implementation : supporting language-smart editing and programming tools / Nadeeshaan Gunasinghe, Nipuna Marcus.
Gunasinghe, Nadeeshaan, author.; Marcus, Nipuna, author.
2022
QA76.7 .G86 2022
Available Online

Linked e-resources

Linked Resource
Online Access
Concurrent users
Unlimited
Authorized users
Authorized users
Document Delivery Supplied
Can lend chapters, not whole ebooks

Details

Title
Language server protocol and implementation : supporting language-smart editing and programming tools / Nadeeshaan Gunasinghe, Nipuna Marcus.
Author
Gunasinghe, Nadeeshaan, author.
ISBN
9781484277928 (electronic bk.)
1484277929 (electronic bk.)
1484277910
9781484277911
DOI
https://doi.org/10.1007/978-1-4842-7792-8
Published
California : Apress, [2022]
Language
English
Description
1 online resource
Item Number
10.1007/978-1-4842-7792-8 doi
Call Number
QA76.7 .G86 2022
Dewey Decimal Classification
005.13
Summary
Understand the important aspects of implementing a production-grade language server in support of language-smart tools such as code editors and other programming utilities. This book shows you how to create a single implementation of a language server that can be used by multiple tools, enabling you to do the job once in a way that can be shared and reused. This book covers the language server protocol used for communication between programming tools and your language server. The book also provides an in-depth understanding of the design, implementation, and user experience aspects which should be considered when implementing a language server. The book walks you through an example language server implementation to illustrate the basic concepts, then goes on to cover advanced aspects of language server use such as progress reporting, launchers, and extension points. User experience is an important aspect of language server implementation and different tooling vendors strive to provide their own unique user experiences. This book explains how the protocol features can be leveraged to address the unique developer experience provided by different tooling vendors. The book also shows how to enhance the smoothness of the editing experience by orchestrating multiple features together. What You Will Learn Implement a language server from scratch Understand language server protocol and its data models Leverage the protocol while preserving the unique user experience of different editors Extend the protocol to support more than its standard capabilities Run a language server on top of launchers such as standard I/O and TCP socket Seamlessly incorporate language semantics into your protocol features Who This Book Is For Developers focused on and passionate about implementing language development tools such as plug-ins and extensions for interactive development environments (IDEs) or other tools that rely upon parsing of language statements and commands, and developers who need an in-depth understanding of the language server protocol as well as how to use the language server protocol to develop extensible language services.
Note
Includes index.
Access Note
Access limited to authorized users.
Source of Description
Description based on online resource; title from digital title page (viewed on February 15, 2022).
Added Author
Marcus, Nipuna, author.
Available in Other Form
Language Server Protocol and Implementation
Linked Resources
Online Access
Record Appears in
Online Resources > Ebooks
All Resources
Intro
Table of Contents
About the Authors
About the Technical Reviewer
Acknowledgments
Introduction
Chapter 1: Developer Tools and Language Services
Early Programmable Computers
Code Forms and Punched Cards
Text Editors vs. Source Code Editors
Why IDEs
Language Intelligence
Summary
Chapter 2: Understanding the Language Server Protocol
Understanding JSON-RPC
Request Object
jsonrpc
method
params
id
Notification
Response Object
jsonrpc
result
error
id
Error Object
code
message
data
Batch

Understanding the Base Protocol
Header Part
Content Part
Communication Model
General Messages
Outline Placeholder
window
telemetry
workspace
textDocument
Summary
Chapter 3: Implementing a Language Server
Tools and Dependencies
Building the Project
Compatibility with Ballerina
Debugging the Client and the Server
Understanding the Main Components
Server API
Server Core
Client Implementation
Summary
Chapter 4: General Messages
General Messages
Initialize
Generating the InitializeResult
Initialized
Shutdown
Exit

Window Operations
ShowMessage
ShowMessageRequest
Generating the Request
ShowDocument
Generating the Request
LogMessage
Progress/Create
Progress/Cancel
Summary
Chapter 5: Text Synchronization
General Capabilities
didOpen
Indexing and Project Initialization
didChange
willSave
willSaveWaitUntil
didSave
didClose
Summary
Chapter 6: Diagnostics, Smart Editing, and Documentation
Diagnostics
Initialization and Capabilities
Publishing the Diagnostics
Completion
Initialization and Capabilities
Client Capabilities

Server Capabilities
Generating the Completions
Text Insertion
Documentation and Additional Information
Sorting and Filtering
Completion Resolve
Signature Help
Initialization and Capabilities
Client Capabilities
Server Capabilities
Generating the Signature Help
Hover
Initialization and Capabilities
Client Capabilities
Generating the Hover
Summary
Chapter 7: Refactoring and Code Fixes
Rename
Initialization and Capabilities
Client Capabilities
Server Capabilities
Generating the Workspace Edit
Prepare Rename
Formatting

Initialization and Capabilities
Client Capabilities
Server Capabilities
Generating the Formatting TextEdits
Range Formatting
Initialization and Capabilities
Generating the Range Formatting TextEdits
On Type Formatting
Initialization and Capabilities
Client Capabilities
Server Capabilities
Generating the On Type Formatting TextEdits
Code Actions
Initialization and Capabilities
Client Capabilities
Server Capabilities
Generating the CodeAction
Request Parameters
Generating the Response
Code Actions Resolve
CodeLens

Browse Subjects

Show more subjects...

Statistics

from
to
Export