@gram-data/tree-sitter-gram 0.1.10 → 0.2.0

package/README.md

@@ -24,4 +24,42 @@ As a subject:
 })
 ```
 
-Learn more about `gram` at the [gram-data github org](https://github.com/gram-data) notation.
+Learn more about `gram` at the [gram-data github org](https://github.com/gram-data) notation.
+
+## Editor Support
+
+This repository includes editor integrations for syntax highlighting and language support:
+
+- **[Zed Editor](editors/zed/)** - Full syntax highlighting and language support
+- More editors coming soon! Contributions welcome.
+
+See [editors/README.md](editors/README.md) for installation instructions and available features.
+
+## Language Bindings
+
+Tree-sitter bindings are available for multiple languages:
+
+- **Node.js**: `npm install @gram-data/tree-sitter-gram`
+- **Rust**: Available via `Cargo.toml`
+- **Python**: Install via `pip install .`
+- **Go**: Import from this repository
+- **Swift**: Available via Swift Package Manager
+- **C**: Build with included Makefile
+
+## Development
+
+Generate the parser after grammar changes:
+```bash
+npx tree-sitter generate
+npx tree-sitter test
+```
+
+Run language binding tests:
+```bash
+npm test                    # Node.js bindings
+cargo test                  # Rust bindings
+python -m pytest           # Python bindings
+make test                   # C bindings
+```
+
+See [DEVELOP.md](DEVELOP.md) for detailed development guidelines.

package/editors/README.md

@@ -0,0 +1,68 @@
+# Editor Integrations
+
+This directory contains editor integrations for the Gram tree-sitter grammar.
+
+## Available Integrations
+
+### Zed Editor
+
+The Zed integration provides full syntax highlighting and language support for Gram notation files.
+
+**Installation:**
+
+1. Copy or symlink the extension to your Zed extensions directory:
+   ```bash
+   # On macOS/Linux:
+   ln -s $(pwd)/editors/zed ~/.config/zed/extensions/gram
+
+   # On Windows:
+   mklink /D "%APPDATA%\Zed\extensions\gram" "path\to\tree-sitter-gram\editors\zed"
+   ```
+
+2. Restart Zed
+
+3. Open any `.gram` file to see syntax highlighting in action
+
+**Features:**
+- Syntax highlighting for all Gram constructs
+- Bracket matching for `()`, `[]`, and `{}`
+- Automatic file type detection for `.gram` files
+- Proper indentation handling
+
+**Development:**
+If you're developing the extension, use Zed's "install dev extension" command:
+1. Open Zed command palette (`Cmd+Shift+P` / `Ctrl+Shift+P`)
+2. Run "zed: install dev extension"
+3. Select the `editors/zed` directory
+4. Restart Zed
+
+## Contributing New Integrations
+
+We welcome contributions for other editors! When adding a new editor integration:
+
+1. Create a subdirectory under `editors/` named after the editor
+2. Include all necessary configuration files
+3. Add installation and usage instructions to this README
+4. Test thoroughly with the examples in `examples/`
+
+Popular editors we'd love to see integrations for:
+- VS Code
+- Vim/Neovim
+- Emacs
+- Sublime Text
+- IntelliJ IDEA
+- Atom (if still relevant)
+
+## Grammar Reference
+
+All editor integrations should support these Gram language features:
+
+- **Subjects**: `[attributes]` and `[:type attributes]`
+- **Nodes**: `(attributes)`
+- **Relationships**: `->`, `--`, `<-`, `<--`, `<->`, `<-->`
+- **Data types**: strings, numbers, booleans, null, arrays, objects
+- **Annotations**: `@key(value)`
+- **Comments**: `//` line comments and `/* */` block comments
+- **Special literals**: measurements (`100km`), hex (`0xFF`), octal (`0755`)
+
+See the main [README.md](../README.md) and [examples/](../examples/) for complete syntax documentation.

package/editors/zed/README.md

@@ -0,0 +1,149 @@
+# Gram Language Support for Zed
+
+A [Zed](https://zed.dev) extension providing syntax highlighting and language support for [Gram notation](https://gram-data.github.io) - a subject-oriented notation for structured data.
+
+## Features
+
+- **Syntax Highlighting**: Full syntax highlighting for all Gram constructs including subjects, nodes, relationships, and data types
+- **Bracket Matching**: Automatic matching for `()`, `[]`, and `{}`
+- **File Type Detection**: Automatic recognition of `.gram` files
+- **Smart Indentation**: Proper indentation handling for nested structures
+
+## Installation
+
+### From Zed Extensions (Coming Soon)
+
+Once published, you'll be able to install directly from Zed:
+
+1. Open Zed
+2. Press `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Linux/Windows)
+3. Type "extensions" and select "zed: extensions"
+4. Search for "gram" and install
+
+### Manual Installation
+
+For now, install manually by copying the extension:
+
+```bash
+# Clone the repository if you haven't already
+git clone https://github.com/gram-data/tree-sitter-gram.git
+
+# Copy or symlink the extension to your Zed extensions directory
+# On macOS/Linux:
+ln -s $(pwd)/tree-sitter-gram/editors/zed ~/.config/zed/extensions/gram
+
+# On Windows:
+mklink /D "%APPDATA%\Zed\extensions\gram" "path\to\tree-sitter-gram\editors\zed"
+```
+
+Then restart Zed.
+
+## Usage
+
+Once installed, the extension automatically provides syntax highlighting for any file with a `.gram` extension.
+
+### Example Gram Syntax
+
+```gram
+// Simple subject with properties
+(:Person {
+  name: "Andreas",
+  age: 35,
+  roles: ["author", "developer"]
+})
+
+// Relationships between nodes
+(alice:Person {name: "Alice"})->(bob:Person {name: "Bob"})
+
+// Complex subject with annotations
+@type("Employee")
+[:Person {
+  id: 12345,
+  name: "John Doe",
+  department: "Engineering",
+  salary: 75000.50,
+  active: true,
+  skills: ["JavaScript", "Rust", "Python"]
+}]
+
+// Measurements and special values
+(:Measurement {
+  distance: 100km,
+  weight: 5.5kg,
+  temperature: -10.5celsius,
+  count: 0x1A,
+  nullable: null
+})
+```
+
+## Syntax Highlighting
+
+The extension provides highlighting for:
+
+- **Subjects**: `[...]` and `[:type ...]` brackets
+- **Nodes**: `(...)` parentheses
+- **Relationships**: `->`, `--`, `<-`, `<-->`, etc.
+- **Strings**: Single, double, and backtick quoted strings
+- **Numbers**: Integers, decimals, hex, octal, and measurements
+- **Booleans**: `true` and `false`
+- **Null**: `null` literal
+- **Comments**: `//` and `/* */`
+- **Operators**: `:`, `::`, `@`
+- **Properties**: Object keys and annotation keys
+- **Errors**: Invalid syntax
+
+## Development
+
+To work on this extension:
+
+1. Clone the main repository:
+   ```bash
+   git clone https://github.com/gram-data/tree-sitter-gram.git
+   cd tree-sitter-gram
+   ```
+
+2. Install as a dev extension in Zed:
+   - Open Zed command palette (`Cmd+Shift+P` / `Ctrl+Shift+P`)
+   - Run "zed: install dev extension"
+   - Select the `editors/zed` directory
+   - Restart Zed
+
+3. Make changes to the extension files
+4. Restart Zed to see changes
+
+### Extension Structure
+
+```
+editors/zed/
+├── extension.toml           # Extension metadata
+├── grammars/
+│   └── tree-sitter-gram/   # Grammar files
+│       ├── grammar.js      # Tree-sitter grammar definition
+│       └── src/            # Generated parser source
+├── languages/
+│   └── gram/
+│       ├── config.toml     # Language configuration
+│       └── queries/        # Syntax highlighting queries
+│           └── highlights.scm
+└── example.gram            # Example file for testing
+```
+
+## Contributing
+
+Contributions are welcome! Please see the main [repository](https://github.com/gram-data/tree-sitter-gram) for contribution guidelines.
+
+To improve syntax highlighting:
+1. Edit `languages/gram/queries/highlights.scm`
+2. Test with various Gram files
+3. Submit a pull request
+
+## License
+
+This extension is part of the tree-sitter-gram project and is licensed under the ISC License. See the main repository's [LICENSE](../../LICENSE) file for details.
+
+## Learn More
+
+- [Gram Data GitHub Organization](https://github.com/gram-data)
+- [Gram Notation Documentation](https://gram-data.github.io)
+- [Tree-sitter Grammar Repository](https://github.com/gram-data/tree-sitter-gram)
+- [Zed Editor](https://zed.dev)

package/editors/zed/example.gram

@@ -0,0 +1,89 @@
+(:Person {
+  name: "Andreas Kollegger",
+  age: 42,
+  active: true,
+  roles: ["author", "developer", "architect"]
+})
+
+(alice:Person {name: "Alice", department: "Engineering"})
+  -[:WORKS_WITH]->
+(bob:Person {name: "Bob", role: "Designer"})
+
+@version("1.0")
+@created("2024-01-15")
+[:Employee {
+  id: 12345,
+  name: "John Doe",
+  email: "john.doe@company.com",
+  department: "Engineering",
+  salary: 125000.75,
+  active: true,
+  started: "2023-01-15",
+  skills: ["JavaScript", "Rust", "Python", "Go"],
+  manager: 67890
+}]
+
+(client:Company {name: "ACME Corp"})
+  <-[:CONTRACTS]->
+(vendor:Company {name: "Tech Solutions Inc"})
+
+(user:Person {name: "Charlie"})-[:OWNS]->(car:Vehicle {
+  make: "Tesla",
+  model: "Model 3",
+  year: 2023
+}),
+(user)-[:LIVES_IN]->(city:Location {
+  name: "San Francisco",
+  state: "CA",
+  country: "USA"
+}),
+(user)-[:WORKS_FOR]->(company:Company {name: "Startup Inc"})
+
+(:DataTypes {
+  integer: 42,
+  negative: -17,
+  decimal: 3.14159,
+  scientific: 1.23e-4,
+  hexadecimal: 0xFF00,
+  octal: 0755,
+  binary: 0b1010,
+  distance: 100km,
+  weight: 5.5kg,
+  temperature: -10.5celsius,
+  time: 30min,
+  single_quoted: 'Hello World',
+  double_quoted: "Hello \"quoted\" World",
+  backtick: `Template string with ${variable}`,
+  is_active: true,
+  is_deleted: false,
+  optional_field: null
+})
+
+[
+  "The Pragmatic Programmer",
+  "Clean Code",
+  "Design Patterns"
+]
+
+(:Project {
+  name: "Gram Parser",
+  version: "0.1.11",
+  description: "A tree-sitter grammar for Gram notation",
+  repository: {
+    type: "git",
+    url: "https://github.com/gram-data/tree-sitter-gram"
+  },
+  dependencies: { tree-sitter: "^0.25.0", node-gyp-build: "^4.8.4" },
+  contributors: { Andreas: "maintainer", Community: "contributor" }
+})
+
+(:EdgeCases {
+  sample_array: ["example"],
+  sample_map: { a: 1 },
+  unicode: "Hello 世界 🌍",
+  escaped_chars: "Line 1\nLine 2\tTabbed",
+  special_symbols: "@#$%^&*()_+-=[]{}|;:,.<>?",
+  very_long_string: "This is a very long string that spans multiple conceptual lines to test how the syntax highlighter handles long content without breaking the highlighting engine or causing performance issues in the editor"
+})
+
+(::Double::Trouble)

package/editors/zed/extension.toml

@@ -0,0 +1,11 @@
+id = "gram"
+name = "Gram Language Support"
+version = "0.2.0"
+schema_version = 1
+authors = ["Gram Data Contributors"]
+description = "Support for Gram notation - a subject-oriented notation for structured data"
+
+# path = "grammars/tree-sitter-gram"
+[grammars.gram]
+repository = "https://github.com/gram-data/tree-sitter-gram"
+rev = "e419dbe99e299517f615f79616c836de4cb2550d"

package/editors/zed/languages/gram/config.toml

@@ -0,0 +1,16 @@
+name = "Gram"
+grammar = "gram"
+path_suffixes = ["gram"]
+autoclose_before = ")]}'\":.,;>"
+brackets = [
+  { start = "{", end = "}", close = true, newline = true },
+  { start = "[", end = "]", close = true, newline = true },
+  { start = "(", end = ")", close = true, newline = true },
+]
+word_characters = ["_"]
+
+[prettier]
+allowed = false
+
+# [language_servers]
+# Add language server configuration here if you develop one for Gram

package/editors/zed/languages/gram/highlights.scm

@@ -0,0 +1,79 @@
+; Strings
+(string_literal) @string
+(string_content) @string
+
+; Numbers
+(integer) @number
+(decimal) @number
+(hexadecimal) @number
+(octal) @number
+(measurement) @number
+
+; Boolean literals
+(boolean_literal) @boolean
+
+; Symbols and identifiers
+(symbol) @variable
+
+; Keywords and operators
+[
+    "@"
+    "|"
+    ":"
+    "::"
+] @operator
+
+; Brackets and delimiters
+[
+    "["
+    "]"
+    "("
+    ")"
+    "{"
+    "}"
+] @punctuation.bracket
+
+; Comma separator
+[
+    ","
+] @punctuation.delimiter
+
+; Field names in records and maps
+(property key: (symbol) @property)
+(property key: (string_literal) @property)
+(property key: (integer) @property)
+(mapping key: (symbol) @property)
+(mapping key: (string_literal) @property)
+(mapping key: (integer) @property)
+
+; Annotation keys
+(annotation key: (symbol) @attribute)
+
+; Annotations inside nodes
+(node annotations: (annotations) @attribute)
+
+; Annotations inside relationship arrows
+[
+    (right_arrow annotations: (annotations) @attribute)
+    (left_arrow annotations: (annotations) @attribute)
+    (undirected_arrow annotations: (annotations) @attribute)
+    (bidirectional_arrow annotations: (annotations) @attribute)
+]
+
+; Subject brackets (special highlighting)
+(subject) @type
+
+; Node with labels
+(node (labels (symbol) @type))
+
+; Relationship arrows (special highlighting for graph syntax)
+(relationship) @keyword
+
+; Arrow operators in relationships
+(right_arrow) @operator
+(left_arrow) @operator
+(undirected_arrow) @operator
+(bidirectional_arrow) @operator
+
+; Error highlighting
+(ERROR) @error

package/editors/zed/test.gram

@@ -0,0 +1,8 @@
+// Test Gram file for syntax highlighting
+(:Person {
+  name: "Test User",
+  age: 30,
+  active: true
+})
+
+(user:Person)-[:KNOWS]->(friend:Person {name: "Friend"})