.pytool/Plugin: Add a plugin EccCheck

[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.ci.yaml

## @file\r
# CI configuration for MdeModulePkg\r
#\r
# Copyright (c) Microsoft Corporation\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
{\r
    ## options defined .pytool/Plugin/LicenseCheck\r
    "LicenseCheck": {\r
        "IgnoreFiles": []\r
    },\r
    ## options defined ci/Plugin/CompilerPlugin\r
    "CompilerPlugin": {\r
        "DscPath": "MdeModulePkg.dsc"\r
    },\r
    ## options defined ci/Plugin/HostUnitTestCompilerPlugin\r
    "HostUnitTestCompilerPlugin": {\r
        "DscPath": "Test/MdeModulePkgHostTest.dsc"\r
    },\r
\r
    ## options defined ci/Plugin/CharEncodingCheck\r
    "CharEncodingCheck": {\r
        "IgnoreFiles": [\r
            "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",\r
            "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/testc.c"\r
        ]\r
    },\r
\r
    ## options defined ci/Plugin/DependencyCheck\r
    "DependencyCheck": {\r
        "AcceptableDependencies": [\r
            "MdePkg/MdePkg.dec",\r
            "MdeModulePkg/MdeModulePkg.dec",\r
            "StandaloneMmPkg/StandaloneMmPkg.dec",\r
            "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an abstraction\r
        ],\r
        # For host based unit tests\r
        "AcceptableDependencies-HOST_APPLICATION":[\r
            "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"\r
        ],\r
        # For UEFI shell based apps\r
        "AcceptableDependencies-UEFI_APPLICATION":[],\r
        "IgnoreInf": []\r
    },\r
\r
    ## options defined ci/Plugin/DscCompleteCheck\r
    "DscCompleteCheck": {\r
        "IgnoreInf": [],\r
        "DscPath": "MdeModulePkg.dsc"\r
    },\r
    ## options defined ci/Plugin/HostUnitTestDscCompleteCheck\r
    "HostUnitTestDscCompleteCheck": {\r
        "IgnoreInf": [""],\r
        "DscPath": "Test/MdeModulePkgHostTest.dsc"\r
    },\r
\r
    ## options defined ci/Plugin/GuidCheck\r
    "GuidCheck": {\r
        "IgnoreGuidName": [],\r
        "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],\r
        "IgnoreFoldersAndFiles": [],\r
        "IgnoreDuplicates": [\r
            "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",\r
            "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",\r
        ]\r
    },\r
\r
    ## options defined ci/Plugin/LibraryClassCheck\r
    "LibraryClassCheck": {\r
        "IgnoreHeaderFile": []\r
    },\r
\r
    ## options defined ci/Plugin/SpellCheck\r
    "SpellCheck": {\r
        "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log\r
        "IgnoreStandardPaths": [     # Standard Plugin defined paths that should be ignore\r
            "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"\r
        ],\r
        "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files\r
            "Library/LzmaCustomDecompressLib/Sdk/DOC/*"\r
        ],\r
        "ExtendWords": [           # words to extend to the dictionary for this package\r
            "LIGHTGRAY",\r
            "DARKGRAY",\r
            "LIGHTBLUE",\r
            "LIGHTGREEN",\r
            "LIGHTCYAN",\r
            "LIGHTRED",\r
            "LIGHTMAGENTA",\r
            "FVMAIN",\r
            "VARCHECKPCD",\r
            "Getxx",\r
            "lzturbo"\r
        ],\r
        "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)\r
    }\r
}\r