chore(scripts): migrate the scripts from sh to dart (#2036)
* chore(scripts): migrate the scripts from sh to dart, update GitHub PR template * fix(ci): fix GitHub workflows failure by run 'flutter pub get' before running local development scriptpull/2040/head
Ellet
9 months ago
committed by
GitHub
parent
af7e4048ed
commit
28c59444bc
16 changed files with 155 additions and 173 deletions
@ -0,0 +1,9 @@ |
||||
# Scripts |
||||
|
||||
All the scripts must be run from the root project folder and not inside the scripts folder |
||||
|
||||
**Example:** |
||||
|
||||
```shell |
||||
dart ./scripts/pub_get.dart |
||||
``` |
||||
@ -0,0 +1,49 @@ |
||||
// ignore_for_file: avoid_print |
||||
|
||||
import 'dart:io'; |
||||
|
||||
void main() async { |
||||
await runCommand('flutter', ['analyze']); |
||||
|
||||
await runCommand('flutter', ['test']); |
||||
|
||||
await runCommand('flutter', ['pub', 'publish', '--dry-run']); |
||||
|
||||
await runCommand('dart', ['fix', '--apply']); |
||||
|
||||
await runCommand('dart', ['format', '.']); |
||||
|
||||
await runCommand('dart', ['format', '--set-exit-if-changed', '.']); |
||||
|
||||
await runCommand( |
||||
'flutter', |
||||
[ |
||||
'build', |
||||
'web', |
||||
'--release', |
||||
'--dart-define=CI=true', |
||||
], |
||||
workingDirectory: 'example', |
||||
); |
||||
|
||||
print(''); |
||||
|
||||
await runCommand('dart', ['./scripts/ensure_translations_correct.dart']); |
||||
|
||||
print(''); |
||||
|
||||
print('Checks completed.'); |
||||
} |
||||
|
||||
Future<void> runCommand( |
||||
String executable, |
||||
List<String> arguments, { |
||||
String? workingDirectory, |
||||
}) async { |
||||
print( |
||||
"Running '$executable ${arguments.join(' ')}' in directory '${workingDirectory ?? 'root'}'..."); |
||||
final result = await Process.run(executable, arguments, |
||||
workingDirectory: workingDirectory); |
||||
print(result.stdout); |
||||
print(result.stderr); |
||||
} |
||||
@ -1,43 +0,0 @@ |
||||
#!/bin/bash |
||||
|
||||
# The script must be run from the root project folder and not inside the scripts |
||||
|
||||
# TODO: Refactor this to a dart script to allow developers who use Windows to use it |
||||
|
||||
# Run Flutter analyze |
||||
echo "Running 'flutter analyze'..." |
||||
flutter analyze |
||||
|
||||
# Run Flutter test |
||||
echo "Running 'flutter test'..." |
||||
flutter test |
||||
|
||||
# Check if package is ready for publishing |
||||
echo "Running 'flutter pub publish --dry-run'..." |
||||
flutter pub publish --dry-run |
||||
|
||||
# Apply Dart fixes |
||||
echo "Running 'dart fix --apply'..." |
||||
dart fix --apply |
||||
|
||||
# Format Dart code |
||||
echo "Running 'dart format .'" |
||||
dart format . |
||||
|
||||
# Check dart code formatting |
||||
echo "Running 'dart format --set-exit-if-changed .'" |
||||
dart format --set-exit-if-changed . |
||||
|
||||
# Check flutter web example |
||||
echo "Running flutter build web --release --dart-define=CI=true." |
||||
(cd example && flutter build web --release --dart-define=CI=true) |
||||
|
||||
echo "" |
||||
|
||||
# Check the translations |
||||
echo "Running dart ./scripts/ensure_translations_correct.dart" |
||||
(dart ./scripts/ensure_translations_correct.dart) |
||||
|
||||
echo "" |
||||
|
||||
echo "Script completed." |
||||
@ -0,0 +1,24 @@ |
||||
// ignore_for_file: avoid_print |
||||
|
||||
import 'dart:io' show File; |
||||
|
||||
import 'package:path/path.dart' as path; |
||||
|
||||
import './pub_get.dart' as pub_get show main; |
||||
import 'packages.dart' show repoPackages; |
||||
|
||||
Future<void> main(List<String> args) async { |
||||
for (final package in repoPackages) { |
||||
await disable(packageDirectoryPath: package); |
||||
} |
||||
await pub_get.main([]); |
||||
print('Local development for all libraries has been disabled'); |
||||
} |
||||
|
||||
Future<void> disable({required String packageDirectoryPath}) async { |
||||
final pubspecOverridesFile = |
||||
File(path.join(packageDirectoryPath, 'pubspec_overrides.yaml')); |
||||
if (await pubspecOverridesFile.exists()) { |
||||
await pubspecOverridesFile.delete(); |
||||
} |
||||
} |
||||
@ -1,24 +0,0 @@ |
||||
#!/bin/bash |
||||
|
||||
# Please make sure to run this script in the root directory of the repository and not inside sub-folders |
||||
|
||||
# TODO: Refactor this to a dart script to allow developers who use Windows to use it |
||||
|
||||
echo "" |
||||
|
||||
echo "Disable local development for flutter_quill..." |
||||
rm pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_extensions..." |
||||
rm flutter_quill_extensions/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_test..." |
||||
rm flutter_quill_test/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Local development for all libraries has been disabled, please 'flutter pub get' for each one of them" |
||||
@ -0,0 +1,28 @@ |
||||
// ignore_for_file: avoid_print |
||||
|
||||
import 'dart:io' show File; |
||||
|
||||
import 'package:path/path.dart' as path; |
||||
|
||||
import './pub_get.dart' as pub_get show main; |
||||
import 'packages.dart' show repoPackages; |
||||
|
||||
Future<void> main(List<String> args) async { |
||||
for (final package in repoPackages) { |
||||
await enable(packageDirectoryPath: package); |
||||
} |
||||
await pub_get.main([]); |
||||
print('Local development for all libraries has been enabled'); |
||||
} |
||||
|
||||
Future<void> enable({required String packageDirectoryPath}) async { |
||||
final pubspecOverridesFile = |
||||
File(path.join(packageDirectoryPath, 'pubspec_overrides.yaml')); |
||||
final pubspecOverridesDisabledFile = |
||||
File(path.join(packageDirectoryPath, 'pubspec_overrides.yaml.disabled')); |
||||
if (!(await pubspecOverridesDisabledFile.exists())) { |
||||
print('$packageDirectoryPath does not support local development mode.'); |
||||
return; |
||||
} |
||||
await pubspecOverridesDisabledFile.copy(pubspecOverridesFile.path); |
||||
} |
||||
@ -1,24 +0,0 @@ |
||||
#!/bin/bash |
||||
|
||||
# Please make sure to run this script in the root directory of the repository and not inside sub-folders |
||||
|
||||
# TODO: Refactor this to a dart script to allow developers who use Windows to use it |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill..." |
||||
cp pubspec_overrides.yaml.disabled pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_extensions..." |
||||
cp flutter_quill_extensions/pubspec_overrides.yaml.disabled flutter_quill_extensions/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_test..." |
||||
cp flutter_quill_test/pubspec_overrides.yaml.disabled flutter_quill_test/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Local development for all libraries has been enabled, please 'flutter pub get' for each one of them" |
||||
@ -0,0 +1,7 @@ |
||||
/// The list of the packages in the repository. |
||||
const repoPackages = [ |
||||
'./', |
||||
'./dart_quill_delta', |
||||
'./flutter_quill_extensions', |
||||
'./flutter_quill_test', |
||||
]; |
||||
@ -0,0 +1,16 @@ |
||||
// ignore_for_file: avoid_print |
||||
|
||||
import 'dart:io' show Process; |
||||
|
||||
import 'packages.dart' show repoPackages; |
||||
|
||||
Future<void> main(List<String> args) async { |
||||
for (final package in repoPackages) { |
||||
await Process.run( |
||||
'flutter', |
||||
['pub', 'get'], |
||||
workingDirectory: package, |
||||
); |
||||
} |
||||
print('Got dependencies!'); |
||||
} |
||||
@ -1,8 +0,0 @@ |
||||
#!/usr/bin/env bash |
||||
|
||||
# TODO: Refactor this to a dart script to allow developers who use Windows to use it |
||||
|
||||
flutter pub get |
||||
(cd dart_quill_delta && flutter pub get) |
||||
(cd flutter_quill_extensions && flutter pub get) |
||||
(cd flutter_quill_test && flutter pub get) |
||||
Loading…
Reference in new issue