RFC: New directory structure and namespaces of the framework package

[caendesilva]

Preface

Before merging #623, I'd love to get some feedback on the proposed new directory and namespace structure for the framework package.

Why the change?

This change is made in preparation for HydePHP 1.0, in hopes of ensuring the framework is structured in a way that is maintainable and usable, but most importantly; one that makes sense. I feel like now is the time to make changes like these, before the BC promise kicks in.

Details

Change comparison

I have here outlined the directory structures for the current and proposed framework packages.

For this change, the namespace mapping has shifted, making the hyde/framework package's namespace now start at Hyde instead of Hyde\Framework. This is in hopes of future proofing it, allowing subpackages to be extracted without breaking namespaces.

Current directory structure

See https://github.com/hydephp/develop/tree/master/packages/framework/src

# packages/framework/src (current)

├── Actions
│   ├── Constructors
│   └── PostBuildTasks
├── Commands
├── Concerns
│   └── Internal
├── Contracts
│   └── FrontMatter
│       └── Support
├── Exceptions
├── Foundation
│   └── Concerns
├── Helpers
├── Models
│   ├── Markdown
│   ├── Navigation
│   ├── Pages
│   └── Support
├── Modules
│   ├── DataCollections
│   │   └── Facades
│   ├── Markdown
│   │   └── Shortcodes
│   └── Metadata
│       └── Models
├── Services
└── Views
    └── Components

Proposed directory structure

See https://github.com/hydephp/develop/tree/upcoming/packages/framework/src

# packages/framework/src (proposed)

├── Console
│   └── Commands
├── Facades
├── Foundation
│   └── Concerns
├── Framework
│   ├── Actions
│   ├── Concerns
│   │   └── Internal
│   ├── Exceptions
│   ├── Factories
│   │   └── Concerns
│   ├── Features
│   │   ├── Blogging
│   │   │   └── Models
│   │   ├── BuildTasks
│   │   │   └── PostBuildTasks
│   │   ├── DataCollections
│   │   │   └── Facades
│   │   ├── Documentation
│   │   ├── Metadata
│   │   │   └── Elements
│   │   ├── Navigation
│   │   └── Session
│   ├── Services
│   └── Views
│       └── Components
├── Markdown
│   ├── Contracts
│   │   └── FrontMatter
│   │       └── SubSchemas
│   ├── Models
│   └── Processing
├── Pages
│   └── Concerns
└── Support
    ├── Concerns
    └── Models

Wrap-up

I hope to get some feedback on this, as the proposed change is so breaking, and I want to make sure it's as good as possible before releasing as I think now is the best time to do this as the BC promise has not yet kicked in.

[caendesilva]

Appendix A

Here's a side-by-side comparison:

# packages/framework/src (current)          # packages/framework/src (proposed)   
                                                                                  
├── Actions                                 ├── Console                           
│   ├── Constructors                        │   └── Commands                      
│   └── PostBuildTasks                      ├── Facades                           
├── Commands                                ├── Foundation                        
├── Concerns                                │   └── Concerns                      
│   └── Internal                            ├── Framework                         
├── Contracts                               │   ├── Actions                       
│   └── FrontMatter                         │   ├── Concerns                      
│       └── Support                         │   │   └── Internal                  
├── Exceptions                              │   ├── Exceptions                    
├── Foundation                              │   ├── Factories                     
│   └── Concerns                            │   │   └── Concerns                  
├── Helpers                                 │   ├── Features                      
├── Models                                  │   │   ├── Blogging                  
│   ├── Markdown                            │   │   │   └── Models                
│   ├── Navigation                          │   │   ├── BuildTasks                
│   ├── Pages                               │   │   │   └── PostBuildTasks        
│   └── Support                             │   │   ├── DataCollections           
├── Modules                                 │   │   │   └── Facades               
│   ├── DataCollections                     │   │   ├── Documentation             
│   │   └── Facades                         │   │   ├── Metadata                  
│   ├── Markdown                            │   │   │   └── Elements              
│   │   └── Shortcodes                      │   │   ├── Navigation                
│   └── Metadata                            │   │   └── Session                   
│       └── Models                          │   ├── Services                      
├── Services                                │   └── Views                         
└── Views                                   │       └── Components                
    └── Components                          ├── Markdown                          
                                            │   ├── Contracts                     
                                            │   │   └── FrontMatter               
                                            │   │       └── SubSchemas            
                                            │   ├── Models                        
                                            │   └── Processing                    
                                            ├── Pages                             
                                            │   └── Concerns                      
                                            └── Support                           
                                                ├── Concerns                      
                                                └── Models                        

[caendesilva]

Got some great feedback via Twitter https://twitter.com/CodeWithCaen/status/1586684863360417793/