https://github.com/brianhicks/tree-db

https://github.com/brianhicks/tree-db

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brianhicks/tree-db
• Owner: BrianHicks
• License: mit
• Created: 2023-01-12T20:01:08.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-18T11:15:29.000Z (almost 2 years ago)
• Last Synced: 2024-12-09T19:53:43.406Z (14 days ago)
• Language: Rust
• Size: 138 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tree-db

Transforms a project's source AST into a database you can query!

## Building

1. Have the [Nix](https://nixos.org/) package manager installed (NixOS not required.)

2. Check out the source

3. Run `nix build .#tree-db-full`

If you just want grammars, you can build them like `nix build .#grammars.tree-sitter-rust`.

Look in `flake.nix` for a full list.

If you want a development environment, type `nix develop`.

I recommend having `direnv` installed for this, as there's instructions for easy shells in the repo already.

## Schema

`tree-db` can emit a [Cozo](https://www.cozodb.org/) database or SQLite backup, depending on the command (run `tree-db help export` for full documentation or to export this schema.)

```

{:create nodes {

    path: String,

    id: Int,

    =>

    kind: String,

    is_error: Bool,

    source: String?,

}}

{:create node_locations {

    path: String,

    id: Int,

    =>

    start_byte: Int,

    start_row: Int,

    start_column: Int,

    end_byte: Int,

    end_row: Int,

    end_column: Int,

}}

{:create edges {

    path: String,

    parent: Int,

    child: Int,

    field: String?,

}}

```

The schema in this file is only provided for convenience and understanding, though.

See `tree-db export cozo-schema` for the schema that your installed version of `tree-db` actually works with.

## Stability

`tree-db` is pre-1.0.0 software, and not yet completely stabilized.

Here are the big things that might change:

1. The schema that `tree-db` generates might change once I've used it in a couple of places.

1. I'm not sure where it should live (GitHub might only be temporary)

## Contributing

This is a personal project right now.

I've got some ideas about how to make it work well, but this is more-or-less an experiment that I'm doing in public.

Feel free to open issues if you give this a try, but PRs probably don't make sense yet (unless we talk first.)

## License

MIT.

See `LICENSE`.