Tools for Project Structuring: Code Generation and Configurations

Related Definitions

- Scaffolding: Process that automatically creates the initial structure of a project, facilitating the start of development.
- Code Generation: Automated process of creating code from models or templates, with the aim of reducing duplication and accelerating development.
- Platform Tools: Set of tools that assist in the creation, management and maintenance of projects and systems, including code generation, configurations, deployment automation and integration with other platforms.

Context

Companies have a code base that is used in most projects. Practically, a new project is made up of the particularities of the domain, the base code for operation and the configurations.
However, it is necessary to ensure that projects follow a structure accepted by the team. It would be beneficial for this structure to be the same for all projects of the same nature.

Benefits

• Consistent structure in projects
• Useful for the platform team
• Code standardization
• Automatic configuration
• Reducing repetitive code (boilerplate)
• Componentization in some cases
• Focus on implementing business rules
• Faster learning curve
• Facilitates the integration of new members

Most Popular Code Generation Tools

The most popular frameworks and languages ​​offer scaffolding tools that help you quickly create project structure. Some examples:
- Dotnet, Dotnet-code generator: Automatically generates project structure and base code for .NET applications.
- Rails scaffolding: Automatically creates the code and views for a basic CRUD in Ruby on Rails.
- PHP Laravel artisan: Command-line tool that generates code and structure for Laravel projects.
- Service Weaver: Generates the microservices structure in .NET, facilitating the creation and configuration of services.
- Java Tool: *Tools like Spring Boot and JHipster that generate code for Java applications.
*- Node.js Tool: Tools like Yeoman that generate project templates in Node.js.
- Other examples: Tools like Angular CLI and Vue CLI for generating front-end projects.

How to Create a Code Generation Tool

• Define a template or model (folders, settings and common codes).
• Standardize authentication, database connection and configurations in the template.
• Manage folders and files automatically.
• Copy or write the files with the template content.
• Allow project generation according to parameters (architecture, database, language, etc.).
• If necessary, offer CLI and Web interfaces, depending on the developer's preference.

Large Companies: Platform Team

Most large companies have a team, formally called the Platform Team, which is dedicated to creating tools and platforms to generate project structure, migrate data, generate code, deploy and configure cloud environments.

The gains reported by these companies are significant, including increased productivity, faster integration of new developers and faster product delivery. Some companies go further, automating MVPs based on their internal indicators, using the most common tools.

Conclusion

Creating tools that reduce development effort can increase team productivity and speed up project delivery. It is important to establish an organization standard and implement it in a tool, which will bring several benefits.

Tool Examples

- AppGen: https://github.com/ortizdavid/appgen-files
- DbSample: https://github.com/ortizdavid/dbsample

- Go-Packager: https://github.com/ortizdavid/go-packager
- Data Source Generator: https://github.com/ortizdavid/data-source-generator

The above is the detailed content of Tools for Project Structuring: Code Generation and Configurations. For more information, please follow other related articles on the PHP Chinese website!