feat(shorebird_cli): add `ShorebirdYamlAssetValidator` #1907

borjandev · 2024-04-16T17:08:53Z

Description

Includes a validator, doctor, and doctor fix integration for :

flutter:
  assets:
    - shorebird.yaml

Attempts to handle most common, as well as not so common edge cases, includes tests.

Resolves #1888

Type of Change

✨ New feature (non-breaking change which adds functionality)
🛠️ Bug fix (non-breaking change which fixes an issue)
❌ Breaking change (fix or feature that would cause existing functionality to change)
🧹 Code refactor
✅ Build configuration change
📝 Documentation
🗑️ Chore

…lidator

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart

felangel

Thanks for the contribution! I left some comments, let me know what you think.

packages/shorebird_cli/lib/src/doctor.dart

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart

packages/shorebird_cli/test/src/validators/shorebird_yaml_asset_validator_test.dart

…ingle item

… static and public

…rjandev/shorebird into doctor/shorebird_yaml_asset_validator

bryanoltman

A couple minor comments, but otherwise looking good!

packages/shorebird_cli/lib/src/commands/init_command.dart

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart

packages/shorebird_cli/lib/src/commands/init_command.dart

…oesn't require a file

…ubspecAssets

…yaml modification tests

packages/shorebird_cli/test/src/shorebird_env_test.dart

packages/shorebird_cli/test/src/validators/shorebird_yaml_asset_validator_test.dart

…rjandev/shorebird into doctor/shorebird_yaml_asset_validator

packages/shorebird_cli/lib/src/shorebird_env.dart

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart

felangel

LGTM thanks so much for the contribution! 💙

felangel

Going to clean up one more test before merging.

borjandev and others added 5 commits April 16, 2024 16:05

[deps] ~ pin very_good_cli to 0.20.0, remove --analytics

adaad7b

[doctor] + shorebird_yaml_asset_validator

e4054e2

[tests] + shorebird_yaml_asset_validator_test

9c0ddd9

Merge branch 'shorebirdtech:main' into doctor/shorebird_yaml_asset_va…

dae17ae

…lidator

[tests] # typo in filename, unexpected . in error message

f1dc99c

eseidel requested a review from bryanoltman April 16, 2024 17:56

felangel assigned borjandev Apr 16, 2024

felangel reviewed Apr 16, 2024

View reviewed changes

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Outdated Show resolved Hide resolved

felangel reviewed Apr 16, 2024

View reviewed changes

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Outdated Show resolved Hide resolved

felangel reviewed Apr 16, 2024

View reviewed changes

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Outdated Show resolved Hide resolved

felangel reviewed Apr 16, 2024

View reviewed changes

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Outdated Show resolved Hide resolved

felangel requested changes Apr 16, 2024

View reviewed changes

bryanoltman reviewed Apr 16, 2024

View reviewed changes

borjandev and others added 8 commits April 17, 2024 00:38

[chore] ~ no shorebird.yaml found in pubspec.yaml assets message

e020c53

[doctor] ~ reworked logic, ~ YAML to Yaml, ~ messages, - p.join for s…

72ef631

…ingle item

[chore] + doc comment for ShorebirdYamlAssetValidator

68e4522

[doctor] ~ unified addShorebirdYamlToPubspecAssets logic by making it…

f14b608

… static and public

Merge branch 'main' into doctor/shorebird_yaml_asset_validator

8617cb9

[chore] ~ rework logic so that it's much more concise

802887b

[tests] ~ rework logic in order to leverage existing infrastructure

6a58f9b

Merge branch 'doctor/shorebird_yaml_asset_validator' of github.com:bo…

f42ac3f

…rjandev/shorebird into doctor/shorebird_yaml_asset_validator

borjandev requested review from felangel and bryanoltman April 17, 2024 07:19

bryanoltman reviewed Apr 17, 2024

View reviewed changes

packages/shorebird_cli/lib/src/commands/init_command.dart Outdated Show resolved Hide resolved

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Outdated Show resolved Hide resolved

borjandev added 2 commits April 17, 2024 16:20

[nit] ~ early return if pubspec contains shorebird.yaml

efe4a84

[chore] ~ move addShorebirdYamlToPubspecAssets to ShorebirdEnv

9995dbb

borjandev requested a review from bryanoltman April 17, 2024 14:31

bryanoltman reviewed Apr 17, 2024

View reviewed changes

packages/shorebird_cli/lib/src/commands/init_command.dart Outdated Show resolved Hide resolved

borjandev added 2 commits April 17, 2024 19:31

[chore] ~ addShorebirdYamlToPubspecAssets is not static anymore and d…

ef84d81

…oesn't require a file

[tests] ~ make init command tests compatible with addShorebirdYamlToP…

538a48a

…ubspecAssets

borjandev and others added 3 commits April 18, 2024 07:17

[init] + ensure addShorebirdYamlToPubspecAssets is called, - pubspec.…

2a138d6

…yaml modification tests

[tests] + addShorebirdYamlToPubspecAssets group

18faef1

Merge branch 'main' into doctor/shorebird_yaml_asset_validator

b191ea1

borjandev requested a review from bryanoltman April 18, 2024 05:30

Merge branch 'main' into doctor/shorebird_yaml_asset_validator

95ca303

bryanoltman reviewed Apr 19, 2024

View reviewed changes

borjandev added 5 commits April 20, 2024 01:10

[nit] + empty lines above tests

d4b1e12

[nit] ~ tear-off

660b983

[nit] ~ setupAll before setUp

9fa8706

[chore] ~ group few tests in validate group

36552e2

Merge branch 'doctor/shorebird_yaml_asset_validator' of github.com:bo…

034ec76

…rjandev/shorebird into doctor/shorebird_yaml_asset_validator

borjandev requested a review from bryanoltman April 19, 2024 23:23

bryanoltman approved these changes Apr 20, 2024

View reviewed changes

borjandev and others added 2 commits April 23, 2024 00:51

Merge branch 'main' into doctor/shorebird_yaml_asset_validator

013398f

Merge branch 'main' into doctor/shorebird_yaml_asset_validator

fabf9d2

felangel reviewed Apr 23, 2024

View reviewed changes

packages/shorebird_cli/lib/src/shorebird_env.dart Outdated Show resolved Hide resolved

felangel reviewed Apr 23, 2024

View reviewed changes

packages/shorebird_cli/lib/src/validators/shorebird_yaml_asset_validator.dart Show resolved Hide resolved

felangel added 2 commits April 23, 2024 15:22

refactor: move edit logic into PubspecEditor class

cb991b3

chore: dart format

a975216

bryanoltman approved these changes Apr 23, 2024

View reviewed changes

felangel approved these changes Apr 23, 2024

View reviewed changes

felangel added 2 commits April 23, 2024 15:25

chore: update bin to include pubspecEditorRef

25b1fb2

refactor: shorebird_yaml_asset_validator_test.dart

6ece990

felangel requested changes Apr 23, 2024

View reviewed changes

simplify test

6e8b3b6

felangel approved these changes Apr 23, 2024

View reviewed changes

tweak

8741f12

felangel changed the title ~~feat(shorebird_cli): shorebird.yaml validator for pubspec.yaml, integration with doctor and doctor --fix~~ feat(shorebird_cli): add ShorebirdYamlAssetValidator Apr 23, 2024

felangel enabled auto-merge (squash) April 23, 2024 20:47

felangel merged commit 5ab5b2c into shorebirdtech:main Apr 23, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(shorebird_cli): add `ShorebirdYamlAssetValidator` #1907

feat(shorebird_cli): add `ShorebirdYamlAssetValidator` #1907

borjandev commented Apr 16, 2024

felangel left a comment

bryanoltman left a comment

felangel left a comment

felangel left a comment

feat(shorebird_cli): add ShorebirdYamlAssetValidator #1907

feat(shorebird_cli): add ShorebirdYamlAssetValidator #1907

Conversation

borjandev commented Apr 16, 2024

Description

Type of Change

felangel left a comment

Choose a reason for hiding this comment

bryanoltman left a comment

Choose a reason for hiding this comment

felangel left a comment

Choose a reason for hiding this comment

felangel left a comment

Choose a reason for hiding this comment

feat(shorebird_cli): add `ShorebirdYamlAssetValidator` #1907

feat(shorebird_cli): add `ShorebirdYamlAssetValidator` #1907