[dartdoc_test] add documentation samples analyzer

dartdoc_test/.gitignore

@@ -0,0 +1 @@
+.dartdoc_test

dartdoc_test/README.md

@@ -1,8 +1,35 @@
-dartdoc_test
-============
+# dartdoc_test
 
 This package provides an easy way to test code samples embedded in dartdoc
 documentation comments.
 
 **Disclaimer:** This is not an officially supported Google product.
 
+# Using in cli
+
+```bash
+# Add dartdoc_test as dev dependency
+dart pub add dev:dartdoc_test
+
+# Run dartdoc_test directly
+dart run dartdoc_test analyze
+```
+
+# Using in test
+
+You can test documentation code samples by creating `test/dartdoc_test.dart`.
+
+```dart
+import 'package:dartdoc_test/dartdoc_test.dart';
+
+void main() {
+  runDartdocTest();
+}
+
+```
+
+and then
+
+```bash
+dart test
+```

dartdoc_test/bin/dartdoc_test.dart

@@ -12,23 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import 'package:args/args.dart';
 import 'package:dartdoc_test/dartdoc_test.dart';
 
-final _parser = ArgParser()
-  ..addFlag(
-    'help',
-    abbr: 'h',
-    help: 'Show help',
-    negatable: false,
-  )
-  ..addMultiOption(
-    'directory',
-    abbr: 'd',
-    help: 'Directories to analyze',
-  );
-
 Future<void> main(List<String> args) async {
-  final dartdocTest = DartDocTest();
-  await dartdocTest.run();
+  await DartdocTestCommandRunner().run(args);
 }

dartdoc_test/example/.gitignore

@@ -0,0 +1,3 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/

dartdoc_test/example/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

dartdoc_test/example/README.md

@@ -0,0 +1,3 @@
+# dartdoc_test example
+
+This application shows how to use `package:dartdoc_test` in a dart project and how it works.

dartdoc_test/example/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

dartdoc_test/example/example.dart → dartdoc_test/example/lib/example.dart

@@ -1,6 +1,21 @@
-/// Example of documentation comments and code samples in Dart.
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import 'dart:convert';
 
+/// Example of documentation comments and code samples in Dart.
+
 /// This is a simple class example.
 ///
 /// This class demonstrates a simple Dart class with a single method.

dartdoc_test/example/lib/main.dart

@@ -0,0 +1,35 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// Simple function that prints `"Hello world!"`.
+///
+/// **Example**
+/// ```dart
+/// sayHello(); // prints: Hello world!
+/// ```
+void sayHello() {
+  // My comment
+  print('Hello world!');
+}
+
+/// Simple function that prints `"Hello world!"`.
+///
+/// **Example**
+/// ```dart
+/// foo(); // prints: Hello world!
+/// ```
+void foo() {
+  // My comment
+  print('foo!');
+}

dartdoc_test/example/pubspec.yaml

@@ -0,0 +1,18 @@
+name: example
+description: A sample command-line application.
+version: 1.0.0
+# repository: https://github.com/my_org/my_repo
+
+environment:
+  sdk: ^3.3.0
+
+# Add regular dependencies here.
+dependencies:
+  # path: ^1.8.0
+
+dev_dependencies:
+  lints: ^3.0.0
+  test: ^1.24.0
+
+  dartdoc_test:
+    path: ../

dartdoc_test/example/test/dartdoc_test.dart

@@ -0,0 +1,18 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import 'package:dartdoc_test/dartdoc_test.dart';
+
+/// [runDartdocTest] is a test function that tests code samples.
+void main() => runDartdocTest();