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

foam-language-client

v0.2.0

Published

A Language Client for the OpenFOAM LSP server

Downloads

70

Readme

A Language Client for OpenFOAM cases

A simple OpenFOAM language extension which adds (some) language support for OpenFOAM case dictionaries to Visual Studio Code.

Overview of supported features

Head to this slide for an overview of all supported features of the underlying LSP server.

A quick run-down of the important features:

  1. An OpenFOAM Language file type.
  2. A Tree-Sitter grammar for OpenFOAM.
  3. File symbols (Outline) support for OpenFOAM dictionaries.

Configuration

Syntax highlighting

This extension does not currently provide syntax highlighting support on its own. We're waiting for VSCode to support Tree-Sitter and now Explore using tree sitter for syntax highlighting to get merged.

Mean while, you can use this generic tree-sitter-vscode extension in the following way (replace /path/to with something that works for you):

npm i -g tree-sitter tree-sitter-cli
git clone https://github.com/tree-sitter/tree-sitter-cpp /path/to/tree-sitter-cpp
cd /path/to/tree-sitter-cpp
tree-sitter build --wasm
git clone https://github.com/FoamScience/tree-sitter-foam /path/to/tree-sitter-foam
cd /path/to/tree-sitter-foam
tree-sitter build --wasm

In VScode's extension configuration:

"tree-sitter-vscode.languageConfigs": [
    {
        "lang": "openfoam",
        "parser": "/path/to/tree-sitter-foam/tree-sitter-foam.wasm",
        "highlights": "/path/to/tree-sitter-foam/queries/highlights.scm",
        "injections": "/path/to/tree-sitter-foam/queries/injections.scm"
    },
    {
        "lang": "cpp",
        "parser": "/path/to/tree-sitter-cpp/tree-sitter-cpp.wasm",
        "highlights": "/path/to/tree-sitter-cpp/queries/highlights.scm",
        "injections": "/path/to/tree-sitter-cpp/queries/injections.scm"
    },        
],

[!TIP] Configuring the cpp grammar helps in highlighting the code blocks in OpenFOAM dictionaries. Although, this is optional.

File type detection

You will need to correctly detect the file type for the language client to get triggered; For example, add the following to your Visual Studio Code settings to recognize some common OpenFOAM case files (File->Preferences->Settings):

"files.associations": {
    "*Dict": "openfoam",
    "*Properties": "openfoam",
    "fvSchemes": "openfoam",
    "fvSolution": "openfoam",
    "**/constant/g": "openfoam",
    "**/0/*": "openfoam"
}

Known issues

Currently, code system/someDict will cause the LSP server to segfault.

It is recommended to open the whole case path with VSCode instead: code .

Want to help?

Please refer to this issue.