Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove automatic gh-pages doc generation #4625

Merged
merged 2 commits into from
Aug 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions .github/workflows/gh-pages.yml

This file was deleted.

1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
The Dart Linter package defines lint rules that identify and report on "lints" found in Dart code. Linting is performed by the Dart
analysis server and the `dart analyze` command in the [Dart command-line tool][dart_cli].

[![Lint Count](https://dart-lang.github.io/linter/lints/count-badge.svg)](https://dart-lang.github.io/linter/lints/)
[![Build Status](https://github.com/dart-lang/linter/workflows/linter/badge.svg)](https://github.com/dart-lang/linter/actions)
[![Coverage Status](https://coveralls.io/repos/dart-lang/linter/badge.svg)](https://coveralls.io/r/dart-lang/linter)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/dart-lang/linter/badge)](https://deps.dev/project/github/dart-lang%2Flinter)
Expand Down
1 change: 0 additions & 1 deletion doc/writing-lints.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ Details are under active development. Feedback is most [welcome][issues]!
[lib/src/rules]: https://github.com/dart-lang/linter/tree/main/lib/src/rules
[test_data/rules]: https://github.com/dart-lang/linter/tree/main/test_data/rules
[rule.dart]: https://github.com/dart-lang/linter/blob/main/tool/rule.dart
[doc.dart]: https://github.com/dart-lang/linter/blob/main/tool/doc.dart
[analyzer.dart utility library]: https://github.com/dart-lang/linter/blob/main/lib/src/analyzer.dart
[implementation_imports]: https://dart.dev/lints/implementation_imports
[Dart Language Specification]: https://dart.dev/guides/language/spec
Expand Down
3 changes: 1 addition & 2 deletions lib/src/util/score_utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Future<List<String>> _readRecommendedLints() async => _fetchLints(

/// todo(pq): update `scorecard.dart` to reuse these fetch functions.
Future<List<String>> _fetchLints(String url) async {
var client = http.Client();
var req = await client.get(Uri.parse(url));
var req = await http.get(Uri.parse(url));
return _readLints(req.body);
}

Expand Down
2 changes: 1 addition & 1 deletion test/doc_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import 'package:test/test.dart';

import '../tool/doc.dart';
import '../tool/machine.dart';
import 'util/test_utils.dart';

void main() {
Expand Down
185 changes: 0 additions & 185 deletions tool/doc.dart

This file was deleted.

75 changes: 64 additions & 11 deletions tool/machine.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ import 'dart:io';

import 'package:analyzer/src/lint/registry.dart';
import 'package:args/args.dart';
import 'package:http/http.dart' as http;
import 'package:linter/src/analyzer.dart';
import 'package:linter/src/rules.dart';
import 'package:linter/src/util/score_utils.dart' as score_utils;
import 'package:linter/src/utils.dart';
import 'package:path/path.dart' as path;
import 'package:yaml/yaml.dart';

import 'doc.dart';
import 'since.dart';

/// Generates a list of lint rules in machine format suitable for consumption by
Expand All @@ -38,24 +40,50 @@ void main(List<String> args) async {
}
}

Future<String> generateRulesJson(
{bool pretty = true, bool includeSetInfo = true}) async {
registerLintRules();
if (includeSetInfo) {
await fetchBadgeInfo();
Future<Map<String, String>> fetchFixStatusMap() async {
var url =
'https://raw.githubusercontent.com/dart-lang/sdk/main/pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml';
printToConsole('loading $url...');
var req = await http.get(Uri.parse(url));
var yaml = loadYamlNode(req.body) as YamlMap;
var fixStatusMap = <String, String>{};
for (var entry in yaml.entries) {
var code = entry.key as String;
if (code.startsWith('LintCode.')) {
fixStatusMap[code.substring(9)] =
(entry.value as YamlMap)['status'] as String;
}
}
return fixStatusMap;
}

Future<String> generateRulesJson({
bool pretty = true,
bool includeSetInfo = true,
}) async {
registerLintRules();
var fixStatusMap = await fetchFixStatusMap();
return getMachineListing(Registry.ruleRegistry,
return await getMachineListing(Registry.ruleRegistry,
fixStatusMap: fixStatusMap, sinceInfo: sinceMap, pretty: pretty);
}

String getMachineListing(Iterable<LintRule> ruleRegistry,
{Map<String, String>? fixStatusMap,
bool pretty = true,
Map<String, SinceInfo>? sinceInfo}) {
Future<String> getMachineListing(
Iterable<LintRule> ruleRegistry, {
Map<String, String>? fixStatusMap,
bool pretty = true,
bool includeSetInfo = true,
Map<String, SinceInfo>? sinceInfo,
}) async {
var rules = List<LintRule>.of(ruleRegistry, growable: false)..sort();
var encoder = pretty ? JsonEncoder.withIndent(' ') : JsonEncoder();
fixStatusMap ??= {};

var (
coreRules: coreRules,
recommendedRules: recommendedRules,
flutterRules: flutterRules
) = await _fetchSetRules(fetch: includeSetInfo);

var json = encoder.convert([
for (var rule in rules)
{
Expand All @@ -77,3 +105,28 @@ String getMachineListing(Iterable<LintRule> ruleRegistry,
]);
return json;
}

Future<
({
Set<String> coreRules,
Set<String> recommendedRules,
Set<String> flutterRules,
})> _fetchSetRules({bool fetch = true}) async {
if (!fetch) {
return const (
coreRules: <String>{},
recommendedRules: <String>{},
flutterRules: <String>{},
);
}

var coreRules = {...await score_utils.coreRules};
var recommendedRules = {...coreRules, ...await score_utils.recommendedRules};
var flutterRules = {...recommendedRules, ...await score_utils.flutterRules};

return (
coreRules: coreRules,
recommendedRules: recommendedRules,
flutterRules: flutterRules,
);
}