Code Reader Core

Code Reader Core is the foundational core of a screen reader extension that can read out code in various programming languages in order to facilitate easier checking, troubleshooting, development and maintainence by low vision and blind developers.

Goals

In an attempt to avoid as much feature creep as possible, the basic goals for this project are as follows:

• Multiple Programming Language Support
• Speech Output in English, initially, with the goal of other Language outputs
• Initially focusing on VS Code with the plan of making the tool as IDE and language agnostic as possible
• Different levels of feedback and verbosity
• Initially build out with Speech Dispatcher for basic readout of code

Example of Intention

The ideal output would be based on the requested level of verbosity. A simplified example can be as follows:

Code to be Read:

Rust Example

def calculate_total(price: float, tax_rate: float) -> float:
  return price * (1 + tax_rate)

Java Example

public float calculateTotal(float price, float taxRate) {
  return price * (1 + taxRate);
}

Basic Intended Speech Output should both be:

"Function calculate total. Parameters: price, float; tax_rate, float. Returns float."

It is worth noting that characters such as (, ), _, etc. can be excluded from the speech output for a more natural sounding speech.

Artificial Intelligence (AI) Usage Disclosure

As I am blind, I have found that using AI to check behind me with my code to be extremely useful. Whilst I do not intend to vibe-code this application, I believe that it is important to disclose when AI is used in one's production pipeline. As such, this disclosure should serve as an indication that this project is being created with the assistance of Artificial Intelligence, but that the code is not being solely "created" and "provided" by the Artificial Intelligence that is being used.

An attempt has not been made to verify the usage of AI in the development of Dependencies or Visual Studio Code Extensions.

Rust Comprehension Disclosure

It is important to note that this is the first project that I have ever made with Rust. I appreciate any and all constructive feedback from various members of the programming community with how I can improve the code that I am writing.

Dependencies Used

This list should not be considered exhaustive until the completion of this project. This list will be updated as the project evolves. The names of the extensions, their license and any links to repositiories shall be provided. In order to best track the relations between packages, I am going to try to make sure that I cite every package noted in the Cargo.lock file.

• aho-corasick
  • Author: Andrew Gallant
  • Licenses: MIT License, Unlicense,
  • Repo Link: https://github.com/BurntSushi/aho-corasick
• cc-rs
  • Author: Alex Crichton
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/cc-rs
• crates.io
  • Author: The Rust Project Developers
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/crates.io
• equivalent
  • Author: indexmap-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/indexmap-rs/equivalent
• find-msvc-tools
  • Author: Alex Crichton
  • Licenses: Apache 2.0, MIT License
  • Source Link: https://docs.rs/crate/find-msvc-tools/
• hashbrown
  • Author: Amanieu d'Antras
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/hashbrown
• indexmap
  • Author: indexmap-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/indexmap-rs/indexmap
• itoa
  • Author: David Tolnay
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/dtolnay/itoa
• memchr
  • Author: Andrew Gallant
  • Licenses: MIT License, Unlicense,
  • Repo Link: https://github.com/BurntSushi/memchr
• proc-macro2
  • Author: David Tolnay
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/dtolnay/proc-macro2
• quote
  • Author: David Tolnay
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/dtolnay/quote
• regex
  • Author: The Rust Project Developers
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/regex
• regex-automata
  • Author: The Rust Project Developers
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/regex/tree/master/regex-automata
• regex-syntax
  • Author: The Rust Project Developers
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/regex/tree/master/regex-syntax
• serde
  • Author: serde-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/serde-rs/serde
• serde_core
  • Author: serde-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/serde-rs/serde_core
• serde_derive
  • Author: serde-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/serde-rs/serde/tree/master/serde_derive
• serde_json
  • Author: serde-rs
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/serde-rs/serde
• shlex
  • Author: Nicholas Allegra (comex)
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/comex/rust-shlex
• streaming-iterator
  • Author: Steven Fackler
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/sfackler/streaming-iterator
• tree-sitter
  • Author: Max Brunsfeld
  • Licenses: MIT License
  • Repo Link: https://github.com/tree-sitter/tree-sitter
• tree-sitter-language
  • Author: Max Brunsfeld
  • Licenses: MIT License
  • Repo Link: https://github.com/tree-sitter/tree-sitter/tree/master/crates/language
• tree-sitter-python
  • Author: Max Brunsfeld
  • Licenses: MIT License
  • Repo Link: https://github.com/tree-sitter/tree-sitter-python
• unicode-ident
  • Author: David Tolnay
  • Licenses: Apache 2.0, MIT License, Unicode License V3
  • Repo Link: https://github.com/dtolnay/unicode-ident
• zmij
  • Author: David Tolnay
  • License: MIT License
  • Repo Link: https://github.com/dtolnay/zmij

Visual Studio Code Extensions Used

This list should not be considered exhaustive until the completion of this project. This list will be updated as the project evolves. The names of the extensions, their license and any links to repositiories shall be provided.

• CodeLLDB
  • Author: Vadim Chugunov
  • License: MIT License
  • Repo Link: https://github.com/vadimcn/codelldb/
• Codex - OpenAI's coding agent
  • Author: OpenAI
  • License: Apache 2.0
  • Repo Link: https://github.com/openai/codex
• Dependi
  • Author: Fill Labs
  • License: Custom License
  • Repo Link: https://github.com/filllabs/dependi
• Error Lense
  • Author: Alexander
  • License: MIT License
  • Repo Link: https://github.com/usernamehw/vscode-error-lens
• ESLint
  • Author: Microsoft
  • License: MIT License
  • Repo Link: https://github.com/Microsoft/vscode-eslint
• Even Better TOML
  • Author: tamasfe
  • License: MIT License
  • Repo Link: https://github.com/tamasfe/taplo
• markdownlint
  • Author: David Anson
  • License: MIT License
  • Repo Link: https://github.com/DavidAnson/vscode-markdownlint
• Prettier - Code formatter
  • Author: Prettier
  • License: MIT License
  • Repo Link: https://github.com/prettier/prettier-vscode
• rust-analyzer
  • Author: rust-lang
  • Licenses: Apache 2.0, MIT License
  • Repo Link: https://github.com/rust-lang/rust-analyzer
• Vitest
  • Author: Vitest
  • License: MIT License
  • Repo Link: https://github.com/vitest-dev/vscode