Deprecate --resources-dir option. (#3696)

* Deprecate --resources-dir option. * Add an entry to the changelog.
dart-lang · Feb 29, 2024 · cec45fb · cec45fb
1 parent 40fef4c
commit cec45fb
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## 8.0.7-wip
 
 * Deprecate the `--nodoc` option. (#3690)
+* Deprecate the `--resources-dir` option. (#3696)
 
 ## 8.0.6
 

diff --git a/lib/src/dartdoc_options.dart b/lib/src/dartdoc_options.dart
@@ -1679,9 +1679,11 @@ List<DartdocOption> createDartdocOptions(
         help:
             'A list of package names to place first when grouping libraries in '
             'packages. Unmentioned packages are placed after these.'),
-    // TODO(srawlins): Deprecate this option.
+    // Deprecated. Use of this option is reported.
+    // TODO(kallentu): Remove this option.
     DartdocOptionArgOnly<String?>('resourcesDir', null, resourceProvider,
-        help: "An absolute path to dartdoc's resources directory.", hide: true),
+        help: "(deprecated) An absolute path to dartdoc's resources directory.",
+        hide: true),
     DartdocOptionArgOnly<bool>('sdkDocs', false, resourceProvider,
         help: 'Generate ONLY the docs for the Dart SDK.'),
     DartdocOptionArgSynth<String?>('sdkDir',

diff --git a/lib/src/generator/generator_frontend.dart b/lib/src/generator/generator_frontend.dart
@@ -27,6 +27,13 @@ class GeneratorFrontEnd implements Generator {
             'longer be supported.',
       );
     }
+    if (_generatorBackend.options.resourcesDir != null) {
+      packageGraph?.defaultPackage.warn(
+        PackageWarning.deprecated,
+        message: "The '--resources-dir' option is deprecated, and will soon be "
+            'removed.',
+      );
+    }
 
     var indexElements = packageGraph == null
         ? const <Indexable>[]