search

microsoft / PowerToys

Windows system utilities to maximize productivity
MIT License
111.69k stars 6.57k forks source link

[File Explorer] File Explorer Add-Ons folder and namespace naming inconsistency #13184

Open rdeveen opened 3 years ago

rdeveen commented 3 years ago

Description of the enhancement

The naming of the folders and the files for the "File Explorer Add-Ons" are inconsistence. Also the folder name is incorrect because the files for the preview handlers and the thumbnail provider are in that same folder.

Current naming

The name of the source folder: src\modules\previewpane

The build output folder for the projects: $(Platform)\$(Configuration)\modules\FileExplorerPreview\

The C# Namespace: Microsoft.PowerToys.PreviewHandler.Pdf / Svg Microsoft.PowerToys.ThumbnailHandler.Pdf / Svg SvgPreviewHandlerUnitTests / PdfPreviewHandlerUnitTests SvgThumbnailProviderUnitTests / PdfThumbnailProviderUnitTests

The project names: MarkdownPreviewHandler / PdfPreviewHandler / SvgPreviewHandler PdfThumbnailProvider / SvgThumbnailProvider UnitTests-MarkdownPreviewHandler / UnitTests-PdfPreviewHandler / UnitTests-SvgPreviewHandler UnitTests-PdfThumbnailProvider / UnitTests-SvgThumbnailProvider

Suggested naming:

The Source folder and Build output folder should have the same name: src\modules\FileExplorer $(Platform)\$(Configuration)\modules\FileExplorer\

The C# Namespaces for the preview handlers: Microsoft.PowerToys.FileExplorer_PreviewHandler.Pdf Microsoft.PowerToys.FileExplorer_PreviewHandler.Svg Microsoft.PowerToys.FileExplorer_PreviewHandler.Markdown

The namespace of the thumbnail providers should be named ThumbnailProvider: Microsoft.PowerToys.FileExplorer_ThumbnailProvider.Pdf / Microsoft.PowerToys.FileExplorer_ThumbnailProvider.Svg

The test project should be named *.UnitTests MarkdownPreviewHandler.UnitTests / PdfPreviewHandler.UnitTests / etc.

franky920920 commented 3 years ago

Seems like #9343 to me.

rdeveen commented 3 years ago

Not the same but definitely related. The naming suggested at that one is even better. Updated my suggestion.

crutkas commented 2 years ago

@stefansjfw we did work here, do you feel this has been addressed?

stefansjfw commented 2 years ago

@crutkas No, this is yet to be done. We should agree what the correct naming would be first