-
Notifications
You must be signed in to change notification settings - Fork 83
Updated docs, added trivial tests #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Copyright 2017, the Dart project authors. All rights reserved. | ||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are | ||
met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following | ||
disclaimer in the documentation and/or other materials provided | ||
with the distribution. | ||
* Neither the name of Google Inc. nor the names of its | ||
contributors may be used to endorse or promote products derived | ||
from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,24 @@ | ||
# Experimental Usage | ||
## Installation | ||
|
||
The example directory contains a package that is configured to work with | ||
`pub run webdev <command>`. Support for `pub global activate webdev` and simply | ||
adding a dev_dependency to your packages is coming soon. | ||
```console | ||
$ pub global activate webdev | ||
``` | ||
|
||
## Commands | ||
## Usage | ||
|
||
* __build__: Run builders to build a package. | ||
* __help__: Display help information for webdev. | ||
* __serve__: Run a local web development server and a file system watcher that | ||
re-builds on changes. | ||
```console | ||
$ webdev | ||
A tool to develop Dart web projects. | ||
|
||
Usage: webdev <command> [arguments] | ||
|
||
Global options: | ||
-h, --help Print this usage information. | ||
|
||
Available commands: | ||
build Run builders to build a package. | ||
help Display help information for webdev. | ||
serve Run a local web development server and a file system watcher that re-builds on changes. | ||
|
||
Run "webdev help <command>" for more information about a command. | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 2018 |
||
// for details. All rights reserved. Use of this source code is governed by a | ||
// BSD-style license that can be found in the LICENSE file. | ||
|
||
import 'dart:io'; | ||
|
||
import 'package:test/test.dart'; | ||
import 'package:test_process/test_process.dart'; | ||
|
||
void main() { | ||
test('README contains help output', () async { | ||
var process = await TestProcess.start('dart', ['bin/webdev.dart']); | ||
|
||
var output = (await process.stdoutStream().join('\n')).trim(); | ||
|
||
var readme = new File('README.md'); | ||
|
||
expect(readme.readAsStringSync(), | ||
contains('```console\n\$ webdev\n$output\n```')); | ||
|
||
await process.shouldExit(0); | ||
}); | ||
|
||
test('non-existant commands create errors', () async { | ||
var process = | ||
await TestProcess.start('dart', ['bin/webdev.dart', 'monkey']); | ||
|
||
var output = (await process.stdoutStream().join('\n')).trim(); | ||
|
||
expect(output, contains('Could not find a command named "monkey".')); | ||
|
||
await process.shouldExit(64); | ||
}); | ||
|
||
test('should fail in a package without a build_runner dependency', () async { | ||
var process = await TestProcess.start('dart', ['bin/webdev.dart', 'serve']); | ||
await process.shouldExit(255); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we expecting anything other than a failure yet? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is running against itself – so no build_runner dep or anything. We expect it to always fail. ...although in the future it should fail with a more helpful message and a different error code |
||
}); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this our recommended approach to travis testing now? What happened to the days of just adding a few lines in the travis.yaml?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is using
mono_repo
– let's us test multiple packages in one repo easily...