JSPM

  • Created
  • Published
  • Downloads 79
  • Score
    100M100P100Q77029F
  • License BSD-3-Clause

Ariana CLI - A tool for code instrumentalization and execution with observability

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ariana) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Ariana

    Ariana is an IDE extension and CLI tool to debug your JS/TS code in development way faster than with a traditional debugger or console.log statements.

    Features:

    • πŸ“‘ Overlay recent execution traces on top of your code
    • πŸ•΅οΈ Inspect values taken by expressions in your code
    • ⏱️ See how long it took for any expression in your code to run

    How to use

    1) πŸ’Ύ Install the ariana CLI

    With npm:

    npm install -g ariana

    With pip:

    pip install ariana

    2) ✨ Run supported code as you would from the command line but with the ariana command along side it

    ariana <run command>

    For example, on a Node.js codebase it could be:

    ariana npm run dev

    3) πŸ‘Ύ In your IDE, get instant debugging information in your code files.

    You can install the extension on the VSCode Marketplace, or by searching for Ariana in the extensions tab in VSCode or Cursor.

    • Open a code file, press ctrl + shift + p and search for the Ariana: Toggle Traced Expressions Highlighting command.
    • πŸ—ΊοΈ Know which code segments got ran and which didn't
    • πŸ•΅οΈ Inspect the values that were taken by any expression in your code

    Demo part 2

    Optional: If you just want to try out Ariana on example piece of code before using it on your own code, you can do this:

    git clone https://github.com/dedale-dev/node-hello.git
    cd node-hello
    npm i
    ariana npm run start

    Troubleshooting / Help

    πŸ˜΅β€πŸ’« Ran into an issue? Need help? Shoot us an issue on GitHub or join our Discord community to get help!

    Requirements

    For JavaScript/TypeScript codebases

    • A JS/TS node.js/browser codebase with a package.json
    • The ariana command installed with npm install -g ariana (or any other installation method)

    Supported languages/tech

    Language Platform/Framework Status
    JavaScript/TypeScript Node.js βœ… Supported
    Bun βœ… Supported
    Deno βš—οΈ Experimental
    Browser Frameworks
    JavaScript/TypeScript React βš—οΈ Experimental
    JQuery/Vanilla JS βœ… Supported
    Vue/Svelte/Angular ❌ Not supported (yet)
    Other Languages
    Python All platforms 🚧 In development

    Code processing disclaimer

    We need to process (but never store!) your JS/TS code files on our server based in EU in order to have Ariana work with it. It is not sent to any third-party including any LLM provider. An enterprise plan will come later with enterprise-grade security and compliance. If that is important to you, please let us know.