@@ -124,7 +124,7 @@ Rustfmt is basically a pretty printer - that is, its mode of operation is to
124124take an AST (abstract syntax tree) and print it in a nice way (including staying
125125under the maximum permitted width for a line). In order to get that AST, we
126126first have to parse the source text, we use the Rust compiler's parser to do
127- that (see [ src/ lib.rs] ( src/lib.rs ) ). We shy away from doing anything too fancy, such as
127+ that (see [ lib.rs in rustfmt-lib ] ( rustfmt-core/rustfmt-lib/ src/lib.rs) ). We shy away from doing anything too fancy, such as
128128algebraic approaches to pretty printing, instead relying on an heuristic
129129approach, 'manually' crafting a string for each AST node. This results in quite
130130a lot of code, but it is relatively simple.
@@ -164,19 +164,19 @@ At a higher level, Rustfmt has machinery so that we account for text between
164164'top level' items. Then we can reproduce that text pretty much verbatim. We only
165165count spans we actually reformat, so if we can't format a span it is not missed
166166completely but is reproduced in the output without being formatted. This is
167- mostly handled in [ src/ missed_spans.rs] ( src/missed_spans.rs ) . See also ` FmtVisitor::last_pos ` in
168- [ src/ visitor.rs] ( src/visitor.rs ) .
167+ mostly handled in [ missed_spans.rs] ( rustfmt-core/rustfmt-lib/ src/missed_spans.rs) . See also ` FmtVisitor::last_pos ` in
168+ [ visitor.rs] ( rustfmt-core/rustfmt-lib/ src/visitor.rs) .
169169
170170
171171#### Some important elements
172172
173173At the highest level, Rustfmt uses a ` Visitor ` implementation called ` FmtVisitor `
174- to walk the AST. This is in [ src/ visitor.rs] ( src/visitor.rs ) . This is really just used to walk
174+ to walk the AST. This is in [ visitor.rs] ( rustfmt-core/rustfmt-lib/ src/visitor.rs) . This is really just used to walk
175175items, rather than the bodies of functions. We also cover macros and attributes
176176here. Most methods of the visitor call out to ` Rewrite ` implementations that
177177then walk their own children.
178178
179- The ` Rewrite ` trait is defined in [ src/ rewrite.rs] ( src/rewrite.rs ) . It is implemented for many
179+ The ` Rewrite ` trait is defined in [ rewrite.rs] ( rustfmt-core/rustfmt-lib/ src/rewrite.rs) . It is implemented for many
180180things that can be rewritten, mostly AST nodes. It has a single function,
181181` rewrite ` , which is called to rewrite ` self ` into an ` Option<String> ` . The
182182arguments are ` width ` which is the horizontal space we write into and ` offset `
@@ -234,15 +234,15 @@ Much of the syntax in Rust is lists: lists of arguments, lists of fields, lists
234234array elements, etc. We have some generic code to handle lists, including how to
235235space them in horizontal and vertical space, indentation, comments between
236236items, trailing separators, etc. However, since there are so many options, the
237- code is a bit complex. Look in [ src/ lists.rs] ( src/lists.rs ) . ` write_list ` is the key function,
237+ code is a bit complex. Look in [ lists.rs] ( rustfmt-core/rustfmt-lib/ src/lists.rs) . ` write_list ` is the key function,
238238and ` ListFormatting ` the key structure for configuration. You'll need to make a
239239` ListItems ` for input, this is usually done using ` itemize_list ` .
240240
241241##### Configuration
242242
243243Rustfmt strives to be highly configurable. Often the first part of a patch is
244244creating a configuration option for the feature you are implementing. All
245- handling of configuration options is done in [ src/config/mod .rs] ( src/ config/mod .rs) . Look for the
245+ handling of configuration options is done in [ lib .rs in rustfmt-config ] ( rustfmt-core/rustfmt- config/src/lib .rs) . Look for the
246246` create_config! ` macro at the end of the file for all the options. The rest of
247247the file defines a bunch of enums used for options, and the machinery to produce
248248the config struct and parse a config file, etc. Checking an option is done by
0 commit comments