Contributing.md

   1 # Contributing
   2
   3 There are many ways to contribute to Rustfmt. This document lays out what they
   4 are and has information for how to get started. If you have any questions about
   5 contributing or need help with anything, please ping nrc on irc, #rust-dev-tools
   6 on irc.mozilla.org is probably the best channel. Feel free to also ask questions
   7 on issues, or file new issues specifically to get help.
   8
   9 All contributors are expected to follow our [Code of
  10 Conduct](CODE_OF_CONDUCT.md).
  11
  12 ## Test and file issues
  13
  14 It would be really useful to have people use rustfmt on their projects and file
  15 issues where it does something you don't expect.
  16
  17 A really useful thing to do that on a crate from the Rust repo. If it does
  18 something unexpected, file an issue; if not, make a PR to the Rust repo with the
  19 reformatted code. We hope to get the whole repo consistently rustfmt'ed and to
  20 replace `make tidy` with rustfmt as a medium-term goal. Issues with stack traces
  21 for bugs and/or minimal test cases are especially useful.
  22
  23 See this [blog post](http://ncameron.org/blog/rustfmt-ing-rust/) for more details.
  24
  25
  26 ## Create test cases
  27
  28 Having a strong test suite for a tool like this is essential. It is very easy
  29 to create regressions. Any tests you can add are very much appreciated.
  30
  31 The tests can be run with `cargo test`. This does a number of things:
  32 * runs the unit tests for a number of internal functions;
  33 * makes sure that rustfmt run on every file in `./tests/source/` is equal to its
  34   associated file in `./tests/target/`;
  35 * runs idempotence tests on the files in `./tests/target/`. These files should
  36   not be changed by rustfmt;
  37 * checks that rustfmt's code is not changed by running on itself. This ensures
  38   that the project bootstraps.
  39
  40 Creating a test is as easy as creating a new file in `./tests/source/` and an
  41 equally named one in `./tests/target/`. If it is only required that rustfmt
  42 leaves a piece of code unformatted, it may suffice to only create a target file.
  43
  44 Whenever there's a discrepancy between the expected output when running tests, a
  45 colourised diff will be printed so that the offending line(s) can quickly be
  46 identified.
  47
  48 Without explicit settings, the tests will be run using rustfmt's default
  49 configuration. It is possible to run a test using non-default settings in several
  50 ways. Firstly, you can include configuration parameters in comments at the top
  51 of the file. For example: to use 3 spaces per tab, start your test with
  52 `// rustfmt-tab_spaces: 3`. Just remember that the comment is part of the input,
  53 so include in both the source and target files! It is also possible to
  54 explicitly specify the name of the expected output file in the target directory.
  55 Use `// rustfmt-target: filename.rs` for this. You can also specify a custom
  56 configuration by using the `rustfmt-config` directive. Rustfmt will then use
  57 that toml file located in `./tests/config/` for its configuration. Including
  58 `// rustfmt-config: small_tabs.toml` will run your test with the configuration
  59 file found at `./tests/config/small_tabs.toml`. The final option is used when the
  60 test source file contains no configuration parameter comments. In this case, the
  61 test harness looks for a configuration file with the same filename as the test
  62 file in the `./tests/config/` directory, so a test source file named `test-indent.rs`
  63 would need a configuration file named `test-indent.toml` in that directory. As an
  64 example, the `issue-1111.rs` test file is configured by the file
  65 `./tests/config/issue-1111.toml`.
  66
  67
  68 ## Hack!
  69
  70 Here are some [good starting issues](https://github.com/rust-lang-nursery/rustfmt/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue).
  71
  72 If you've found areas which need polish and don't have issues, please submit a
  73 PR, don't feel there needs to be an issue.
  74
  75
  76 ### Guidelines
  77
  78 Rustfmt bootstraps, that is part of its test suite is running itself on its
  79 source code. So, basically, the only style guideline is that you must pass the
  80 tests. That ensures that the Rustfmt source code adheres to our own conventions.
  81
  82 Talking of tests, if you add a new feature or fix a bug, please also add a test.
  83 It's really easy, see above for details. Please run `cargo test` before
  84 submitting a PR to ensure your patch passes all tests, it's pretty quick.
  85
  86 Please try to avoid leaving `TODO`s in the code. There are a few around, but I
  87 wish there weren't. You can leave `FIXME`s, preferably with an issue number.
  88
  89
  90 ### A quick tour of Rustfmt
  91
  92 Rustfmt is basically a pretty printer - that is, its mode of operation is to
  93 take an AST (abstract syntax tree) and print it in a nice way (including staying
  94 under the maximum permitted width for a line). In order to get that AST, we
  95 first have to parse the source text, we use the Rust compiler's parser to do
  96 that (see [src/lib.rs](src/lib.rs)). We shy away from doing anything too fancy, such as
  97 algebraic approaches to pretty printing, instead relying on an heuristic
  98 approach, 'manually' crafting a string for each AST node. This results in quite
  99 a lot of code, but it is relatively simple.
 100
 101 The AST is a tree view of source code. It carries all the semantic information
 102 about the code, but not all of the syntax. In particular, we lose white space
 103 and comments (although doc comments are preserved). Rustfmt uses a view of the
 104 AST before macros are expanded, so there are still macro uses in the code. The
 105 arguments to macros are not an AST, but raw tokens - this makes them harder to
 106 format.
 107
 108 There are different nodes for every kind of item and expression in Rust. For
 109 more details see the source code in the compiler -
 110 [ast.rs](https://dxr.mozilla.org/rust/source/src/libsyntax/ast.rs) - and/or the
 111 [docs](https://doc.rust-lang.org/nightly/nightly-rustc/syntax/ast/index.html).
 112
 113 Many nodes in the AST (but not all, annoyingly) have a `Span`. A `Span` is a
 114 range in the source code, it can easily be converted to a snippet of source
 115 text. When the AST does not contain enough information for us, we rely heavily
 116 on `Span`s. For example, we can look between spans to try and find comments, or
 117 parse a snippet to see how the user wrote their source code.
 118
 119 The downside of using the AST is that we miss some information - primarily white
 120 space and comments. White space is sometimes significant, although mostly we
 121 want to ignore it and make our own. We strive to reproduce all comments, but
 122 this is sometimes difficult. The crufty corners of Rustfmt are where we hack
 123 around the absence of comments in the AST and try to recreate them as best we
 124 can.
 125
 126 Our primary tool here is to look between spans for text we've missed. For
 127 example, in a function call `foo(a, b)`, we have spans for `a` and `b`, in this
 128 case there is only a comma and a single space between the end of `a` and the
 129 start of `b`, so there is nothing much to do. But if we look at
 130 `foo(a /* a comment */, b)`, then between `a` and `b` we find the comment.
 131
 132 At a higher level, Rustfmt has machinery so that we account for text between
 133 'top level' items. Then we can reproduce that text pretty much verbatim. We only
 134 count spans we actually reformat, so if we can't format a span it is not missed
 135 completely, but is reproduced in the output without being formatted. This is
 136 mostly handled in [src/missed_spans.rs](src/missed_spans.rs). See also `FmtVisitor::last_pos` in
 137 [src/visitor.rs](src/visitor.rs).
 138
 139
 140 #### Some important elements
 141
 142 At the highest level, Rustfmt uses a `Visitor` implementation called `FmtVisitor`
 143 to walk the AST. This is in [src/visitor.rs](src/visitor.rs). This is really just used to walk
 144 items, rather than the bodies of functions. We also cover macros and attributes
 145 here. Most methods of the visitor call out to `Rewrite` implementations that
 146 then walk their own children.
 147
 148 The `Rewrite` trait is defined in [src/rewrite.rs](src/rewrite.rs). It is implemented for many
 149 things that can be rewritten, mostly AST nodes. It has a single function,
 150 `rewrite`, which is called to rewrite `self` into an `Option<String>`. The
 151 arguments are `width` which is the horizontal space we write into, and `offset`
 152 which is how much we are currently indented from the lhs of the page. We also
 153 take a context which contains information used for parsing, the current block
 154 indent, and a configuration (see below).
 155
 156 To understand the indents, consider
 157
 158 ```
 159 impl Foo {
 160     fn foo(...) {
 161         bar(argument_one,
 162             baz());
 163     }
 164 }
 165 ```
 166
 167 When formatting the `bar` call we will format the arguments in order, after the
 168 first one we know we are working on multiple lines (imagine it is longer than
 169 written). So, when we come to the second argument, the indent we pass to
 170 `rewrite` is 12, which puts us under the first argument. The current block
 171 indent (stored in the context) is 8. The former is used for visual indenting
 172 (when objects are vertically aligned with some marker), the latter is used for
 173 block indenting (when objects are tabbed in from the lhs). The width available
 174 for `baz()` will be the maximum width, minus the space used for indenting, minus
 175 the space used for the `);`. (Note that actual argument formatting does not
 176 quite work like this, but it's close enough).
 177
 178 The `rewrite` function returns an `Option` - either we successfully rewrite and
 179 return the rewritten string for the caller to use, or we fail to rewrite and
 180 return `None`. This could be because Rustfmt encounters something it doesn't
 181 know how to reformat, but more often it is because Rustfmt can't fit the item
 182 into the required width. How to handle this is up to the caller. Often the
 183 caller just gives up, ultimately relying on the missed spans system to paste in
 184 the un-formatted source. A better solution (although not performed in many
 185 places) is for the caller to shuffle around some of its other items to make
 186 more width, then call the function again with more space.
 187
 188 Since it is common for callers to bail out when a callee fails, we often use a
 189 `?` operator to make this pattern more succinct.
 190
 191 One way we might find out that we don't have enough space is when computing how much
 192 space we have. Something like `available_space = budget - overhead`. Since
 193 widths are unsized integers, this would cause underflow. Therefore we use
 194 checked subtraction: `available_space = budget.checked_sub(overhead)?`.
 195 `checked_sub` returns an `Option`, and if we would underflow `?` returns
 196 `None`, otherwise we proceed with the computed space.
 197
 198 Much syntax in Rust is lists: lists of arguments, lists of fields, lists of
 199 array elements, etc. We have some generic code to handle lists, including how to
 200 space them in horizontal and vertical space, indentation, comments between
 201 items, trailing separators, etc. However, since there are so many options, the
 202 code is a bit complex. Look in [src/lists.rs](src/lists.rs). `write_list` is the key function,
 203 and `ListFormatting` the key structure for configuration. You'll need to make a
 204 `ListItems` for input, this is usually done using `itemize_list`.
 205
 206 Rustfmt strives to be highly configurable. Often the first part of a patch is
 207 creating a configuration option for the feature you are implementing. All
 208 handling of configuration options is done in [src/config/mod.rs](src/config/mod.rs). Look for the
 209 `create_config!` macro at the end of the file for all the options. The rest of
 210 the file defines a bunch of enums used for options, and the machinery to produce
 211 the config struct and parse a config file, etc. Checking an option is done by
 212 accessing the correct field on the config struct, e.g., `config.max_width()`. Most
 213 functions have a `Config`, or one can be accessed via a visitor or context of
 214 some kind.