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 script

Author: EchoEllet

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,6 +4,10 @@ Thank you for contributing.
 
 Provide a description of your changes below and a general summary in the title.
 
+Consider reading the Contributor Guide: https://github.com/singerdmx/flutter-quill/blob/master/CONTRIBUTING.md.
+
+The changes of `CHANGELOG.md` and package version in `pubspec.yaml` are automated.
+
 -->
 
 ## Description
@@ -36,8 +40,9 @@ Put an x in all the boxes that apply:
 - [ ] 🛠️ **Bug fix:** Resolves an issue without altering current behavior.
 - [ ] 🧹 **Code refactor:** Code restructuring that does not affect behavior.
 - [ ] ❌ **Breaking change:** Alters existing functionality and requires updates.
+- [ ] 🧪 **Tests:** Adds new tests or modifies existing tests.
 - [ ] 📝 **Documentation:** Updates or additions to documentation.
-- [ ] 🗑️ **Chore:** Routine tasks, tests, or maintenance.
+- [ ] 🗑️ **Chore:** Routine tasks, or maintenance.
 - [ ] ✅ **Build configuration change:** Changes to build or deploy processes.
 
 ## Suggestions

.github/workflows/build.yml

@@ -24,12 +24,12 @@ jobs:
       - name: 🔍 Verify Flutter installation
         run: flutter --version
 
-      - name: 🚧 Enable local development environment (use the local packages)
-        run: ./scripts/enable_local_dev.sh
-
       - name: 📥 Install Flutter dependencies
         run: flutter pub get
 
+      - name: 🚧 Enable local development environment (use the local packages)
+        run: dart ./scripts/enable_local_dev.dart
+
       - name: 🌐 Build Flutter Web Application
         run: flutter build web --release --verbose --dart-define=CI=true
         working-directory: ./example
@@ -47,56 +47,3 @@ jobs:
       - name: 🐧 Build Flutter Linux Desktop Application
         run: flutter build linux --release --verbose --dart-define=CI=true
         working-directory: ./example
-
-        # build_windows:
-        #   name: Build Windows App
-        #   runs-on: windows-latest
-
-        #   steps:
-        #       - uses: actions/checkout@v4
-        #       - uses: subosito/flutter-action@v2
-        #         with:
-        #           channel: 'stable'
-        #           cache: true
-
-        #       - name: Check flutter version
-        #         run: flutter --version
-
-        #       # Sh scripts is not supported on windows
-        #       - name: Enable Local Dev
-        #         run: ./scripts/enable_local_dev.sh
-
-        #       - name: Install dependencies
-        #         run: flutter pub get
-
-        #       - name: Flutter build windows
-        #         run: flutter build windows --release --verbose --dart-define=CI=true
-        #         working-directory: ./example
-
-        # build_macOS:
-        #   name: Build macOS App
-        #   runs-on: macos-latest
-
-        #   steps:
-        #       - uses: actions/checkout@v4
-        #       - uses: subosito/flutter-action@v2
-        #         with:
-        #           channel: 'stable'
-        #           cache: true
-
-        #       - name: Check flutter version
-        #         run: flutter --version
-
-        #       - name: Enable Local Dev
-        #         run: ./scripts/enable_local_dev.sh
-
-        #       - name: Install dependencies
-        #         run: flutter pub get
-
-  #       - name: Flutter build macOS
-  #         run: flutter build macos --release --verbose --dart-define=CI=true
-  #         working-directory: ./example
-
-  #       - name: Flutter build iOS
-  #         run: flutter build ios --release --verbose --dart-define=CI=true
-  #         working-directory: ./example

.github/workflows/main.yml

@@ -24,12 +24,12 @@ jobs:
       - name: 🔍 Verify Flutter installation
         run: flutter --version
 
-      - name: 🚧 Enable local development environment (use the local packages)
-        run: ./scripts/enable_local_dev.sh
-
       - name: 📥 Install Flutter dependencies
         run: flutter pub get
 
+      - name: 🚧 Enable local development environment (use the local packages)
+        run: dart ./scripts/enable_local_dev.dart
+
       - name: 📦 Install dart_quill_delta dependencies
         run: flutter pub get -C dart_quill_delta
 

.github/workflows/publish.yml

@@ -37,12 +37,12 @@ jobs:
 
       - name: 🔍 Verify Flutter installation
         run: flutter --version
-      
-      - name: 🚧 Enable local development environment (use the local packages)
-        run: ./scripts/enable_local_dev.sh
 
       - name: 📥 Install Flutter dependencies
         run: flutter pub get
+
+      - name: 🚧 Enable local development environment (use the local packages)
+        run: dart ./scripts/enable_local_dev.dart
 
       # This is needed in order for the authentication to success
       # dart pub token add https://pub.dev --env-var PUB_TOKEN

CONTRIBUTING.md

@@ -58,14 +58,13 @@ You will need a GitHub account as well as Git installed and configured with your
     cp pubspec_overrides.yaml.disabled pubspec_overrides.yaml
     ```
    or save some time with the following script:
-    <!-- TODO: We should update this script to dart instead -->
     ```
-    ./scripts/enable_local_dev.sh
+    dart ./scripts/enable_local_dev.dart
     ```
 8. Test them in the [example](./example) and add changes in there if necessary
 9. Run the following script if possible
-   ```
-   ./scripts/before_push.sh
+   ```shell
+   dart ./scripts/before_push.dart
    ```
 10. When you are done sending your pull request, run:
     ```

scripts/README.md

@@ -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
+```

scripts/before_push.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);
+}

scripts/before_push.sh

@@ -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();
+  }
+}