Planning 1

[hacker-DOM]

Planning 1

UPDATE 23-09-19: The tool used to be called Ring when I was going to write it in Rust.

For the past few years, protocols have existed that allow us to parse and gain insights ab any language in a standardized way.

• Treesitter - originally developed by Atom Editor, this parser has found applications in:
  • Neovim
  • Emacs
  • Woke...
• Language Server Protocol (and family), used in pretty much every editor, is being expanded:
  • Build Server Protocol (building)
  • Debugger Adapter Protocol (debuggers)
  • LSIF (an index format for servicing LSP requests without running a server (by caching them)

There are a few tools trying to leverage this new standardization:

• computing structured diffs using Treesitter: https://github.com/Wilfred/difftastic/
• formatting with Treesitter: https://www.tweag.io/blog/2023-03-09-announcing-topiary/

---

I propose a development tool that would communicate with Treesitter parsers and language servers to provide a whole suit of tools. Here's a small list of everything we could make. We could use LSP if it is available and fallback to Treesitter if not.

---

For 1.0, we can assume that a particular language server is running (or at least installed?). Further on, we could add auto-install. Mason does this really well and already has a huge database of installation and setup instructions for language servers.

I'm guessing treesitter grammars are easy to install on the fly.

---

I think for MVP we should do:

• formatters
• mutation testing
• documentation generators

[hacker-DOM]

List of potential features

• printfs: also https://github.com/ThePrimeagen/refactoring.nvim#table-of-contents, https://github.com/andrewferrier/debugprint.nvim#alternative-feature-comparison
• call/reference graph
• logseq template
• printable template
• mutation testing
• doc generator
• trace debugger (& debugging animations with manim)
• formatter [already being worked on]

[hacker-DOM]

We should probably have a neovim mode which would use neovim's grammars and LSs (optional).

[hacker-DOM]

Neovim usage - we dont need separate neovim extension, I think the filter through an external program feature could suffice eg for the printfs (console logs) [i think it is ! be default].

[hacker-DOM]

Treesitter functionality would be very similar to printers/detectors in woke (python file with main and visitor functions (but can this handle mutations as well?)). Lsp functionality would have to be more thought-out. 💡 Provide api for sending requests

[hacker-DOM]

Lsp types (ordered)

• https://github.com/microsoft/lsprotocol - the best?
• https://github.com/openlawlibrary/pygls - well-updated
• woke - works
• https://github.com/yeger00/pylspclient

[hacker-DOM]

For reference: full post in Auditors channel (the tool used to be called Ring when I was going to write it in Rust):

Ok guys, here's a pitch of Ring.rs:

We have protocols to talk with all languages in the world - basically. Treesitter for parsing, build server protocol for compiling, debugger adapter protocol for.. debugging, language server protocol for semantic information

I want to make a tool that uses these protocols to create developer tooling for all programming languages at once. So the final developer tool we'll ever need - On ring to rule them all

First, I'd like to implement

• create a printable document with a list of references for each symbol - together with my printing method for code, this is all you'll need to grasp codebases offline
• create a Logseq template of the codebase
• function tracer - using treesitter, add "printf(function foo called with args: ...)" and "print('function exiting with value')" to every function in a file. In solidity this will use console.log, which is supported in woke, Hardhat and foundry. This will be a super-fast way to debug any language w/ zero development costs. Ex: yesterday, I was having trouble with the plugin nvim-terminal.lua. I ended up adding such printfs everywhere to see what's going on. In the near future, software will do this for me....

Later, we can do even more wild things:

• woke graph/dash for every language in the world
• visualizing debugging with manim animation framework
• trace debugger for every language
• formatter/documentation generator for every language (python has black and yapf, but i dont like either, so i want my own)

I was originally gonna write it in Go, but over weeks i've realized the potential of this tool and so I might as well write it in a hard language

CTA (Call to action) ❗️If you know a company that would like to sponsor this ($10k+) that would allow me to work on this full-time for months, pls help out