From 26b307b5bf6798d0c7b661830213157c0a2cf8aa Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Thu, 20 Jul 2023 12:16:43 -0500 Subject: [PATCH] Remove most remaining doc generation code (#4585) * Remove most remaining doc generation code * Remove accidental lint --- tool/doc.dart | 160 -------------------------------------------------- 1 file changed, 160 deletions(-) diff --git a/tool/doc.dart b/tool/doc.dart index da5b62e07..891911775 100644 --- a/tool/doc.dart +++ b/tool/doc.dart @@ -43,11 +43,6 @@ final coreRules = []; final flutterRules = []; final recommendedRules = []; -/// Sorted list of contributed lint rules. -final List rules = - List.of(Registry.ruleRegistry, growable: false) - ..sort((a, b) => a.name.compareTo(b.name)); - final Map _fixStatusMap = {}; Future fetchBadgeInfo() async { @@ -124,7 +119,6 @@ Future generateDocs(String? dir, {bool createDirectories = false}) async { } if (createDirectories) { - Directory('$outDir/options').createSync(); Directory('$outDir/machine').createSync(); } } @@ -139,17 +133,6 @@ Future generateDocs(String? dir, {bool createDirectories = false}) async { var fixStatusMap = await fetchFixStatusMap(); - // Generate rule files. - for (var rule in rules) { - RuleHtmlGenerator(rule).generate(outDir); - } - - // Generate index. - HtmlIndexer().generate(outDir); - - // Generate options samples. - OptionsSample().generate(outDir); - // Generate a machine-readable summary of rules. MachineSummaryGenerator(Registry.ruleRegistry, fixStatusMap).generate(outDir); } @@ -182,52 +165,6 @@ class CountBadger { } } -class HtmlIndexer { - HtmlIndexer(); - - void generate(String? filePath) { - var generated = _generate(); - if (filePath != null) { - var outPath = '$filePath/index.html'; - printToConsole('Writing to $outPath'); - File(outPath).writeAsStringSync(generated); - } else { - printToConsole(generated); - } - } - - String _generate() => ''' - - - - - - - - - - - - Linter for Dart - - -
-
-

Linter for Dart

 -
-
-

Linter documentation has moved!

-

- Find up-to-date linter and lint rule documentation at - https://dart.dev/lints. -

-
-
- - -'''; -} - class MachineSummaryGenerator { final Iterable rules; final Map fixStatusMap; @@ -246,100 +183,3 @@ class MachineSummaryGenerator { } } } - -class OptionsSample { - OptionsSample(); - - void generate(String? filePath) { - var generated = _generate(); - if (filePath != null) { - var outPath = '$filePath/options/options.html'; - printToConsole('Writing to $outPath'); - File(outPath).writeAsStringSync(generated); - } else { - printToConsole(generated); - } - } - - String _generate() => ''' - - - - - - - - - - - - Analysis Options - - -
-
-

All linter rules enabled

 -
-
-

Linter documentation has moved!

-

- Find an auto-generated list of all linter rules at - https://dart.dev/lints/all. -

-
-
- - -'''; -} - -class RuleHtmlGenerator { - final LintRule rule; - - RuleHtmlGenerator(this.rule); - - String get name => rule.name; - - void generate([String? filePath]) { - var generated = _generate(); - if (filePath != null) { - var outPath = '$filePath/$name.html'; - printToConsole('Writing to $outPath'); - File(outPath).writeAsStringSync(generated); - } else { - printToConsole(generated); - } - } - - String _generate() => ''' - - - - - - - - - - - $name - - - -
-
-

$name

 -
-
-

Lint documentation has moved!

-

- Find up-to-date documentation for the - $name linter rule at - https://dart.dev/lints/$name. -

-
-
- - -'''; -}