-
Notifications
You must be signed in to change notification settings - Fork 125
Make dart_hooks config keys a single source of truth + guard shipped examples #152
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
Draft
reidbaker
wants to merge
1
commit into
flutter:main
Choose a base branch
from
reidbaker:dart-hooks-config-key-source-of-truth
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+82
−4
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // Copyright (c) 2026, the Dart project authors. Please see the AUTHORS file | ||
| // for details. All rights reserved. Use of this source code is governed by a | ||
| // BSD-style license that can be found in the LICENSE file. | ||
|
|
||
| import 'dart:io'; | ||
| import 'package:dart_hooks/src/dart_analyze_hook.dart'; | ||
| import 'package:dart_hooks/src/dart_format_hook.dart'; | ||
| import 'package:path/path.dart' as path; | ||
| import 'package:test/test.dart'; | ||
| import 'package:yaml/yaml.dart'; | ||
|
|
||
| /// Verifies that the `dart_hooks.yaml` files committed to the repository | ||
| /// actually enable the hooks. The committed files are the examples users copy, | ||
| /// and a key that does not match a hook's `configKey` leaves that hook silently | ||
| /// disabled (see https://github.com/flutter/skills/issues/150). | ||
| /// | ||
| /// This mirrors the enablement gate in `BaseHook.run()` | ||
| /// (`yaml.containsKey(configKey)` && `yaml[configKey] == true`) and reads the | ||
| /// keys from the same `configKeyName` constants the hooks use, so the shipped | ||
| /// files, the code, and this test cannot drift apart. | ||
| void main() { | ||
| group('Shipped dart_hooks.yaml examples', () { | ||
| // `dart test` runs with the package root as the current directory. The | ||
| // committed example files live there and at the surrounding monorepo | ||
| // locations. | ||
| final String packageRoot = Directory.current.path; | ||
| final candidatePaths = <String>[ | ||
| path.join(packageRoot, 'dart_hooks.yaml'), | ||
| path.join(packageRoot, '..', 'dart_hooks.yaml'), | ||
| path.join(packageRoot, '..', '..', 'dart_hooks.yaml'), | ||
| path.join(packageRoot, '..', 'dart_skills_lint', 'dart_hooks.yaml'), | ||
| ]; | ||
|
|
||
| final List<String> existingPaths = candidatePaths.where((p) => File(p).existsSync()).toList(); | ||
|
|
||
| test('at least one shipped example was found to verify', () { | ||
| // Guards against a wrong working directory silently passing the suite. | ||
| expect( | ||
| existingPaths, | ||
| isNotEmpty, | ||
| reason: | ||
| 'No committed dart_hooks.yaml files were found relative to ' | ||
| '$packageRoot. Checked: $candidatePaths', | ||
| ); | ||
| }); | ||
|
|
||
| for (final filePath in existingPaths) { | ||
| test('$filePath enables both hooks', () { | ||
| final dynamic yaml = loadYaml(File(filePath).readAsStringSync()); | ||
| expect(yaml, isA<Map<dynamic, dynamic>>(), reason: '$filePath is not a YAML map.'); | ||
| final yamlMap = yaml as Map<dynamic, dynamic>; | ||
|
|
||
| expect( | ||
| yamlMap[DartFormatHook.configKeyName], | ||
| isTrue, | ||
| reason: | ||
| '$filePath must enable the format hook with ' | ||
| '"${DartFormatHook.configKeyName}: true".', | ||
| ); | ||
| expect( | ||
| yamlMap[DartAnalyzeHook.configKeyName], | ||
| isTrue, | ||
| reason: | ||
| '$filePath must enable the analyze hook with ' | ||
| '"${DartAnalyzeHook.configKeyName}: true".', | ||
| ); | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When running tests from the monorepo root (e.g.,
dart test tool/dart_hooks),Directory.currentpoints to the monorepo root rather than the package root. This causes the relative paths incandidatePathsto resolve incorrectly, resulting in 3 out of the 4 configuration files being silently skipped during verification.Adjusting
packageRootto point to the actual package directory when run from the monorepo root ensures all 4 configuration files are always verified.