Skip to content

Add the ability to run update-readme command on a different project #82

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
johnpryan merged 3 commits into from
Apr 22, 2026
Merged

Add the ability to run update-readme command on a different project #82

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
631e71b
Add the ability to run update-readme command on a different project
johnpryan Apr 9, 2026
a20ff4b
run formatter
johnpryan Apr 14, 2026
9e869ef
Merge branch 'main' into update-update-readme
johnpryan Apr 14, 2026
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
27 changes: 23 additions & 4 deletions tool/generator/lib/src/commands/update_readme_command.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ import 'base_yaml_command.dart';
class UpdateReadmeCommand extends BaseYamlCommand {
/// Creates a new [UpdateReadmeCommand].
UpdateReadmeCommand({super.outputDir})
: super(logger: Logger('UpdateReadmeCommand'));
: super(logger: Logger('UpdateReadmeCommand')) {
argParser.addOption(
'readme',
help: 'Path to the README.md file to update.',
);
}

@override
String get name => 'update-readme';
Expand All @@ -29,9 +34,23 @@ class UpdateReadmeCommand extends BaseYamlCommand {
Directory outputDir, {
Directory? configDir,
}) async {
final readmePath = argResults!.rest.length > 1
? argResults!.rest[1]
: '../README.md';
String readmePath;
if (argResults?['readme'] != null) {
readmePath = argResults!['readme'] as String;
} else if (argResults!.rest.length > 1) {
readmePath = argResults!.rest[1];
} else {
final dirReadme = File(p.join(outputDir.path, 'README.md'));
final parentReadme = File(p.join(outputDir.parent.path, 'README.md'));

if (dirReadme.existsSync()) {
readmePath = dirReadme.path;
} else if (parentReadme.existsSync()) {
readmePath = parentReadme.path;
} else {
readmePath = '../README.md';
}
Comment thread
johnpryan marked this conversation as resolved.
}

final readmeFile = File(readmePath);

Expand Down
Loading