Skip to content

Commit

Permalink
Add a script to help find undocumented settings
Browse files Browse the repository at this point in the history
  • Loading branch information
DanTup committed Mar 20, 2019
1 parent bca9ea8 commit 09cbeb3
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: Dart Code
desc: Dart & Flutter support for Visual Studio Code
permalink: /:name/
excerpt_separator: ""
exclude:
- pubspec.yaml
- tool/
collections:
docs:
output: true
Expand Down
4 changes: 4 additions & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name: dart_code_website

dependencies:
path:
25 changes: 25 additions & 0 deletions tool/validate.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import 'dart:convert';
import 'dart:io';
import 'package:path/path.dart';

main() {
Directory.current = dirname(Platform.script.toFilePath());

final packageFile = File('../../Dart-Code/package.json');
final packageManifest = jsonDecode(packageFile.readAsStringSync());
final Map<String, dynamic> configOptions =
packageManifest['contributes']['configuration']['properties'];

validateSettingsDoc(configOptions);
}

void validateSettingsDoc(Map<String, dynamic> configOptions) {
final settingsFile = File('../_docs/settings.md');
final settingsContent = settingsFile.readAsStringSync();

configOptions.forEach((name, options) {
if (!settingsContent.contains('## $name')) {
print('Setting $name does not appear in docs!');
}
});
}

0 comments on commit 09cbeb3

Please sign in to comment.