Neo4j Cypher Language Support

This mono repo contains packages that together make up Neo4j's Cypher Language support.

Project status

The project is in an early stage. We are still missing important features and the project is not yet stable. We welcome feedback and contributions!

Try it out in our demo or in our alpha releases in Neo4j Workspace and soon also in our VS Code extension.

Project Overview

---
config:
  theme: 'base'
  themeVariables:
    primaryColor: '#EDF0FD'
    primaryTextColor: '#0A0F25'
    secondaryTextColor: '#0A0F25'
    primaryBorderColor: '#0D32B2'
    lineColor: '#0D32B2'
    secondaryColor: '#E3E9FD'
    tertiaryColor: '#E3E9FD'
    tertiaryBorderColor: '#0D32B2'
---
flowchart TD
    subgraph CLS[Cypher Language Support]
    direction TD
    VSE(vscode-extension)
    RCP(react-codemirror-playground)
    RCM(react-codemirror)
    LS(language-server)
    POLLER(schema-poller)
    
    subgraph LT[language tooling]
    LSUPPORT(language-support)
    LINTWORKER(lint-worker)
    end



    subgraph Neo4j [Neo4j Mono Repo]
    direction TD
    GRAMMAR(ANTLR4 Grammar)
    SA(SemanticAnalysis)
    end

    RCP -->|used to demo| RCM
    VSE -->|bundles and launches|LS
    LS -->|powered by|LT
    RCM -->|powered by|LT
    LS -->|used to manage neo4j connection|POLLER


    LSUPPORT -->|Import ANTLR4 cypher grammar & semantic analysis compiled to js|Neo4j
    end

The project comprises several packages:

• language-support - The core library implementing the language support features.
• language-server - The language server wrapper for the language-support package.
• vscode-extension - The Neo4j VS Code extension which bundles the language-server
• react-codemirror - A set of codemirror6 cypher language support plugins and a react wrapper.
• react-codemirror-playground - A playground for the codemirror integration.
• query-tools - An internal package we use to manage the Neo4j connection and keep the schema (procedure names, labels, database names, etc.) up to date in the language server.

Capabilities

• Syntax highlighting
• Autocompletion
• Linting
• Formatting

Building the project and contributing

See CONTRIBUTING.md.