razetime / bqn-vscode

BQN programming language vscode plugin (symbol input, syntax highlighting)

BQN VS Code plugin

This VS Code extension provides language support for BQN.

It is available on the Open VSX Registry and the VS Code Marketplace.

Setup

This extension has a focus on the CBQN implementation. The REPLXX=1 option must be enabled during building for best results.

Configurable Settings

You can add these settings to your settings.json file to disable some of the default behaviours of this extension.

• bqn.executablePath - Path to the CBQN executable e.g. /home/username/CBQN/BQN.
• bqn.saveBeforeLoadScript - Whether vscode should save the script before loading it into the CBQN REPL.
• bqn.sendToNewReplDelay - How long vscode should wait before sending text to a repl.
• bqn.executableSupportsReplxx - Marks whether the executable set in bqn.executablePath is built with replxx support.
• bqn.pendingBackslashBackgroundColor - Style customization feature for backslash completion.
• bqn.enableBackslashCompletion - true by default. If you have an extension that interferes with backslash completion (e.g. Vim keybindings), please set this to false and use a system-wide method.
• bqn.enableHoverDocumentation - Controls whether documentation will be displayed for a symbol on mouseover.

Features

Current

• Syntax highlighting.
• Backslash symbol completion (\r -> ↑) using the standard BQN keymap, like in the online REPL.
• Symbol completion by function name (take<tab> -> ↑).
• Help popups when hovering over glyphs.
• File, line, and selection execution in the integrated terminal (from @suhr and @mk12). This requires having a bqn executable in your PATH, or customizing the bqn.executablePath setting.

Planned

• Block context highlighting for symbols like 𝕨 and 𝕣.
• Inline code execution similar to nvim-bqn.
• CBQN WASM interpreter bundled with the extension.
• Add a symbol table to the sidebar for clickable BQN symbols.

bqn-vscode's Issues

Add completion by function name

Would it be possible to add a completion based on function name, akin to BQNPAD completion? It really lowers the barrier of entry, when you can type shape and get a correct symbol, when you don't remember them all by heart yet.

BQN icon not shwon

For some reason, the icon for BQN files is not shown in the file explorer panel.

Add proper keyboard expansion outside intellisense

Minor discoloring with ‿

First line has first Hello being blue, second is white, and _hello is also white.
Second and third line show that for underscore names it's broken in a similar way.

theoretically you should write arrays of vars with lowercase and no underscores anyways, but sometimes i want to signify that an array of values will be used as functions, or just a specific value.

Dubble struck character description not showing

when i hover over a double struck character, the descriptions aren't showing. I haven't tested all symbols, but after testing all double struck characters 𝕩𝕏𝕗𝔽𝕘𝔾𝕣 and a few other non struck symbols, it seems only the double strucked are broken.

How to add strand using backslash?

Forgive my ignorance, but I am trying to add ‿ using the vscode extension, but aside from ctrl-space and searching, I can't seem to get it to work.

Would love some pointers here, and thank you for such a great extension!!

Syntax highlighting breaks with bracket in single quotes

This happens with all 3 bracket types (parentheses, curly braces, and square brackets) and really bugs me. Many thanks for your work on this excellent extension!

Latin1 characters aren't added yet

Latin1 characters (àáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞ) don't seem to be highlighted correctly
Example:

(note, that π isn't broken. It only appears green because the character before it is broken)

Add the BQN tag

So the project could be found on https://github.com/topics/bqn

[request] Upload on Open VSX registry

Open-VSX is an alternate extension marketplace that's used by default for vscodium users and people running Arch Linux. It'd be nice if you made this extension available there as well.

How to tell vscode about bqn?

This is my settings.json

"security.workspace.trust.untrustedFiles": "open",
"window.zoomLevel": 2

}

{
"editor.formatOnSave": true,
"haskell.hlint.logLevel": "warn",
"haskell.hlint.run": "onSave",
"haskell.formattingProvider": "ormolu",
"bqn.executablePath": "/usr/local/bin/bqn",

// May be necessary

// "haskell.hlint.executablePath": ""
}

on my Ubuntu 22.10. But it errors out with Ctr-Shift-Enter with The terminal process failed to launch: Path to shell executable "cbqn" does not exist. Should I just do a symbolic link? Total Beginner to vscode, BTW.

Link on gliph description isn't working

I'm on windows, and when i click the "Pervasive" link it asks me to create a file "arthmetic.md" at location "C:\doc".

System Function descriptions don't show

Hovering over system functions like •Out doesn't show their description - it would be nice to have these as well.

Word completion includes too many characters

VS Code has a word completion feature that looks at words that are in any of the currently open files. For BQN, it includes characters that aren’t part of the identifier:

bqn-vscode-word-completion.mp4

In the above screen capture, the expected word completions are modifier1 and modifier2.

Another feature of VS Code is to highlight the word that the cursor is currently on. This seems to include too many characters as well, and this is probably caused by the same:

Using BQN language v0.1.5.

Bow Tie \Z added?

The fork upstream fixing? Pull request or abandonware, as it would affect my source tree decision.

Scaler characters show as blue

Scalar characters like 'a' and 'b' show as blue. it'd make more sense for them to be orange like "a" and "b".

Backslash substitution does not work properly when Vim extension is enabled

When used together with the Vim extension, if the cursor is before a character, completing a backslash substitution places the cursor after that character, instead of after the newly inserted character. For instance, in the below screen capture, the cursor is expected to be positioned before the f instead of after the f after the substitution:

bqn-vscode-cursor.mp4

Another issue is that, when entering a command (press : in normal mode), backslashes cannot be inserted into the command; they are instead inserted into the file:

bqn-vscode-backslash.mp4

Using BQN language v0.1.5 and Vim v1.26.0.

Character insertion when using vim plugin

I am using the vim plugin. I don't know if this is an issue with them or with this plugin, or just the interactions between the two.
When I want to insert a bqn primitive to the left of some other text, the cursor jumps one character too far to the right.

E.g. If I have a file with contents:

Hello, World!

If the cursor is between the o and r in world, and I want to type a special character like ↕, the cursor ends up between r and l, instead of still being before r.

Curiously, this only happens when entering some characters. The 'double letters' like 𝕩 and 𝕎 don't have the same problem.

some backlash escapes don't function

\+, \-, \= and \8 don't work. other escapes like \_ and \m do, however

names infront of dubblestrucks lose color highlighting

Example would be

E←+
•Show 3{𝕩E𝕨}12

E here is colored white instead of blue

Syntax highlighting not working properly.

Hello,

Coming from BQNpad I expected a similar experience in VSCode, colour-wise. However, I can't seem to get BQN's syntax highlighting to work. Here's how it look:

Is anyone else having this issue?

Input by primitive name

I'm a beginner and I can't remember how to type the primitives, and looking them up all the time is too time-consuming. I wonder if there is a solution to this.

In some other languages, I can type \circ to get the ∘ symbol. I realize there's a conflict between having \c immediately converting to ↓ versus it being the start of \circ, but I wonder if there's some way to get functionality that's similar in spirit. Perhaps a separate mode for primitive-name entry where it doesn't convert until I press tab, or a separate prefix key for verbose entry.