WebdevServeTool class

A dart_dev tool that runs a local web development server for the current project using the webdev package.

To use this tool in your project, include it in the dart_dev config in tool/dart_dev/config.dart: import 'package:dart_dev/dart_dev.dart';

final config = {
  'serve': WebdevServeTool(),
};

This will make it available via the dart_dev command-line app like so: dart run dart_dev serve

This tool can be configured by modifying any of its fields: // tool/dart_dev/config.dart import 'package:dart_dev/dart_dev.dart';

final config = {
  'serve': WebdevServeTool()
    ..buildArgs = ['--delete-conflicting-outputs']
    ..webdevArgs = ['--debug', 'example:8080', 'web:8081']
};

It is also possible to run this tool directly in a dart script: WebdevServeTool().run();

Inheritance

Constructors

WebdevServeTool()

Properties

argParser → ArgParser
The argument parser for this tool, if needed.
final
buildArgs ↔ List<String>?
The args to pass to the build_runner process via the webdev serve process that will be run by this tool.
getter/setter pair
description ↔ String?
This tool's description (which is included in the help/usage output) can be overridden by setting this field to a non-null value.
getter/setter pairoverride
hashCode → int
The hash code for this object.
no setterinherited
hidden ↔ bool
This field determines whether or not this tool is hidden from the help/usage output when running as a part of a command-line app.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
webdevArgs ↔ List<String>?
The args to pass to the webdev serve process that will be run by this tool.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
run([DevToolExecutionContext? context]) → FutureOr<int?>
Runs this tool and returns (either synchronously or asynchronously) an int which will be treated as the exit code (i.e. non-zero means failure).
override
toCommand(String name) → Command<int>
Converts this tool to a Command that can be added directly to a CommandRunner, therefore making it executable from the command-line.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited