Skip to content

Commit b6c5fe8

Browse files
committed
[docs] Update the In-depth Analysis.
Add proper documentation for the following tests: - lebab - prettier - source-map - typescript - uglify-js
1 parent 5886cd8 commit b6c5fe8

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

docs/in-depth.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,11 @@ This benchmark runs JSHint on
129129

130130
## lebab
131131

132-
A test to stress the [Lebab](https://github.com/lebab/lebab)
133-
ES5 to ES6/ES7 transpiler, modernizing the preact bundle.
132+
[Lebab](https://github.com/lebab/lebab) transpiles your ES5 code to ES6/ES7, thus
133+
performing the opposite of what [Babel](https://github.com/babel/babel) does.
134+
135+
This benchmark runs the Lebal ES5 to ES6/ES7 transpiler on the
136+
[Preact](http://preactjs.com) 8.2.5 bundle.
134137

135138
## prepack
136139

@@ -146,28 +149,46 @@ This benchmark runs prepack on both
146149

147150
## prettier
148151

149-
A test to stress the [Prettier](https://github.com/prettier/prettier)
150-
code formatter with various `.js` and `.jsx` inputs.
152+
[Prettier](https://github.com/prettier/prettier) is an opinionated code formatter
153+
which removes all the original styling and ensures that all outputted code conforms
154+
to a consistent style. It is often used in web projects today to automatically format
155+
JavaScript, HTML, CSS and other files.
156+
157+
This benchmark runs prettier on different inputs, including
158+
- the [lodash](https://lodash.com) 4.17.4 bundle,
159+
- the [Preact](http://preactjs.com) 8.2.5 bundle, and
160+
- the JSX files from the React [todomvc](https://github.com/tastejs/todomvc) example app.
151161

152162
## source-map
153163

154-
A test to stress the [source-map](https://github.com/mozilla/source-map)
155-
tool on both parsing and serializing source maps.
164+
[Source Map](https://github.com/mozilla/source-map) is a library developed by Mozilla
165+
to generate and consume source maps, which in turn are used by browsers to display
166+
proper JavaScript when debugging a minified application.
167+
168+
This benchmark stresses the source-map tool on both parsing and serializing a
169+
variety of different source maps, including the [Preact](http://preactjs.com)
170+
8.2.5 source map.
156171

157172
## typescript
158173

159-
A test to stress the [TypeScript](https://github.com/Microsoft/TypeScript)
160-
compiler on the [`typescript-angular`](https://github.com/tastejs/todomvc/tree/master/examples/typescript-angular)
174+
[TypeScript](https://github.com/Microsoft/TypeScript) is a language for
175+
application-scale JavaScript. It adds optional types, classes, and modules
176+
to JavaScript, and compiles to readable, standards-based JavaScript.
177+
178+
This benchmark stresses the TypeScript compiler by running it on the
179+
[`typescript-angular`](https://github.com/tastejs/todomvc/tree/master/examples/typescript-angular)
161180
example from [todomvc](https://github.com/tastejs/todomvc).
162181

163182
## uglify-js
164183

165-
A test to stress the [UglifyJS3](https://github.com/mishoo/UglifyJS2)
166-
minifier, running on the (concatenated) JavaScript source for
167-
the ES2015 test in the [Speedometer](https://browserbench.org/Speedometer)
168-
2.0 benchmark.
184+
[UglifyJS](https://github.com/mishoo/UglifyJS2) is a JavaScript parser, minifier,
185+
compressor and beautifier toolkit, which is commonly used to minimize JavaScript
186+
bundles.
187+
188+
This benchmark runs the UglifyJS minifier on the (concatenated) JavaScript source for
189+
the ES2015 test in the [Speedometer](https://browserbench.org/Speedometer) 2.0 benchmark.
169190

170191
## uglify-es
171192

172193
This benchmark stresses the new ES2015 and beyond minifier using the 196KiB
173-
ES2015 module containing the untranspiled [Vue](https://github.com/vuejs/vue) bundle.
194+
ES2015 module containing the untranspiled [Vue](https://github.com/vuejs/vue) bundle.

0 commit comments

Comments
 (0)