Dartdoc test -- full diff (#249)

* Initial dartdoc_test packages with some hacks

* Update CI configuration

* update dartdoc_test (#239)

* add more examples and fix extracting

* code splitting and print code samples and it's location.

* set overlay of sample code and update dart sdk

* [dartdoc_test] add extractor tests and wrap code with imports (#241)

* add test

* fix

* add import

* fix indent

* move to getter

* fix for ci

* fix sdk version

* fix

* [dartdoc_test] add documentation samples analyzer (#242)

* implement analyze and output samples to .dartdoc_test directory

* add CRLF/LF line breaks tests

* add license headers to all files

* add documentation and some modified

* fix extractor test and add TestContext

* update to make analyzer work

* translate original span from sample file span

* make DartDocTestContext to singleton no longer

* add example dart project

* add write options to write sample code to file (for debug)

* updated README. minor fixes

* add new analyzer test

* update example README

* update README, add .gitignore for .dartdoc_test, and create add subcommand to generate test file

* fix

* rename DartDoc -> Dartdoc

* fix extractor and add tests

* fix span translation and add test

* add CommandRunner and make some commands to subCommand

* fix

* fix analyzer and ignore warning

* fix print of analyze results

* create integration test

* [dartdoc_test] implement good logging! (#245)

* move some codes to src/

* set analyze to default command, and print usage when -h flag is set

* remove extract command and fix integration_test

* add logger and varbose option

* add test for verbose

* fix log

* move log to Command

* [dartdoc_test] implement Reporter (#247)

* create logger class

* add summary log

* move command

* create reporter

* fix

* add ansi and fix extractor to allow code blocks with no specified language

* add output directory option

* add extractor test

* import and print relative path

* fix format

* apply review suggestions and update Reporter

* update reporter

* use stdout reporter

* allow analyze command options in default command

* add integration test for runDartdocTest()

* update report to print relative path

* fix to work test reporter in example directory

* fix

* [dartdoc_test] add some ways to ignore analysis (#248)

* implement code sample ignoring

* add comments

* fix ignoring and test

* update documentations

* add exclude option

* fix summary and make ReporterForTest use verbose flag

* move models to model.dart

* only run integration test on ./example

* do not wrap code samples with main() when code sample includes main()

* fix

* rename code sample output directory

* add doc comments

* update ignoring to use code block tagging (dart#no-test)

* add public member documentations

* fix

* switch default output directory to

* update CHANGELOG

* fix to make some class to final

* remove Reporter constructor, add some comments, and some fixes

* add missing doc comment

* fix output code

* fix for ci

* fix readme

---------

Co-authored-by: takumma <[email protected]>

Author: jonasfj

.github/ISSUE_TEMPLATE/dartdoc_test.md

@@ -0,0 +1,13 @@
+---
+name: Issue with dartdoc_test
+about: Bug, feature request or question regarding 'package:dartdoc_test'
+title: ''
+labels: pkg:dartdoc_test, pending-triage
+assignees:
+---
+ * Explain the issue,
+ * Using bullet points!
+
+```dart
+// Write example code here
+```

.github/workflows/dart.yml

@@ -1,4 +1,4 @@
-# Created with package:mono_repo v6.5.5
+# Created with package:mono_repo v6.6.1
 name: Dart CI
 on:
   push:
@@ -36,20 +36,20 @@ jobs:
         name: Checkout repository
         uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
       - name: mono_repo self validate
-        run: dart pub global activate mono_repo 6.5.5
+        run: dart pub global activate mono_repo 6.6.1
       - name: mono_repo self validate
         run: dart pub global run mono_repo generate --validate
   job_002:
-    name: "analyze; PKGS: acyclic_steps, canonical_json, chunked_stream, http_methods, neat_cache, neat_periodic_task, pem, retry, safe_url_check, sanitize_html, slugid, vendor; `dart analyze`"
+    name: "analyze; PKGS: acyclic_steps, canonical_json, chunked_stream, dartdoc_test, http_methods, neat_cache, neat_periodic_task, pem, retry, safe_url_check, sanitize_html, slugid, vendor; `dart analyze`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor;commands:analyze"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-dartdoc_test-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor;commands:analyze"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor
+            os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-dartdoc_test-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor
             os:ubuntu-latest;pub-cache-hosted;sdk:stable
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -87,6 +87,15 @@ jobs:
         run: dart analyze
         if: "always() && steps.chunked_stream_pub_upgrade.conclusion == 'success'"
         working-directory: chunked_stream
+      - id: dartdoc_test_pub_upgrade
+        name: dartdoc_test; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: dartdoc_test
+      - name: dartdoc_test; dart analyze
+        run: dart analyze
+        if: "always() && steps.dartdoc_test_pub_upgrade.conclusion == 'success'"
+        working-directory: dartdoc_test
       - id: http_methods_pub_upgrade
         name: http_methods; dart pub upgrade
         run: dart pub upgrade
@@ -169,16 +178,16 @@ jobs:
         if: "always() && steps.vendor_pub_upgrade.conclusion == 'success'"
         working-directory: vendor
   job_003:
-    name: "analyze; PKGS: acyclic_steps, canonical_json, chunked_stream, http_methods, neat_cache, neat_periodic_task, pem, retry, safe_url_check, sanitize_html, slugid, vendor; `dart format --output=none --set-exit-if-changed .`"
+    name: "analyze; PKGS: acyclic_steps, canonical_json, chunked_stream, dartdoc_test, http_methods, neat_cache, neat_periodic_task, pem, retry, safe_url_check, sanitize_html, slugid, vendor; `dart format --output=none --set-exit-if-changed .`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor;commands:format"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-dartdoc_test-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor;commands:format"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor
+            os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:acyclic_steps-canonical_json-chunked_stream-dartdoc_test-http_methods-neat_cache-neat_periodic_task-pem-retry-safe_url_check-sanitize_html-slugid-vendor
             os:ubuntu-latest;pub-cache-hosted;sdk:stable
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -216,6 +225,15 @@ jobs:
         run: "dart format --output=none --set-exit-if-changed ."
         if: "always() && steps.chunked_stream_pub_upgrade.conclusion == 'success'"
         working-directory: chunked_stream
+      - id: dartdoc_test_pub_upgrade
+        name: dartdoc_test; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: dartdoc_test
+      - name: "dartdoc_test; dart format --output=none --set-exit-if-changed ."
+        run: "dart format --output=none --set-exit-if-changed ."
+        if: "always() && steps.dartdoc_test_pub_upgrade.conclusion == 'success'"
+        working-directory: dartdoc_test
       - id: http_methods_pub_upgrade
         name: http_methods; dart pub upgrade
         run: dart pub upgrade
@@ -400,6 +418,40 @@ jobs:
       - job_002
       - job_003
   job_007:
+    name: "tests; PKG: dartdoc_test; `dart test`"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cache Pub hosted dependencies
+        uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
+        with:
+          path: "~/.pub-cache/hosted"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:dartdoc_test;commands:test_0"
+          restore-keys: |
+            os:ubuntu-latest;pub-cache-hosted;sdk:stable;packages:dartdoc_test
+            os:ubuntu-latest;pub-cache-hosted;sdk:stable
+            os:ubuntu-latest;pub-cache-hosted
+            os:ubuntu-latest
+      - name: Setup Dart SDK
+        uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
+        with:
+          sdk: stable
+      - id: checkout
+        name: Checkout repository
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
+      - id: dartdoc_test_pub_upgrade
+        name: dartdoc_test; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: dartdoc_test
+      - name: dartdoc_test; dart test
+        run: dart test
+        if: "always() && steps.dartdoc_test_pub_upgrade.conclusion == 'success'"
+        working-directory: dartdoc_test
+    needs:
+      - job_001
+      - job_002
+      - job_003
+  job_008:
     name: "tests; PKG: http_methods; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -433,7 +485,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_008:
+  job_009:
     name: "tests; PKG: neat_periodic_task; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -467,7 +519,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_009:
+  job_010:
     name: "tests; PKG: pem; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -501,7 +553,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_010:
+  job_011:
     name: "tests; PKG: retry; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -535,7 +587,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_011:
+  job_012:
     name: "tests; PKG: safe_url_check; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -569,7 +621,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_012:
+  job_013:
     name: "tests; PKG: sanitize_html; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -603,7 +655,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_013:
+  job_014:
     name: "tests; PKG: slugid; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -637,7 +689,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_014:
+  job_015:
     name: "tests; PKG: vendor; `dart test`"
     runs-on: ubuntu-latest
     steps:
@@ -671,7 +723,7 @@ jobs:
       - job_001
       - job_002
       - job_003
-  job_015:
+  job_016:
     name: "tests; PKG: neat_cache; `dart test -x redis`"
     runs-on: ubuntu-latest
     steps:

dartdoc_test/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.1.0
+ * Initial release, with code sample extraction, analysis, and some options to write or ignore analysis.