docs: more make commands and add mobile checks to pr-checklist (#20211)

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
This commit is contained in:
shenlong 2025-07-25 17:54:08 +05:30 committed by GitHub
parent b48406bd20
commit 13281f8531
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 26 additions and 3 deletions

View File

@ -98,8 +98,7 @@ jobs:
run: dart analyze --fatal-infos
- name: Run dart format
# Ignore generated files manually until https://github.com/dart-lang/dart_style/issues/864 is resolved
run: dart format --set-exit-if-changed $(find lib -name '*.dart' -not \( -name 'generated_plugin_registrant.dart' -o -name '*.g.dart' -o -name '*.drift.dart' \))
run: make format
- name: Run dart custom_lint
run: dart run custom_lint

View File

@ -38,6 +38,19 @@ Run all server checks with `npm run check:all`
You can use `npm run __:fix` to potentially correct some issues automatically for `npm run format` and `lint`.
:::
## Mobile Checks
The following commands must be executed from within the mobile app directory of the codebase.
- [ ] `make build` (auto-generate files using build_runner)
- [ ] `make analyze` (static analysis via Dart Analyzer and DCM)
- [ ] `make format` (formatting via Dart Formatter)
- [ ] `make test` (unit tests)
:::info Auto Fix
You can use `dart fix --apply` and `dcm fix lib` to potentially correct some issues automatically for `make analyze`.
:::
## OpenAPI
The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/docs/developer/open-api.md) for more details.

View File

@ -1,4 +1,4 @@
.PHONY: build watch create_app_icon create_splash build_release_android pigeon
.PHONY: build watch create_app_icon create_splash build_release_android pigeon test analyze format
build:
dart run build_runner build --delete-conflicting-outputs
@ -29,3 +29,14 @@ translation:
dart run bin/generate_keys.dart
dart format lib/generated/codegen_loader.g.dart
dart format lib/generated/intl_keys.g.dart
analyze:
dart analyze --fatal-infos
dcm analyze lib --fatal-style --fatal-warnings
format:
# Ignore generated files manually until https://github.com/dart-lang/dart_style/issues/864 is resolved
dart format --set-exit-if-changed $$(find lib -name '*.dart' -not \( -name 'generated_plugin_registrant.dart' -o -name '*.g.dart' -o -name '*.drift.dart' \))
test:
flutter test