microsoft / MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
https://aka.ms/mrtkdocs
MIT License
6.01k stars 2.12k forks source link

Minimize path lengths #9464

Closed david-c-kline closed 2 years ago

david-c-kline commented 3 years ago

With the move to NPM / UPM packaging, the package name (and a long string of digits applied by Unity) generate VERY long path names.

Each package needs to be audited for path lengths (folder + file name) to determine which need to be shortened. Once the audit is complete, a rename pass is to be performed and a mapping text file created in each folder.

Related to #9457

keveleigh commented 3 years ago

All files in our repo longer than 110 chars (this was an arbitrary threshold. we might want to figure out a more specific one):

.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\EventConfigurations\BaseInteractionEventConfiguration.cs.meta
.\Examples\Experimental\SceneUnderstanding\Profiles\DemoSceneUnderstandingMixedRealityToolkitConfigurationProfile.asset.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\States\UnityEventDefinitions\InteractionStateInactiveEvent.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderColorStateStateAnimatableProperty.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\States\UnityEventDefinitions\InteractionStateActiveEvent.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\PositionOffsetStateAnimatableProperty.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\EventConfigurations\BaseInteractionEventConfiguration.cs
.\Examples\Experimental\SceneUnderstanding\Profiles\DemoSceneUnderstandingMixedRealityToolkitConfigurationProfile.asset
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\SelectFarInteractionEvent.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\States\UnityEventDefinitions\InteractionStateInactiveEvent.cs
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderVectorStateAnimatableProperty.cs.meta
.\Examples\Experimental\NonNativeKeyboard\Profiles\NonNativeKeyboardMixedRealityToolkitConfigurationProfile.asset.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ScaleOffsetStateAnimatableProperty.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderFloatStateAnimatableProperty.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderColorStateStateAnimatableProperty.cs
.\SDK\Experimental\InteractiveElement\InteractiveElement\States\UnityEventDefinitions\InteractionStateActiveEvent.cs
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\SpeechInteractionEvent.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\PositionOffsetStateAnimatableProperty.cs
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\FocusInteractionEvent.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\TouchInteractionEvent.cs.meta
.\SDK\Editor\Inspectors\Experimental\InteractiveElement\InteractiveElement\BaseInteractiveElementInspector.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\SelectFarInteractionEvent.cs
.\Examples\Experimental\NonNativeKeyboard\Profiles\NonNativeKeyboardMixedRealityToolkitConfigurationProfile.asset
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderVectorStateAnimatableProperty.cs
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderFloatStateAnimatableProperty.cs
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ShaderStateAnimatableProperty.cs.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ScaleOffsetStateAnimatableProperty.cs
.\SDK\Experimental\InteractiveElement\Examples\Scripts\CustomStateExample\KeyboardState\KeyboardReceiver.cs.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\SpeechInteractionEvent.cs
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\EventConfigurations\SpeechKeywordEvents.cs.meta
.\Providers\Experimental\WindowsSceneUnderstanding\Profiles\DefaultSceneUnderstandingObserverProfile.asset.meta
.\SDK\Experimental\InteractiveElement\StateVisualizer\AnimatableProperties\ColorStateAnimatableProperty.cs.meta
.\Examples\Demos\UX\BoundsControl\Scenes\BoundsControlConfigs\CoffeeCupTranslateHandlesConfiguration.asset.meta
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\TouchInteractionEvent.cs
.\SDK\Experimental\InteractiveElement\InteractiveElement\Events\UnityEventDefinitions\FocusInteractionEvent.cs
.\SDK\Experimental\InteractiveElement\Examples\Scripts\CustomStateExample\KeyboardState\KeyboardEvents.cs.meta
.\SDK\Editor\Inspectors\Experimental\InteractiveElement\InteractiveElement\InteractiveElementInspector.cs.meta
.\SDK\Editor\Inspectors\Experimental\InteractiveElement\InteractiveElement\CompressableButtonInspector.cs.meta
.\Examples\Experimental\NonNativeKeyboard\Profiles\NonNativeKeyboardMixedRealityInputPointerProfile.asset.meta

To generate, run this from your Assets/MRTK folder (to allow for proper relative paths) (feel free to change 110 to whatever threshold you want):

Get-ChildItem -Recurse -Force | Resolve-Path -Relative | Where-Object { $_.Length -ge 110 } | Sort-Object @{Expression={$_.Length}; Ascending=$false} | Format-List
david-c-kline commented 3 years ago

This is an ongoing process. Moving to v3 for the full resolution to be in place. I anticipate some changes may occur in dot releases as specific pain points are identified.

david-c-kline commented 3 years ago

The anticipation is that package layout will be flattened (ex: to simple 'interfaces', 'baseclasses', 'prefabs', etc. with minimal subfolders)

stale[bot] commented 2 years ago

This issue has been marked as stale by an automated process because it has not had any recent activity. It will be automatically closed in 30 days if no further activity occurs. If this is still an issue please add a new comment with more recent details and repro steps.

david-c-kline commented 2 years ago

This is an ongoing process for MRTK3. There is no longer a need for a tracking issue