Support component module prefix

[bluzky]

• Support module prefix
• Fix import when install sidebar

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces support for a configurable component module prefix. It modifies the salad.add mix task to use this prefix when generating new component files, allowing developers to customize the module structure of their SaladUI components.

Class diagram for updated module structure

classDiagram
    class ModuleStructure {
        +get_module_prefix()
    }
    note for ModuleStructure "Changed from fixed 'Web' suffix to configurable prefix or 'Web.Components'"

    class ComponentGenerator {
        +insert_target_module_name(source, file_name)
        +maybe_apply_additional_insertions(source, module_name, file_name)
    }
    note for ComponentGenerator "Updated to use new module prefix pattern"

    ModuleStructure --> ComponentGenerator: uses

Loading

Flow diagram for module prefix resolution

graph TD
    A[Start] --> B{Check :component_module_prefix}
    B -->|Not configured| C[Build from app name]
    C --> D[Camelize app name]
    D --> E[Append 'Web.Components']
    B -->|Configured| F[Use configured prefix]
    E --> G[Return prefix]
    F --> G
    G --> H[End]

Loading

File-Level Changes

Change	Details	Files
Introduce configurable component module prefix.	Fetch module prefix from application config. If no config is found, build default from app name. Update module name replacements to use the prefix.	lib/mix/tasks/salad.add.ex
Update module and use statements to use the new module prefix.	Replace defmodule SaladUI.([a-zA-Z0-9_]+) with defmodule #{module_name}.\1. Replace use SaladUI, :component with use #{String.trim_trailing(module_name, "s")}. Replace import SaladUI. with import #{module_name}..	lib/mix/tasks/salad.add.ex
Update LiveChart module name replacement to use the new module prefix.	Replace SaladUI.LiveChart with #{module_name}.LiveChart.	lib/mix/tasks/salad.add.ex

---

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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[bluzky]

address #141 and #144

[sourcery-ai]

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

Overall Comments:

• The conversion of the module prefix for the 'use SaladUI, :component' replacement uses String.trim_trailing(module_prefix, "s"), which might be brittle if the naming convention changes. Consider abstracting this logic into a helper function or making the transformation more explicit to better document the intended behavior.
• The new regex replace for 'import SaladUI.' now transforms it to 'import #{module_prefix}.'. Make sure this generic replacement doesn't unintentionally match and replace strings that shouldn't change. A more specific regex might help avoid unexpected behavior if there are similarly named modules.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}