Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Remove mackup dependency #44

Merged
merged 3 commits into from
Nov 4, 2024
Merged

feat: Remove mackup dependency #44

merged 3 commits into from
Nov 4, 2024

Conversation

martimlobao
Copy link
Owner

@martimlobao martimlobao commented Nov 4, 2024

Summary by Sourcery

Remove the mackup dependency and implement custom logic for managing dotfiles and application settings using new functions 'dotlink' and 'dotunlink'. Update scripts to use rsync for copying files and managing symbolic links.

New Features:

  • Introduce new functions 'dotlink' and 'dotunlink' for managing symbolic links in the home directory.

Enhancements:

  • Replace mackup dependency with custom logic for managing dotfiles and application settings.

- use more straightforward logic for bootstrapping and unboostrapping
- mackup is broken and there are no signs of a fix
- see: lra/mackup#1924 lra/mackup#2035
Copy link
Contributor

sourcery-ai bot commented Nov 4, 2024

Reviewer's Guide by Sourcery

This PR removes the mackup dependency and replaces it with a more straightforward approach to managing dotfiles. The implementation introduces two new functions (dotlink and dotunlink) that handle symlinking and restoration of configuration files, replacing the previous rsync-based approach. The changes also include some renaming of directories and cleanup of the bootstrap process.

Sequence diagram for dotfile management process

sequenceDiagram
    actor User
    participant Script
    participant HomeDirectory

    User->>Script: Run bootstrap.sh
    alt Unlink files
        Script->>HomeDirectory: Restore files from linkme/
    else Link files
        Script->>HomeDirectory: Create directories from linkme/
        Script->>HomeDirectory: Symlink files from linkme/
    end
    Script->>HomeDirectory: Source .zprofile
Loading

Class diagram for updated bootstrap functions

classDiagram
    class BootstrapScript {
        +dotlink()
        +dotunlink()
    }
    note for BootstrapScript "Replaces mackup dependency with custom functions"

    class HomeDirectory {
        +createDirectory(path)
        +symlinkFile(source, target)
        +restoreFile(source, target)
    }
    BootstrapScript --> HomeDirectory
Loading

File-Level Changes

Change Details Files
Implement new dotfile management system
  • Add dotlink function to create symlinks for configuration files
  • Add dotunlink function to restore original files
  • Replace rsync-based file copying with symlink-based approach
  • Update command-line interface to support unlink operation
  • Improve user prompt formatting with colored text
bootstrap.sh
Update local setup script
  • Rename 'manual' directory to 'copyme'
  • Replace cp command with rsync for file copying
  • Add .DS_Store exclusion to rsync command
local.sh
Remove mackup from dependencies
  • Remove mackup formula from the apps list
apps.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @martimlobao - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The removal of git pull origin main from bootstrap.sh changes the update behavior - was this intentional? You might want to document this change if it was deliberate.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

bootstrap.sh Show resolved Hide resolved
@martimlobao martimlobao merged commit ed3368c into main Nov 4, 2024
3 checks passed
@martimlobao martimlobao deleted the feat/remove-mackup branch November 4, 2024 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant