npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ignored/solidity-language-server

v0.6.14

Published

Solidity language server by Nomic Foundation

Downloads

19

Readme

Solidity Language Server

A language server for the Solidity programming language, used in the Solidity by Nomic Foundation VS code extension and the @nomicfoundation/coc-solidity coc.nvim extension.

Built by the Nomic Foundation for the Ethereum community.

Join our Hardhat Support Discord server to stay up to date on new releases, plugins and tutorials.

Install

The language server can be installed via npm:

npm install @ignored/solidity-language-server -g

To run the server standalone:

nomicfoundation-solidity-language-server --stdio

coc.nvim

For coc the extension for this language server (found here) can be installed through the coc vim command:

:CocInstall @ignored/coc-solidity

neovim lsp

To run the language server directly through the neovim lsp (assuming neovim/nvim-lspconfig)

local lspconfig = require 'lspconfig'
local configs = require 'lspconfig.configs'

configs.solidity = {
  default_config = {
    cmd = {'nomicfoundation-solidity-language-server', '--stdio'},
    filetypes = { 'solidity' },
    root_dir = lspconfig.util.find_git_ancestor,
    single_file_support = true,
  },
}

lspconfig.solidity.setup {}

Features

Code Completions

The solidity language server autocompletes references to existing symbols (e.g. contract instances, globally available variables and built-in types like arrays) and import directives (i.e. it autocompletes the path to the imported file).

Direct imports (those not starting with ./ or ../) are completed based on suggestions from ./node_modules.

Relative imports pull their suggestions from the file system based on the current solidity file's location.

Import completions

Natspec documentation completion is also supported

Natspec contract completions

Natspec function completions


Navigation

Move through your codebase with semantic navigation commands:

Go to Definition

Navigates to the definition of an identifier.

Go to Type Definition

Navigates to the type of an identifier.

Go to References

Shows all references of the identifier under the cursor.

Navigation


Renames

Rename the identifier under the cursor and all of its references:

Rename


Format document

Apply solidity formatting to the current document.

The formatting configuration can be overriden through a .prettierrc file, see Formatting Configuration.

Reformat


Hover

Hovering the cursor over variables, function calls, errors and events will display a popup showing type and signature information:

Hover


Inline code validation (Diagnostics)

As code is edited, Solidity by Nomic Foundation runs the solc compiler over the changes and displays any warnings or errors it finds.

This feature is only available in solidity files that are part of a Hardhat project, as Hardhat is used for import resolution, see Hardhat Projects for details.

Diagnostic


Code Actions

Code actions, or quickfixes are refactorings suggested to resolve a solc warning or error.

A line with a warning/error that has a code action, will appear with small light bulb against it; clicking the light bulb will provide the option to trigger the code action.

Implement missing functions on interface

A contract that implements an interface, but is missing functions specified in the interface, will get a solidity(3656) error.

The matching code action Add missing functions from interface will determine which functions need to be implemented to satisfy the interface and add them as stubs to the body of the contract.

Implement interface

Constrain mutability

A function without a mutability keyword but which does not update contract state will show a solidity(2018) warning, with solc suggesting adding either the view or pure keyword depending on whether the function reads from state.

The matching code action Add view/pure modifier to function declaration resolves the warning by adding the keyword to the function signature.

Constrain Mutability

Adding virtual/override on inherited function signature

A function in an inheriting contract, that has the same name and parameters as a function in the base contract, causes solidity(4334) in the base contract function if it does not have the virtual keyword and solidity(9456) in the inheriting contract function if does not have the override keyword.

The Add virtual specifier to function definition and Add override specifier to function definition code actions appear against functions with these errors.

Virtual and Override

Adding public/private to function signature

A function without an accessibility keyword will cause the solidity(4937) error.

Two code actions will appear against a function with this error: Add public visibility to declaration and Add private visibility to declaration.

Public Private

Adding license identifier and pragma solidity version

When no license is specified on a contract, the solidity(1878) warning is raised by the compiler. Similarly, when no compiler version is specified with a pragma solidity statement, the compiler shows the solidity(3420) warning. There are code actions available for quick fixes.

Add license specifier

Add pragma solidity

Specifying data location for variables

Some types require you to specify a data location (memory, storage, calldata), depending on where they are defined. The available code actions allow the user to add, change or remove data locations depending on the error being raised.

Data location quickfix

Fix addresses checksum

The solidity compiler requires explicit addresses to be in the correct checksummed format. This quickfix transforms any address to the expected format.

Address checksum

Hardhat console auto-import

Hardhat's console.sol can be imported with this quickfix. Please note that this only available on hardhat projects.

Console import


Hardhat Projects

Solidity by Nomic Foundation provides enhanced functionality for Solidity files within a Hardhat project, including inline validation and quick fixes.

To take advantage of these features, use the File menu to Open Folder, and select the folder containing the hardhat.config.{js,ts} file.

Inline validation (the display of compiler errors and warnings against the code) is based on your Hardhat configuration file. The version of the solc solidity compiler used for validation is set within this file, see the Hardhat documentation for more details.

Monorepo Support

Solidity by Nomic Foundation will detect Hardhat projects (folders containing a hardhat.config.{js,ts} file) within a monorepo, when the root of the monorepo is opened as a workspace folder.

The Hardhat config file that is used when validating a Solidity file is shown in the Solidity section on the Status Bar:

Open Config

Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request.

Go to CONTRIBUTING.md to learn about how to set up a development environment.

Feedback, help and news

Hardhat Support Discord server: for questions and feedback.

Follow Hardhat on Twitter.