Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TemplateNamingConvention #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Plugins/Linter/Linter.uplugin
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,21 @@
"Server",
"Client"
]
},
{
"Name": "TemplateLinter",
"Type": "Editor",
"LoadingPhase": "PreDefault",
"WhitelistPlatforms": [
"Win64",
"Win32",
"Mac",
"Linux"
],
"BlacklistTargets": [
"Server",
"Client"
]
}
]
}
20 changes: 20 additions & 0 deletions Plugins/Linter/Source/TemplateLinter/Private/TemplateLinter.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright 2019-2020 Gamemakin LLC. All Rights Reserved.

#include "TemplateLinter.h"

#define LOCTEXT_NAMESPACE "FTemplateLinterModule"

void FTemplateLinterModule::StartupModule()
{
// Super::StartupModule();
}

void FTemplateLinterModule::ShutdownModule()
{
// Super::ShutdownModule();
}

#undef LOCTEXT_NAMESPACE

IMPLEMENT_MODULE(FTemplateLinterModule, TemplateLinter)
DEFINE_LOG_CATEGORY(LogTemplateLinter);
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// Copyright 2019-2020 Gamemakin LLC. All Rights Reserved.
#include "TemplateNamingConvention.h"

#include "IAssetTypeActions.h"
#include "AssetToolsModule.h"
#include "Misc/BlacklistNames.h"

UTemplateNamingConvention::UTemplateNamingConvention(const FObjectInitializer& ObjectInitializer)
: Super(ObjectInitializer)
{
if(HasAnyFlags(EObjectFlags::RF_ClassDefaultObject))
{
return;
}

auto AddNamingConvention = [&](const FString& ObjectPath, const FString& Prefix = TEXT(""), const FString& Suffix = TEXT(""), const FName& Variant = NAME_None) {
ClassNamingConventions.Push(FLinterNamingConventionInfo(TSoftClassPtr<UObject>(FSoftObjectPath(ObjectPath)), Prefix, Suffix, Variant));
};

// Add all type action asset, reference SFilterList::MakeAddFilterMenu
{
FAssetToolsModule& AssetToolsModule = FModuleManager::LoadModuleChecked<FAssetToolsModule>(TEXT("AssetTools"));

// Get the browser type maps
TArray<TWeakPtr<IAssetTypeActions>> AssetTypeActionsList;
AssetToolsModule.Get().GetAssetTypeActionsList(AssetTypeActionsList);

// Sort the list
struct FCompareIAssetTypeActions
{
FORCEINLINE bool operator()(const TWeakPtr<IAssetTypeActions>& A, const TWeakPtr<IAssetTypeActions>& B) const
{
return A.Pin()->GetName().CompareTo(B.Pin()->GetName()) == -1;
}
};
AssetTypeActionsList.Sort(FCompareIAssetTypeActions());

TSharedRef<FBlacklistNames> AssetClassBlacklist = AssetToolsModule.Get().GetAssetClassBlacklist();

// For every asset type, add naming convention
for (int32 ClassIdx = 0; ClassIdx < AssetTypeActionsList.Num(); ++ClassIdx)
{
const TWeakPtr<IAssetTypeActions>& WeakTypeActions = AssetTypeActionsList[ClassIdx];
if (WeakTypeActions.IsValid())
{
TSharedPtr<IAssetTypeActions> TypeActions = WeakTypeActions.Pin();
if (ensure(TypeActions.IsValid()) && TypeActions->CanFilter())
{
UClass* SupportedClass = TypeActions->GetSupportedClass();
if (SupportedClass && AssetClassBlacklist->PassesFilter(SupportedClass->GetFName()))
{
AddNamingConvention(SupportedClass->GetPathName());
}
}
}
}
}

// Add missing asset and variant
{
// Animation
AddNamingConvention(TEXT("/Script/Engine.AnimLayerInterface"));
AddNamingConvention(TEXT("/Script/Engine.MorphTarget"));

// Artificial Intelligence
AddNamingConvention(TEXT("/Script/Engine.AIController"));
AddNamingConvention(TEXT("/Script/Engine.BTDecorator"));
AddNamingConvention(TEXT("/Script/Engine.BTService"));
AddNamingConvention(TEXT("/Script/Engine.BTTaskNode"));

// Blueprints
AddNamingConvention(TEXT("/Script/Engine.Blueprint"), "", "", "MacroLibrary");
AddNamingConvention(TEXT("/Script/Engine.Blueprint"), "", "", "Interface");
AddNamingConvention(TEXT("/Script/Engine.BlueprintFunctionLibrary"));

// Materials
AddNamingConvention(TEXT("/Script/Engine.Material"), "", "", "PostProcess");
AddNamingConvention(TEXT("/Script/Engine.MaterialInstanceConstant"), "", "", "PostProcess");
}

SortConventions();
}

23 changes: 23 additions & 0 deletions Plugins/Linter/Source/TemplateLinter/Public/TemplateLinter.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Copyright 2019-2020 Gamemakin LLC. All Rights Reserved.
#pragma once

#include "Modules/ModuleManager.h"

DECLARE_LOG_CATEGORY_EXTERN(LogTemplateLinter, Verbose, All);

class TEMPLATELINTER_API FTemplateLinterModule : public IModuleInterface
{
public:

/** IModuleInterface implementation */
virtual void StartupModule() override;
virtual void ShutdownModule() override;

virtual bool SupportsDynamicReloading() override
{
return false;
}

private:

};
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright 2019-2020 Gamemakin LLC. All Rights Reserved.
#pragma once

#include "CoreMinimal.h"
#include "LinterNamingConvention.h"
#include "TemplateNamingConvention.generated.h"

UCLASS()
class UTemplateNamingConvention : public ULinterNamingConvention
{
GENERATED_BODY()

public:

UTemplateNamingConvention(const FObjectInitializer& ObjectInitializer);

};
29 changes: 29 additions & 0 deletions Plugins/Linter/Source/TemplateLinter/TemplateLinter.Build.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright 2019-2020 Gamemakin LLC. All Rights Reserved.

using UnrealBuildTool;

public class TemplateLinter : ModuleRules
{
public TemplateLinter(ReadOnlyTargetRules Target) : base(Target)
{
PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;

PublicDependencyModuleNames.AddRange(
new string[]
{
"Core",
"CoreUObject",
"Engine",
"Linter"
}
);


PrivateDependencyModuleNames.AddRange(
new string[]
{

}
);
}
}