Skip to content

Commit ec3269e

Browse files
jcollins-gjcollins-g
authored
Fix bug where --version didn't do anything (#1693)
* Fix bug where --version didn't do anything * Review comments * Rebuild test package docs for retype deprecation in dev.55
1 parent 59c9645 commit ec3269e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+99
-94
lines changed

‎bin/dartdoc.dart‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ main(List<String> arguments) async {
6060
_printHelpAndExit(optionSet.argParser);
6161
}
6262
if (optionSet['version'].valueAt(Directory.current)) {
63-
_printHelpAndExit(optionSet.argParser);
63+
_printVersionAndExit(optionSet.argParser);
6464
}
6565

6666
startLogging(config);
@@ -97,8 +97,15 @@ void _printHelpAndExit(ArgParser parser, {int exitCode: 0}) {
9797
_printUsageAndExit(parser, exitCode: exitCode);
9898
}
9999

100+
/// Print usage information on invalid command lines.
100101
void _printUsageAndExit(ArgParser parser, {int exitCode: 0}) {
101102
print('Usage: dartdoc [OPTIONS]\n');
102103
print(parser.usage);
103104
exit(exitCode);
104105
}
106+
107+
/// Print version information.
108+
void _printVersionAndExit(ArgParser parser) {
109+
print('dartdoc version: ${dartdocVersion}');
110+
exit(exitCode);
111+
}

‎pubspec.yaml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ version: 0.19.1-dev
44
author: Dart Team <[email protected]>
55
description: A documentation generator for Dart.
66
homepage: https://github.com/dart-lang/dartdoc
7-
# For development, recommend 1.25.0-dev.0.0 or higher to allow
8-
# dartanalyzer to work on dartdoc itself.
97
environment:
10-
sdk: '>=2.0.0-dev.9.0 <3.0.0'
8+
sdk: '>=2.0.0-dev.54.0 <3.0.0'
119
dependencies:
1210
analyzer: '0.31.2-alpha.2'
1311
args: '>=0.13.0 <2.0.0'

‎test/compare_output_test.dart‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import 'dart:convert';
88
import 'dart:io';
99
import 'dart:mirrors';
1010

11+
import 'package:dartdoc/src/package_meta.dart';
1112
import 'package:path/path.dart' as pathLib;
1213
import 'package:test/test.dart';
1314

@@ -43,6 +44,14 @@ void main() {
4344
}
4445
});
4546

47+
test("Validate --version works", () async {
48+
var args = <String>[dartdocBin, '--version'];
49+
var result = Process.runSync(Platform.resolvedExecutable, args,
50+
workingDirectory: _testPackagePath);
51+
PackageMeta dartdocMeta = new PackageMeta.fromFilename(dartdocBin);
52+
expect(result.stdout, equals('dartdoc version: ${dartdocMeta.version}\n'));
53+
});
54+
4655
test("Validate html output of test_package", () async {
4756
if (Platform.isWindows) {
4857
print("Skipping on Windows");

‎testing/test_package_docs/fake/ExtraSpecialList-class.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -587,13 +587,13 @@ <h2>Methods</h2>
587587
<div class="features">inherited</div>
588588
</dd>
589589
<dt id="retype" class="callable inherited">
590-
<span class="name"><a href="fake/SpecialList/retype.html">retype</a></span><span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span><span class="signature">(<wbr>)
590+
<span class="name deprecated"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></span><span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span><span class="signature">(<wbr>)
591591
<span class="returntype parameter">&#8594; List<span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span></span>
592592
</span>
593593
</dt>
594594
<dd class="inherited">
595595

596-
<div class="features">inherited</div>
596+
<div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>(&#39;Use cast instead.&#39;), inherited</div>
597597
</dd>
598598
<dt id="setAll" class="callable inherited">
599599
<span class="name"><a href="fake/SpecialList/setAll.html">setAll</a></span><span class="signature">(<wbr><span class="parameter" id="setAll-param-index"><span class="type-annotation">int</span> <span class="parameter-name">index</span>, </span> <span class="parameter" id="setAll-param-iterable"><span class="type-annotation">Iterable</span> <span class="parameter-name">iterable</span></span>)
@@ -834,7 +834,7 @@ <h2>Operators</h2>
834834
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
835835
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
836836
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
837-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
837+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
838838
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
839839
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
840840
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/ExtraSpecialList/ExtraSpecialList.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h5>ExtraSpecialList class</h5>
9191
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
9292
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
9393
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
94-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
94+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
9595
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
9696
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
9797
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/SpecialList-class.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -590,13 +590,13 @@ <h2>Methods</h2>
590590
<div class="features">inherited</div>
591591
</dd>
592592
<dt id="retype" class="callable inherited">
593-
<span class="name"><a href="fake/SpecialList/retype.html">retype</a></span><span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span><span class="signature">(<wbr>)
593+
<span class="name deprecated"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></span><span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span><span class="signature">(<wbr>)
594594
<span class="returntype parameter">&#8594; List<span class="signature">&lt;<wbr><span class="type-parameter">R</span>&gt;</span></span>
595595
</span>
596596
</dt>
597597
<dd class="inherited">
598598

599-
<div class="features">inherited</div>
599+
<div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>(&#39;Use cast instead.&#39;), inherited</div>
600600
</dd>
601601
<dt id="setAll" class="callable inherited">
602602
<span class="name"><a href="fake/SpecialList/setAll.html">setAll</a></span><span class="signature">(<wbr><span class="parameter" id="setAll-param-index"><span class="type-annotation">int</span> <span class="parameter-name">index</span>, </span> <span class="parameter" id="setAll-param-iterable"><span class="type-annotation">Iterable<span class="signature">&lt;<wbr><span class="type-parameter">E</span>&gt;</span></span> <span class="parameter-name">iterable</span></span>)
@@ -837,7 +837,7 @@ <h2>Operators</h2>
837837
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
838838
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
839839
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
840-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
840+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
841841
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
842842
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
843843
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/SpecialList/SpecialList.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h5>SpecialList class</h5>
9191
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
9292
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
9393
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
94-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
94+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
9595
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
9696
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
9797
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/SpecialList/add.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h5>SpecialList class</h5>
9191
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
9292
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
9393
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
94-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
94+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
9595
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
9696
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
9797
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/SpecialList/addAll.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h5>SpecialList class</h5>
9191
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
9292
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
9393
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
94-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
94+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
9595
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
9696
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
9797
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

‎testing/test_package_docs/fake/SpecialList/any.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h5>SpecialList class</h5>
9191
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
9292
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
9393
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
94-
<li class="inherited"><a href="fake/SpecialList/retype.html">retype</a></li>
94+
<li class="inherited"><a class="deprecated" href="fake/SpecialList/retype.html">retype</a></li>
9595
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
9696
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
9797
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>

0 commit comments

Comments
 (0)