stevefan1999-personal/den

Den - One word less than Deno!

Den: One word less than Deno!

Just another Rust hobbyist project to learn how to make a JS runtime!

Made during the Easter holiday of 2023.

Features

Build instruction

Steps

Run the following command to get a debug build:

$ cargo build

Run the following command to get an optimized release build:

$ cargo build --release

Or choose the min-size-release profile to get a size-favored build:

$ cargo build --profile min-size-release

Meanwhile, Den will not attempt to make code smaller intentionally, we will and should let the compiler do the job. If you want to optimize even further, the easiest way is to run build-std. You can headout to the min-sized-rust guide for more.

(WIP) In addition, you can also install it as a binary:

$ cargo install den

Build matrix

State of the build:

Architecture➡️ Platform⬇️	i386	amd64	arm32	arm64	ppc64le	s390x
Windows	❓	✔️	🤷	❓	🤷	🤷
Linux	❓	❓	❓	❓	❓	❓
MacOS	🤷	❓	🤷	❓	🤷	🤷
FreeBSD	❓	❓	❓	❓	❓	❓
Android	🤷	❓	🤷	❓	🤷	🤷
iOS	🤷	🤷	🤷	❓	🤷	🤷

in the format of [<state> - <emoji> (<emoji text>): <description>]

• Perfect - ✅ (greenlit tick)
  • Unit/Integration/E2E tests AC (all cleared)
  • Can be chosen as RC builds
  • Official Docker builds are available for end user
• Choked - ❎ (greenlit cross)
  • Unit/Integration tests failure
  • Implies Passed
  • Should be somewhat usable at this point
• Passed - ✔️ (non-greenlit tick)
  • Build passed
  • Build artifacts maybe provided
• Failed - ❌ (non-greenlit cross)
  • Build failure
• Unknown - ❓ (question mark)
  • Possible but not investigated
• Undefined - 🤷 (shrug)
  • Don't care condition/Impossible/Not applicable

TODO: write a bot that automatically updates the status from CI/CD pipeline, change the format to a markdown table.

TODO: add a triplet table to complete the build matrix/cube a format of architecture-platform [cartesian product] compiler

TODO: put the explanations to the design document. Only put the build cube in the frontpage but keep a link to the design document.

TODO LIST

Note that this project is still in its pre-alpha and subjects to major re-architect. Den can run for now but it is not yet functional and reliable. I expect this to be at least yearlong to come and I hope I have enough free time to spend on it.

There are still a lot of bugs that needs to be addressed before it can be deemed functional:

• MAKE SOME UNIT TESTS AND INTEGRATION TESTS
• Detect when the task list is empty and is safe to shutdown (like Node)
• Make it easily embeddable to other Rust projects
  • Remove the need for the global state. There is only one so far and that is the "global cancellation token"
  • This is also important because we can reuse it to test the standard library
  • Better yet, integrate some crates and libraries to upstream rquickjs so everybody can enjoy
• Finish up the standard libraries
  • Rewrite RegExp using rust-lang/regex
  • Rewrite BigInt, BigFloat and BigDecimal using rust-num/num
    • Although I hardly doubt it will work because bignum is a language-level construct
• Mark more parts of the code as features and let user to selective include them
• Filling up comments and documentations once it is stable in the future (I hope so)
• Figure out how to expose Rust modules as one big module. You don't want to cherrypick each exposed Rust rquickjs module in one big Rust module
• Add GH Actions manifests to automate CI/CD workflow such as linting, testing and build release
  • Should have had ran rustfmt before pushing
• Add GH Workspace config or Nix to have consistent build environment
• Add tracing support and also instruments

Contributors