Code-shape

![crates.io badge]

Code-shape is a tool that uses [Tree-sitter] to extract a shape of code definitions from a source code file. The tool uses the same language parsers that are installed for Tree-sitter CLI.

Installation

To install the code-shape CLI it's possible to use Rust's Cargo package manager:

sh cargo install code-shape

Usage

To start using the tool it's needed to do some preparation.

Prerequsites

1. Install Tree-sitter CLI.
2. Run tree-sitter init-config that creates a config file like ~/.config/tree-sitter/config.json in Tree-sitter's [config dir].
3. Create a directory where installed parsers would be located and add it in "parser-directories" list in Tree-sitter's config file.
4. Clone Tree-sitter parsers for required languages to the parsers directory.

Define extraction query

To make it possible to extract a shape of definitions from some source code file for some language, it's needed to define a [query]. To define a new query create a file in a Code-shape's languages [config dir] ~/.config/code-shape/languages/ with an .scm suffix like ~/.config/code-shape/languages/c.scm and put there a set of Tree-sitter [query] patterns like:

```scheme ; C language function declarations (declaration [ (functiondeclarator declarator: (identifier) @fn.declaration.name ) ( (function_declarator declarator: (identifier) @fn.declaration.name ) ) ] )

; C language function pointer declarations (declaration [ (initdeclarator (functiondeclarator (_ (_ declarator: (identifier) @fn.pointer.declaration.name)) ) ) (initdeclarator ( (functiondeclarator ( (_ declarator: (identifier) @fn.pointer.declaration.name)) ) ) ) ] )

; C language function definitions (functiondefinition [ (functiondeclarator declarator: (identifier) @fn.name ) (_ (functiondeclarator declarator: (identifier) @fn.name ) ) ] body: () @fn.scope )

```

It's needed to define captures with special names:

• <type>.name is a capture where the type may be, e.g., fn, class or anything else to match a code entity name.
• <type>.scope is a special capture that allows for the tool to capture a context of entities and usually are tokens that defines a body of the the entity, e.g., a function body.

Examples of the tool output:

```sh

code-shape --scope source.c tree-sitter/lib/src/alloc.c

fn tsmallocdefault fn tscallocdefault fn tsreallocdefault fn.pointer.declaration tscurrentmalloc fn.pointer.declaration tscurrentcalloc fn.pointer.declaration tscurrentrealloc fn.pointer.declaration tscurrentfree fn tssetallocator

code-shape examples/foo.c

fn.declaration tsmallocdefault fn.declaration tscallocdefault fn.declaration tsreallocdefault fn.pointer.declaration tscurrentmalloc fn.pointer.declaration tscurrentcalloc fn.pointer.declaration tscurrentrealloc fn.pointer.declaration tscurrentfree fn foo fn bar

code-shape examples/foo.py

class Foo def foo def bar def inner def one def two def wrap class Baz class Bar class Foo def func1 def func2 def three def four ```

Embedded shape queries

For now the tool has builtin shape queries for the following language parsers:

• C
• Python