Improve Folder Structure for Better Maintainability

[thewahome]

Problem

The VsCode extension code is centered around one file extensions.ts as more commands are added the file grows.

The file is meant to handle
activation: - actions when the extension is loaded
deactivate: - actions when the extension is unloaded
command registration: - registration of the commands when the extension is loaded

It is currently handling all the above plus the definition and implementations of the commands making it hard to navigate

Proposed Solution

To enhance the maintainability and scalability of our VS Code extension, we should adopt a more organized structure. This structure should help in managing commands, utilities, and other components more effectively. It also makes it easier to add new features and commands without cluttering the main files.

For example:

• Have each command on its own file, making the codebase easier to navigate and maintain and have Separation of Concerns.
• Group related files together to promote modularity and reusability.
• Follow a consistent folder structure across the extension project to reduce confusion and streamline development as more people contribute.

Folder Visualisation

vscode/microsoft-kiota
├── .vscode/
├── src/
│ ├── commands/
│ │ ├── searchLockStepsCommand.ts
│ │ ├── searchApiDescriptionCommand.ts
│ │ ├── openInstallationInstructionsCommand.ts
│ │ └── selectLockCommand.ts
│ ├── handlers/
│ │ └── uriHandler.ts
│ ├── providers/
│ │ ├── dependenciesInfoProvider.ts
│ │ └── openApiTreeProvider.ts
│ ├── extension.ts
│ └── types.ts
├── node_modules/
├── ...
├── package.json
└── README.md

Tasks

Beta Give feedback

1. Create abstract command class that all commands can implement #5495
   vscode-extension +1
   
2. Move kiota.openApiExplorer.openDocumentationPage implementation to own command file #5498
   vscode-extension +1
   
3. Move kiota.openApiExplorer.addToSelectedEndpoints implementation to own command file #5499
   vscode-extension +1
   
4. Move kiota.openApiExplorer.addAllToSelectedEndpoints implementation to own command file #5500
   vscode-extension +1
   
5. Move generateClient implementation from extension.ts to own command file #5522
   vscode-extension +1
   
6. Move searchOrOpenApiDescription implementation from extension.ts to own command file #5519
   vscode-extension +1
   
7. Move kiota.editPaths implementation from extension.ts to own command file #5516
   vscode-extension +1
   
8. Move kiota.openApiExplorer.regenerateButton implementation from extension.ts to own command file #5550
   vscode-extension +1
   
9. Move kiota.updateClients implementation from extension.ts to own command file #5582
   vscode-extension +1
   
10. Move kiota.openApiExplorer.closeDescription implementation from extension.ts to own command file
11. Move kiota.selectLock implementation from extension.ts to own command file
12. Move kiota.status implementation from extension.ts to own command file
13. Move kiota.regenerate implementation from extension.ts to own command file
14. Move kiota.openApiExplorer.filterDescription implementation from extension.ts to own command file
15. Move kiota.migrateFromLockFile implementation from extension.ts to own command file
16. Move kiota.openApiExplorer.removeAllFromSelectedEndpoints implementation to own command file
17. Split steps.ts into separate step files for options available to the user #5589
    vscode-extension +1
    
18. Move provider files to the provider folder
19. Move model definitions files to types folder