Skip to content

[tool] Support code excerpts for any .md file #4212

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 15, 2023
Merged

[tool] Support code excerpts for any .md file #4212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ec486b
[tool] Support code excerpts for any .md file
stuartmorgan-g Jun 14, 2023
9c7d30c
Adjust comment
stuartmorgan-g Jun 15, 2023
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
43 changes: 28 additions & 15 deletions script/tool/lib/src/update_excerpts_command.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import 'common/package_looping_command.dart';
import 'common/process_runner.dart';
import 'common/repository_package.dart';

/// A command to update README code excerpts from code files.
/// A command to update .md code excerpts from code files.
class UpdateExcerptsCommand extends PackageLoopingCommand {
/// Creates a excerpt updater command instance.
UpdateExcerptsCommand(
Expand Down Expand Up @@ -51,7 +51,7 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
final String name = 'update-excerpts';

@override
final String description = 'Updates code excerpts in README.md files, based '
final String description = 'Updates code excerpts in .md files, based '
'on code from code files, via code-excerpt';

@override
Expand Down Expand Up @@ -105,13 +105,16 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
}

if (getBoolArg(_failOnChangeFlag)) {
final String? stateError = await _validateRepositoryState();
final String? stateError = await _validateRepositoryState(package);
if (stateError != null) {
printError('README.md is out of sync with its source excerpts.\n\n'
'If you edited code in README.md directly, you should instead edit '
'the example source files. If you edited source files, run the '
'repository tooling\'s "$name" command on this package, and update '
'your PR with the resulting changes.');
printError('One or more .md files are out of sync with their source '
'excerpts.\n\n'
'If you edited code in a .md file directly, you should instead '
'edit the example source files. If you edited source files, run '
'the repository tooling\'s "$name" command on this package, and '
'update your PR with the resulting changes.\n\n'
'For more information, see '
'https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#readme-code');
return PackageResult.fail(<String>[stateError]);
}
}
Expand All @@ -138,14 +141,24 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
return exitCode == 0;
}

/// Runs the injection step to update [targetPackage]'s README with the latest
/// excerpts from [example], returning true on success.
/// Runs the injection step to update [targetPackage]'s top-level .md files
/// with the latest excerpts from [example], returning true on success.
Future<bool> _injectSnippets(
RepositoryPackage example, {
required RepositoryPackage targetPackage,
}) async {
final String relativeReadmePath =
getRelativePosixPath(targetPackage.readmeFile, from: example.directory);
final List<String> relativeMdPaths = targetPackage.directory
.listSync()
.whereType<File>()
.where((File f) =>
f.basename.toLowerCase().endsWith('.md') &&
// Exclude CHANGELOG since it should never have excerpts.
f.basename != 'CHANGELOG.md')
.map((File f) => getRelativePosixPath(f, from: example.directory))
.toList();
if (relativeMdPaths.isEmpty) {
return true;
}
final int exitCode = await processRunner.runAndStream(
'dart',
<String>[
Expand All @@ -154,7 +167,7 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
'--write-in-place',
'--yaml',
'--no-escape-ng-interpolation',
relativeReadmePath,
...relativeMdPaths,
],
workingDir: example.directory);
return exitCode == 0;
Expand Down Expand Up @@ -212,11 +225,11 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {

/// Checks the git state, returning an error string if any .md files have
/// changed.
Future<String?> _validateRepositoryState() async {
Future<String?> _validateRepositoryState(RepositoryPackage package) async {
final io.ProcessResult checkFiles = await processRunner.run(
'git',
<String>['ls-files', '--modified'],
workingDir: packagesDir,
workingDir: package.directory,
logOnError: true,
);
if (checkFiles.exitCode != 0) {
Expand Down
57 changes: 52 additions & 5 deletions script/tool/test/update_excerpts_command_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ void main() {

test('updates example readme when config is present', () async {
final RepositoryPackage package = createFakePlugin('a_package', packagesDir,
extraFiles: <String>[kReadmeExcerptConfigPath]);
extraFiles: <String>[kReadmeExcerptConfigPath, 'example/README.md']);
final Directory example = getExampleDir(package);

final List<String> output =
Expand Down Expand Up @@ -153,6 +153,52 @@ void main() {
]));
});

test('includes all top-level .md files', () async {
const String otherMdFileName = 'another_file.md';
final RepositoryPackage package = createFakePlugin('a_package', packagesDir,
extraFiles: <String>[kReadmeExcerptConfigPath, otherMdFileName]);
final Directory example = getExampleDir(package);

final List<String> output =
await runCapturingPrint(runner, <String>['update-excerpts']);

expect(
processRunner.recordedCalls,
containsAll(<ProcessCall>[
ProcessCall(
'dart',
const <String>[
'run',
'build_runner',
'build',
'--config',
'excerpt',
'--output',
'excerpts',
'--delete-conflicting-outputs',
],
example.path),
ProcessCall(
'dart',
const <String>[
'run',
'code_excerpt_updater',
'--write-in-place',
'--yaml',
'--no-escape-ng-interpolation',
'../README.md',
'../$otherMdFileName',
],
example.path),
]));

expect(
output,
containsAllInOrder(<Matcher>[
contains('Ran for 1 package(s)'),
]));
});

test('skips when no config is present', () async {
createFakePlugin('a_package', packagesDir);

Expand Down Expand Up @@ -277,7 +323,7 @@ void main() {

test('fails if example injection fails', () async {
createFakePlugin('a_package', packagesDir,
extraFiles: <String>[kReadmeExcerptConfigPath]);
extraFiles: <String>[kReadmeExcerptConfigPath, 'example/README.md']);

processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
FakeProcessInfo(MockProcess(), <String>['pub', 'get']),
Expand Down Expand Up @@ -307,7 +353,7 @@ void main() {
createFakePlugin('a_plugin', packagesDir,
extraFiles: <String>[kReadmeExcerptConfigPath]);

const String changedFilePath = 'packages/a_plugin/README.md';
const String changedFilePath = 'README.md';
processRunner.mockProcessesForExecutable['git'] = <FakeProcessInfo>[
FakeProcessInfo(MockProcess(stdout: changedFilePath)),
];
Expand All @@ -323,9 +369,10 @@ void main() {
expect(
output,
containsAllInOrder(<Matcher>[
contains('README.md is out of sync with its source excerpts'),
contains(
'One or more .md files are out of sync with their source excerpts'),
contains('Snippets are out of sync in the following files: '
'packages/a_plugin/README.md'),
'$changedFilePath'),
]));
});

Expand Down