Skip to content

Commit 78a1d49

Browse files
Merge pull request #411 from parlough/misc/minor-pub-cleanup
Minor pubspec and readme cleanup
2 parents 0faa15a + a5bf10d commit 78a1d49

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dart Dev Tools
22

3-
[![Pub](https://img.shields.io/pub/v/dart_dev.svg)](https://pub.dartlang.org/packages/dart_dev)
3+
[![Pub](https://img.shields.io/pub/v/dart_dev.svg)](https://pub.dev/packages/dart_dev)
44
[![Build Status](https://github.com/Workiva/dart_dev/workflows/Dart%20CI/badge.svg?branch=master)](https://github.com/Workiva/dart_dev/actions?query=workflow%3A%22Dart+CI%22+branch%3Amaster)
55

66
Centralized tooling for Dart projects. Consistent interface across projects.
@@ -25,10 +25,8 @@ Easily configurable.
2525
2626
Add `dart_dev` as a dev dependency in your project:
2727

28-
```yaml
29-
# pubspec.yaml
30-
dev_dependencies:
31-
dart_dev: ^3.0.0
28+
```bash
29+
dart pub add --dev dart_dev
3230
```
3331

3432
By default, this provides three core tasks:
@@ -93,7 +91,7 @@ With `dart_dev`, we attempt to address #1 by providing a way to configure all of
9391
these common developer tasks at the project level, and #2 by composing
9492
additional functionality around existing tools.
9593

96-
This package is built with configurability and extensiblity in mind, with the
94+
This package is built with configurability and extensibility in mind, with the
9795
hope that you and your teams will find value in creating your own tools and
9896
shared configurations. Ideally, you or your team can settle on a shared
9997
configuration that individual projects can consume; projects with unique
@@ -119,7 +117,7 @@ With `dart_dev`, this can be accomplished like so:
119117
```dart
120118
// tool/dart_dev/config.dart
121119
import 'package:dart_dev/dart_dev.dart';
122-
import 'pacakge:glob/glob.dart';
120+
import 'package:glob/glob.dart';
123121
124122
final config = {
125123
'format': FormatTool()
@@ -307,7 +305,7 @@ For additional reference on how the watcher is set up, see [JetBrains File Watch
307305
1. __The Name:__ Webstorm treats this like the process name, so it's the identifier that will be used to display any output that the process is running. It can be whatever you like!
308306
1. __File Type:__ `Dart`, since that's what the formatter was built for.
309307
1. __Scope:__ `Project Files` will produce the desired effect, but if a different option works better for you then feel free! For more information on scoping, see [the docs](file-watcher-docs).
310-
1. __Program:__ The exutable to run. In this case, it can just be `pub`. If there are any issues, providing a full path to the executable may have the desired outcome. For pub, this is most likely `/usr/local/bin/pub`.
308+
1. __Program:__ The executable to run. In this case, it can just be `pub`. If there are any issues, providing a full path to the executable may have the desired outcome. For pub, this is most likely `/usr/local/bin/pub`.
311309
1. __Arguments:__ The rest of the command, and by default should be `run dart_dev hackFastFormat "$FilePathRelativeToProjectRoot$"`. Here's the breakdown:
312310
- `run dart_dev hackFastFormat`: Simply the process to run.
313311
- `"$FilePathRelativeToProjectRoot$"`: The environment variable that will target only the changed file.

pubspec.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
name: dart_dev
22
version: 4.1.1
3-
description: Centralized tooling for Dart projects. Consistent interface across projects. Easily configurable.
4-
homepage: https://github.com/Workiva/dart_dev
3+
description: >
4+
Centralized tooling for Dart projects.
5+
Consistent interface across projects.
6+
Easily configurable.
7+
repository: https://github.com/Workiva/dart_dev
58

69
environment:
7-
sdk: '>=2.18.0 <4.0.0'
10+
sdk: '>=2.18.0 <4.0.0'
811

912
dependencies:
1013
analyzer: '>=2.0.0 <6.0.0'

0 commit comments

Comments
 (0)