diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dd9e0d53..c70b42e2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.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 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8996423b..9163e982 100644 --- a/.github/workflows/build.yml +++ b/.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 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index cfb7f026..004ca97c 100644 --- a/.github/workflows/main.yml +++ b/.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 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f13791f9..8c166c27 100644 --- a/.github/workflows/publish.yml +++ b/.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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdf2dbbd..83e33d0e 100644 --- a/CONTRIBUTING.md +++ b/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: - ``` - ./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: ``` diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000..7d8cae1c --- /dev/null +++ b/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 +``` \ No newline at end of file diff --git a/scripts/before_push.dart b/scripts/before_push.dart new file mode 100644 index 00000000..e3de40b7 --- /dev/null +++ b/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 runCommand( + String executable, + List 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); +} diff --git a/scripts/before_push.sh b/scripts/before_push.sh deleted file mode 100755 index c3722f85..00000000 --- a/scripts/before_push.sh +++ /dev/null @@ -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." diff --git a/scripts/disable_local_dev.dart b/scripts/disable_local_dev.dart new file mode 100644 index 00000000..80136cee --- /dev/null +++ b/scripts/disable_local_dev.dart @@ -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 main(List 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 disable({required String packageDirectoryPath}) async { + final pubspecOverridesFile = + File(path.join(packageDirectoryPath, 'pubspec_overrides.yaml')); + if (await pubspecOverridesFile.exists()) { + await pubspecOverridesFile.delete(); + } +} diff --git a/scripts/disable_local_dev.sh b/scripts/disable_local_dev.sh deleted file mode 100755 index a7afe72a..00000000 --- a/scripts/disable_local_dev.sh +++ /dev/null @@ -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" \ No newline at end of file diff --git a/scripts/enable_local_dev.dart b/scripts/enable_local_dev.dart new file mode 100644 index 00000000..a41c4251 --- /dev/null +++ b/scripts/enable_local_dev.dart @@ -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 main(List 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 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); +} diff --git a/scripts/enable_local_dev.sh b/scripts/enable_local_dev.sh deleted file mode 100755 index eb682193..00000000 --- a/scripts/enable_local_dev.sh +++ /dev/null @@ -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" \ No newline at end of file diff --git a/scripts/packages.dart b/scripts/packages.dart new file mode 100644 index 00000000..0ad09cd6 --- /dev/null +++ b/scripts/packages.dart @@ -0,0 +1,7 @@ +/// The list of the packages in the repository. +const repoPackages = [ + './', + './dart_quill_delta', + './flutter_quill_extensions', + './flutter_quill_test', +]; diff --git a/scripts/pub_get.dart b/scripts/pub_get.dart new file mode 100644 index 00000000..2bb6b758 --- /dev/null +++ b/scripts/pub_get.dart @@ -0,0 +1,16 @@ +// ignore_for_file: avoid_print + +import 'dart:io' show Process; + +import 'packages.dart' show repoPackages; + +Future main(List args) async { + for (final package in repoPackages) { + await Process.run( + 'flutter', + ['pub', 'get'], + workingDirectory: package, + ); + } + print('Got dependencies!'); +} diff --git a/scripts/pub_get.sh b/scripts/pub_get.sh deleted file mode 100755 index 44df4ffe..00000000 --- a/scripts/pub_get.sh +++ /dev/null @@ -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) diff --git a/scripts/update_package_version.dart b/scripts/update_package_version.dart index 0ea5165f..63ac18db 100644 --- a/scripts/update_package_version.dart +++ b/scripts/update_package_version.dart @@ -7,14 +7,11 @@ import 'dart:io' show File, exit; import 'package:path/path.dart' as path; import 'package:yaml_edit/yaml_edit.dart' show YamlEditor; +import 'packages.dart'; + /// The list of the packages that which will be used to update the `CHANGELOG.md` /// and the version in the `pubspec.yaml` for all the packages -final _packages = [ - './', - './dart_quill_delta', - './flutter_quill_extensions', - './flutter_quill_test', -]; +const _packagesToUpdate = repoPackages; const _usage = 'Usage: ./script '; const _versionContentFileName = 'versionContent.md'; @@ -85,7 +82,7 @@ Future main(List args) async { ..write('$versionContent\n\n'); }); - for (final packagePath in _packages) { + for (final packagePath in _packagesToUpdate) { await _updatePubspecYamlFile( pubspecYamlPath: '$packagePath/pubspec.yaml', newVersion: passedVersion,