novusnota / prism-ton

🔺 Maintained set of TON programming language definitions/grammars for Prism.js

prism-ton

🔺 Maintained set of TON blockchain programming language definitions for Prism.js

• ⚡ Tact — https://tact-lang.org
• 💎 FunC — https://docs.ton.org/develop/func/overview
• 📚 Fift — https://docs.ton.org/develop/fift/overview
• 📄 TL-B — https://docs.ton.org/develop/data-formats/tl-b-language

Initialization

Upon cloning this repo, invoke the following commands in order of appearance (but just once!):

1. yarn prism:init — initializes the prismjs/prism submodule and installes it's dependencies
2. yarn prism:links — creates all the necessary symbolic links from local files to the prismjs/prism submodule
3. yarn prism:build — builds all the grammars and everything there is in prismjs/prism

Layout

Grammar files are located in langs/X files, where X can be one of:

• prism-tact.js — Tact grammar
• prism-func.js — FunC grammar
• prism-fift.js — Fift grammar
• prism-tlb.js — TL-B grammar

Test files are located in tests/X folders, where X can be one of:

• tact — Tact tests
• func — FunC tests
• fift — Fift tests
• tlb — TL-B tests

Running tests

Once initialized, you'll be able to run tests for each language in this repo, namely:

• yarn test-tact will run tests for Tact
• yarn test-func will run tests for FunC
• yarn test-fift will run tests for Fift
• yarn test-tlb will run tests for TL-B

And yarn test runs all those tests in succession.

Workflow

The workflow looks like this:

1. Add changes to the grammar
2. See how it works by opening the .github/submodule-prism/test.html file in the browser
3. Add/update tests
4. Execute and modify tests until they pass :)
5. Commit & push
6. Make PRs to:

• ton-community/ton-docs
• TelegramMessenger/libprisma
• prismjs/prism

Prism.js docs: https://prismjs.com/extending.html Awesome RegExp visualization tool: https://regex101.com

TODO

• Github Actions checks akin to ones in prismjs/prism
• Pre-push hooks with mandatory builds & tests -> push shall be stopped in case of errors

Credits

Based on The Open Network.

Made & maintained with 🤍 by Novus Nota.

License

MIT

prism-ton's Issues

Make a new PR to `TelegramMessenger/libprisma`

With:

• Tact 1.4.0 (#5)
• FunC 0.4.4 (#1)

Update Tact to v1.3.0

See: tact-lang/tact#280

Applicable list of changes:

• Fixed precedence levels for bitwise operators, equality and comparisons. Now the precedence levels match common languages like JS/TS.
• Support for string escape sequences: \\, \", \n, \r, \t, \v, \b, \f, \u{0} through \u{FFFFFF}, \u0000 through \uFFFF, \x00 through \xFF.
• Bitwise XOR (^) operator.
• try {...} and try {...} catch {...} statements.
• foreach loop for the Map type: foreach (k, v in map) {...}.
• Trailing commas for all comma-separated lists.

Create a grammar for Type Language (`TL`)

Although it's used less in TON contexts than TL-B, it's still useful for structuring useful data for communications.

Related links:

• https://docs.ton.org/develop/data-formats/tl
• https://github.com/ton-blockchain/ton/tree/master/tl/generate/scheme
• https://core.telegram.org/mtproto/TL

Update FunC to 0.5.0

See:

• History https://docs.ton.org/develop/func/changelog
• Sources https://github.com/ton-blockchain/ton/tree/master/crypto/func
• 0.5.0 update ton-blockchain/ton#1026
• Highlight.js PR orbs-network/highlightjs-func#1

Tracking issue:

• Updated Prism.js grammar here
• PR to https://github.com/TelegramMessenger/libprisma
• PR to https://github.com/ton-community/ton-docs

Tracking issue: Tact v1.4.0

To be resolved by: #6

• Bitwise NOT ~
• New augmented assignment operators: |=, &=, ^=
• Underscores _ as unused variable identifiers
• As a bonus: start highlighting variables as well