Plop Generators

We leverage Plop for scaffolding and basic code generation within our projects. Plop is a small tool that abstracts the boilerplate code you find yourself writing repeatedly, particularly when setting up new components or entities. You can learn more about it and see the source code here on GitHub.

Current Templates

Currently, our Plop setup includes templates for:

• Creating new entities
• Generating Lit components

These templates are designed to streamline the creation of common project structures, ensuring consistency and saving time.

Getting Started with Plop

yarn plop

This command will prompt you to select from the available generators configured defined in our plopfile.js. Then just follow the terminal options to generate your code.

Why Use Plop?

• Ease of Use: Plop's straightforward command line prompts guide you through the file generation process, making it accessible even to those new to the tool.

• Customizability: It is easy to customize and extend, allowing our team to maintain a robust set of generators that evolve with our needs.

• Efficiency: By reducing manual setup tasks, Plop allows developers to focus more on development and less on repetitive configuration.

Plop is highly recommended for all team members. Experimenting with existing generators and even attempting to create new ones can greatly enhance your productivity and familiarity with our project's architecture.