Skip to content

Commit

Permalink
Minor doc updates (#3488)
Browse files Browse the repository at this point in the history
* Minor doc updates

* Remove accidental 'x'

* Drop pub mention in `build_runner` introduction

Co-authored-by: Jacob MacDonald <jakemac@google.com>
  • Loading branch information
parlough and jakemac53 committed Apr 21, 2023
1 parent a34aa32 commit ad15533
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 15 deletions.
5 changes: 2 additions & 3 deletions build_runner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@
</p>

The `build_runner` package provides a concrete way of generating files using
Dart code, outside of tools like `pub`. Unlike `pub serve/build`, files are
always generated directly on disk, and rebuilds are _incremental_ - inspired by
tools such as [Bazel][].
Dart code. Files are always generated directly on disk, and
rebuilds are _incremental_ - inspired by tools such as [Bazel][].

> **NOTE**: Are you a user of this package? You may be interested in
> simplified user-facing documentation, such as our
Expand Down
4 changes: 2 additions & 2 deletions docs/builder_author_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ For example:
```dart
// In lib/builder.dart
PostProcessBuilder temporaryFileCleanup(BuilderOptions options) =>
const FileDeletingBuilder(const ['.used_during_build'],
isEnabled: options.config['enabled'] as bool ?? false);
FileDeletingBuilder(const ['.used_during_build'],
isEnabled: options.config['enabled'] as bool? ?? false);
Builder writesTemporary([_]) => ...
Builder readsTemporaryWritesPermanent([_]) => ...
```
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ you can:
- Contact the author of the Builder and ask that a more unique output
extension is chosen.
- Contact the author of the Builder and ask that a more unique input extension
is chose, for example only generating for files that end in
is chosen, for example only generating for files that end in
`_something.dart` rather than all files that end in `.dart`.

## How can I use my own development server to serve generated files?
Expand Down
10 changes: 4 additions & 6 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use `build_runner`, you need a 2.x version of the Dart SDK.

* [Automated installers](https://dart.dev/get-dart#install)
* [Direct downloads](https://dart.dev/tools/sdk/archive#dev-channel)
* [Direct downloads](https://dart.dev/get-dart/archive#dev-channel)

If you have issues using `build_runner`, see the
[Troubleshooting section](#troubleshooting), below.
Expand All @@ -23,16 +23,14 @@ If you have issues using `build_runner`, see the
1. Edit your package's **pubspec.yaml** file, adding dev dependencies on
**build_runner** and **build_web_compilers**:

```yaml
dev_dependencies:
build_runner: ^2.0.0
build_web_compilers: ^3.0.0
```sh
dart pub add dev:build_runner dev:build_web_compilers
```

2. Get package dependencies:

```sh
pub get
dart pub get
```

3. Start the server:
Expand Down
6 changes: 3 additions & 3 deletions docs/partial_builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Glob syntax is allowed in both package names and paths.
application, as well as copy over the required SDK resources for that app:

```
pub run build_runner serve \
dart run build_runner serve \
--build-filter="web/main.dart.js" \
--build-filter="package:build_web_compilers/**/*.js"
```
Expand All @@ -41,7 +41,7 @@ This can greatly speed up iteration times in packages with lots of tests.
**Example**: This will build a single web test and run it:

```
pub run build_runner test \
dart run build_runner test \
--build-filter="test/my_test.dart.browser_test.dart.js" \
--build-filter="package:build_web_compilers/**/*.js" \
-- -p chrome test/my_test.dart
Expand All @@ -64,7 +64,7 @@ also work when you create an output directory.
**Example**: This will build a single web app and serve it:

```
pub run build_runner serve \
dart run build_runner serve \
--build-filter="web/my_app.dart.js" \
--build-filter="package:build_web_compilers/**/*.js"
```
Expand Down

0 comments on commit ad15533

Please sign in to comment.