Feature/replace cleanup workflow with cli app

.github/templates/.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-  "dart.flutterSdkPath": ".fvm/flutter_sdk",
+  "dart.flutterSdkPath": ".fvm/versions/{{flutterVersion}}",
   "search.exclude": {
     "**/.fvm": true
   },

.github/workflows/template-cleanup.yaml

@@ -30,60 +30,21 @@ jobs:
       # - name: Create issues from challenges
       #   uses: ./.github/actions/create-issues-from-challenges
 
-      - name: Cleanup
+      # https://github.com/dart-lang/setup-dart
+      - name: Set up dart
+        uses: dart-lang/setup-dart@v1
+        with:
+          sdk: "3.3.0" # See: tools/cleanup_template/pubspec.yaml
+
+      - name: Install dependencies
+        run: dart pub get
         shell: bash
-        run: |
-          # Make tmp dir and move work dir to tmp
-          mkdir "tmp" && cd tmp || exit
-
-          # Install fvm
-          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
-          brew tap leoafarias/fvm
-          brew install fvm
-
-          # Install & Setup Flutter
-          flutterLatestVersion=$(fvm releases | grep -o -E "v?[0-9]+\.[0-9]+\.[0-9]+\s+stable" | sed -e "s/[ ]*stable//g")
-          fvm install "$flutterLatestVersion"
-          fvm use "$flutterLatestVersion" --force
-
-          # Create Flutter Project
-          fvm flutter create \
-            -t app \
-            --empty \
-            -i swift \
-            -a kotlin \
-            --platforms ios,android \
-            --org jp.co.yumemi \
-            --project-name flutter_training \
-            .
-
-          # Add lints to dev_dependencies
-          fvm flutter pub add dev:yumemi_lints
-          fvm flutter pub remove flutter_lints
-
-          # Override the analysis_options.yaml
-          cat <<EOF > analysis_options.yaml
-          # https://pub.dev/packages/yumemi_lints
-          include: package:yumemi_lints/flutter/$flutterLatestVersion/recommended.yaml
-          EOF
-
-          # Move work dir to project root
-          cd ..
-
-          # Copy templates
-          cp -R .github/templates/. tmp
-
-          # Delete anything except tmp dir
-          rm -rf \
-            .github \
-            docs \
-            packages \
-            .gitignore \
-            LICENSE \
-            README.md
-
-          # Move new training project to project root
-          mv -f tmp/* tmp/.[^\.]* ./ && rm -rf tmp
+        working-directory: tools/cleanup_template
+
+      - name: Run cleanup_template
+        run: dart run bin/cleanup_template.dart
+        shell: bash
+        working-directory: tools/cleanup_template
 
       - name: Commit files
         run: |
@@ -97,4 +58,4 @@ jobs:
         uses: ad-m/[email protected]
         with:
           branch: main
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

tools/cleanup_template/.gitattributes

@@ -0,0 +1,2 @@
+*.freezed.dart linguist-generated=true
+*.g.dart linguist-generated=true

tools/cleanup_template/.gitignore

@@ -0,0 +1,6 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# custom_lint
+*.log

tools/cleanup_template/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

tools/cleanup_template/README.md

@@ -0,0 +1,41 @@
+# CLI to Cleanup flutter-training-template
+
+This CLI is run when a new repository is created from flutter-training-template.
+
+This CLI provides an environment for receiving Flutter training.
+
+## Get Started
+
+### 1. Install Dart SDK
+
+Before using this tool, make sure you have the Dart SDK installed. You can follow the instructions in the official documentation to install the Dart SDK and set up the dart command:
+
+[Install Dart SDK]
+
+> **Note**
+> Ensure that your Dart SDK version is 3.3.0.
+
+### 2. Install Dependencies
+
+After installing the Dart SDK, you need to install the project dependencies using the following command:
+
+```shell
+dart pub get
+```
+
+## Usage
+
+> **Note**
+> This package is intended for use exclusively within the GitHub Actions workflow of [yumemi-inc/flutter-training-template] and is not published on [Pub.dev].
+
+To run cleanup_template, execute the following command:
+
+```shell
+dart run bin/cleanup_template.dart
+```
+
+<!-- Links -->
+
+[Install Dart SDK]: https://dart.dev/get-dart
+[yumemi-inc/flutter-training-template]: https://github.com/yumemi-inc/flutter-training-template
+[Pub.dev]: https://pub.dev/

tools/cleanup_template/analysis_options.yaml

@@ -0,0 +1,8 @@
+include: package:yumemi_lints/dart/3.3.0/recommended.yaml
+
+analyzer:
+  plugins:
+    - custom_lint
+  errors:
+    # https://pub.dev/packages/freezed
+    invalid_annotation_target: ignore

tools/cleanup_template/bin/cleanup_template.dart

@@ -0,0 +1,12 @@
+import 'dart:io';
+
+import 'package:cleanup_template/cleanup_template.dart' as cleanup_template;
+
+void main() async {
+  final status = await cleanup_template.run();
+
+  return Future.wait([
+    stdout.close(),
+    stderr.close(),
+  ]).then((_) => exit(status.code));
+}

tools/cleanup_template/build.yaml

@@ -0,0 +1,20 @@
+targets:
+  $default:
+    builders:
+      # https://github.com/dart-lang/source_gen#ignore_for_file
+      source_gen:combining_builder:
+        options:
+          ignore_for_file:
+            - type=lint
+            - duplicate_ignore
+      json_serializable:
+        generate_for:
+          include:
+            - lib/src/models/*.dart
+        options:
+          # json のデシリアライズ時に発生する Exception を CheckedFromJsonException にまとめる
+          checked: true
+      freezed:
+        generate_for:
+          include:
+            - lib/src/models/*.dart

tools/cleanup_template/lib/cleanup_template.dart

@@ -0,0 +1,37 @@
+import 'package:cleanup_template/src/models/exit_status.dart';
+import 'package:cleanup_template/src/services/cleanup_service.dart';
+import 'package:cleanup_template/src/services/flutter_sdk_service.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:riverpod/riverpod.dart';
+
+Future<ExitStatus> run() async {
+  final container = ProviderContainer();
+
+  try {
+    final exitStatus = await cleanupTemplate(container);
+    return exitStatus;
+  } finally {
+    container.dispose();
+  }
+}
+
+Future<ExitStatus> cleanupTemplate(ProviderContainer container) async {
+  final flutterSdkService = container.read(flutterSdkServiceProvider);
+  final cleanupService = container.read(cleanupServiceProvider);
+
+  try {
+    final flutterVersion = await flutterSdkService.getLatestFlutterSdkVersion();
+    final exitStatus = cleanupService.call(flutterVersion);
+
+    return exitStatus;
+  } on CheckedFromJsonException catch (e) {
+    print(e.message);
+    return ExitStatus.errors;
+  } on FormatException catch (e) {
+    print(e.message);
+    return ExitStatus.errors;
+  } on Exception catch (e) {
+    print(e);
+    return ExitStatus.errors;
+  }
+}

tools/cleanup_template/lib/src/clients/app_client.dart

@@ -0,0 +1,25 @@
+import 'package:http/http.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'app_client.g.dart';
+
+@Riverpod(keepAlive: true, dependencies: [])
+AppClient appClient(AppClientRef ref) {
+  final appClient = AppClient(Client());
+  ref.onDispose(appClient.close);
+  return appClient;
+}
+
+class AppClient extends BaseClient {
+  AppClient(this._inner);
+
+  final Client _inner;
+
+  @override
+  Future<StreamedResponse> send(BaseRequest request) async {
+    return _inner.send(request).timeout(const Duration(seconds: 3));
+  }
+
+  @override
+  void close() => _inner.close();
+}

tools/cleanup_template/lib/src/file_system.dart

@@ -0,0 +1,8 @@
+import 'package:file/file.dart';
+import 'package:file/local.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'file_system.g.dart';
+
+@Riverpod(dependencies: [])
+FileSystem fileSystem(FileSystemRef ref) => LocalFileSystem();

tools/cleanup_template/lib/src/models/exit_status.dart

@@ -0,0 +1,17 @@
+/// https://dart.dev/tutorials/server/cmdline#setting-exit-codes
+enum ExitStatus {
+  success(0),
+  warnings(1),
+  errors(2),
+  ;
+
+  const ExitStatus(this.code);
+
+  factory ExitStatus.fromCode(int code) => switch (code) {
+        0 => ExitStatus.success,
+        1 => ExitStatus.warnings,
+        _ => ExitStatus.errors,
+      };
+
+  final int code;
+}

tools/cleanup_template/lib/src/models/flutter_sdk_release.dart

@@ -0,0 +1,32 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:pub_semver/pub_semver.dart';
+
+part 'flutter_sdk_release.freezed.dart';
+part 'flutter_sdk_release.g.dart';
+
+@freezed
+class FlutterSdkRelease with _$FlutterSdkRelease {
+  factory FlutterSdkRelease({
+    required FlutterChannel channel,
+    @_VersionJsonConverter() required Version version,
+  }) = _FlutterSdkRelease;
+
+  factory FlutterSdkRelease.fromJson(Map<String, dynamic> json) =>
+      _$FlutterSdkReleaseFromJson(json);
+}
+
+enum FlutterChannel {
+  dev,
+  beta,
+  stable,
+}
+
+class _VersionJsonConverter implements JsonConverter<Version, String> {
+  const _VersionJsonConverter();
+
+  @override
+  Version fromJson(String value) => Version.parse(value);
+
+  @override
+  String toJson(Version version) => version.toString();
+}