Skip to content

Coding Style

We recommend to follow these guidelines when writing code for rolldown. They aren't very strict rules since we want to be flexible and we understand that under certain circumstances some of them can be counterproductive. Just try to follow as many of them as possible:

Namings

Rust

We tend to follow the suggestions of Rust API Guidelines. They are authored largely by the Rust library team, based on experiences building the Rust standard library and other crates in the Rust ecosystem.

We understand that there are cases that rules don't apply, but you should try to follow them as much as possible.

Adding tests

In generate, we have two environments for running different purposes of tests. See Testing for more information.

We enquire that you should first considering adding tests in rust side, because

  • It has better debugging support without considering bridge between rust and js.
  • It has faster development cycle due to no need to compile the binding crate and run Node.js.

You could consider adding tests in Node.js with the following reasons:

  • The test is about the behavior of the JavaScript API.
  • The test is about the behavior of the rolldown package itself.
  • e2e tests.

Released under the MIT License.