Skip to content

refactor(mason)!: API updates to MasonBundle, MasonGenerator, and DirectoryGeneratorTarget#198

Merged
felangel merged 1 commit intomasterfrom
refactor/mason-core-api-improvements
Jan 19, 2022
Merged

refactor(mason)!: API updates to MasonBundle, MasonGenerator, and DirectoryGeneratorTarget#198
felangel merged 1 commit intomasterfrom
refactor/mason-core-api-improvements

Conversation

@felangel
Copy link
Owner

@felangel felangel commented Jan 19, 2022

Status

READY

Description

  • package:mason Core API Updates
    • MasonBundle
      • Use named constructor parameters instead of positional parameters
    • MasonGenerator.generate(...)
      • Accepts optional Logger and FileConflictResolution
    • DirectoryGeneratorTarget
      • No longer accepts optional Logger and FileConflictResolution (moved to generate API above)

Before

final generator = MasonGenerator.fromBundle(myBundle);
final target = DirectoryGeneratorTarget(dir, Logger(), FileConflictResolution.skip);
await generator.generate(target, vars: {...});

After

final generator = MasonGenerator.fromBundle(myBundle);
final target = DirectoryGeneratorTarget(dir);
await generator.generate(
  DirectoryGeneratorTarget(tempDir),
  vars: {...},
  logger: Logger(), // optional logger
  fileConflictResolution: FileConflictResolution.skip, // optional conflict resolution strategy
);

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

@felangel felangel added the breaking change Enhancement candidate would introduce a breaking change label Jan 19, 2022
@felangel felangel self-assigned this Jan 19, 2022
@felangel felangel changed the title refactor(mason)!: API improvements: MasonBundle, generate, and DirectoryGeneratorTarget refactor(mason)!: API updates to MasonBundle, MasonGenerator, and DirectoryGeneratorTarget Jan 19, 2022
@felangel felangel merged commit ba81b38 into master Jan 19, 2022
@felangel felangel deleted the refactor/mason-core-api-improvements branch January 19, 2022 03:07
alestiago pushed a commit to alestiago/mason that referenced this pull request Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking change Enhancement candidate would introduce a breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant