document LSH

[3052]

#624

please document the LSH here or somewhere - for example this question needs to be answered:

They're embedded and not configurable.

what does configurable mean in this context? can user just add another LSH file and compile again?

[DHowett]

can user just add another LSH file and compile again?

The person building edit can add another lsh file and compile edit again.

If that person is also the end user: yes.
If that person is not the end user: no, the end user cannot currently do so.

The languages are embedded at build time.

[3052]

you somehow managed to make this even more confusing:

If that person is also the end user: yes.
If that person is not the end user: no, the end user cannot currently do so.

what does this even mean? can you please just answer the question as asked:

can someone just add another LSH file and compile again?

[lhecker]

There seems to be a fundamental misunderstanding here.

As you've already said, the *.lsh files define the syntax highlighting. The files are compiled (!) into bytecode when you build this project. The executable then contains the bytecode, not the original source files. And since it's compiled in, you cannot add more LSH files after building the project. The executable is immutable after all. That makes sense right?

You can, however, add more LSH files before building the project. Just add any file you want into the crates/lsh/definitions folder and then run cargo build --release (or whatever).

[Consolatis]

I wonder what the overall plan is for syntax highlighting, Is the idea to add a regex engine on top of the LSH compiler so users could end up configuring their own regex rules? Or is the plan to keep the syntax highlighting built into the executable only.

[lhecker]

Technically speaking, LSH is a regex engine already, even if it's not super powerful.

For now, the plan is to keep the compiler outside of the final executable. The compiler is not vetted for security and may contain bugs. I wouldn't trust it to be 100% safe for any arbitrary *.lsh file yet.

If you have any language in mind that's decently popular (e.g. JS, Rust, Terraform) we're happy to merge any PRs you send our way.