Re: [edk2-devel] [PATCH v2 0/4] Update Node to 14.x to resolve cspell failure

["PierreGondois" <pierre.gondois@arm.com>]

Hi Kun and Sean,
As a follow-up to your patch-set, it seems that the spell checker does not currently run as expected. It only runs on files that are 'one level deep' in each package.
I.e.:
This was taken from Build/CI_BUILDLOG.txt from the TARGET_ARM_ARMPLATFORM artifact at https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=23939&view=artifacts&pathAsName=false&type=publishedArtifacts but this can be checked when running the CI locally on ArmPlatformPkg:

-------Log start---------
INFO - Cmd to run is: cspell --config /home/vsts/work/1/s/Build/ArmPlatformPkg/cspell_actual_config.json ArmPlatformPkg/**/*.c ArmPlatformPkg/**/*.h ArmPlatformPkg/**/*.nasm ArmPlatformPkg/**/*.masm ArmPlatformPkg/**/*.asl ArmPlatformPkg/**/*.dsc ArmPlatformPkg/**/*.dec ArmPlatformPkg/**/*.fdf ArmPlatformPkg/**/*.inf ArmPlatformPkg/**/*.md ArmPlatformPkg/**/*.txt
INFO - ------------------------------------------------
INFO - --------------Cmd Output Starting---------------
INFO - ------------------------------------------------
INFO -  1/22 ./ArmPlatformPkg/MemoryInitPei/MemoryInitPeiLib.c 829.48ms
INFO -  2/22 ./ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c 37.06ms
INFO -  3/22 ./ArmPlatformPkg/PlatformPei/PlatformPeiLib.c 13.01ms
INFO -  4/22 ./ArmPlatformPkg/PlatformPei/PlatformPeim.c 16.99ms
INFO -  5/22 ./ArmPlatformPkg/PrePeiCore/MainMPCore.c 25.68ms
INFO -  6/22 ./ArmPlatformPkg/PrePeiCore/MainUniCore.c 19.50ms
INFO -  7/22 ./ArmPlatformPkg/PrePeiCore/PrePeiCore.c 20.86ms
INFO -  8/22 ./ArmPlatformPkg/PrePi/MainMPCore.c 18.98ms
INFO -  9/22 ./ArmPlatformPkg/PrePi/MainUniCore.c 9.86ms
INFO - 10/22 ./ArmPlatformPkg/PrePi/PrePi.c 26.83ms
INFO - 11/22 ./ArmPlatformPkg/PrePeiCore/PrePeiCore.h 15.71ms
INFO - 12/22 ./ArmPlatformPkg/PrePi/PrePi.h 16.49ms
INFO - 13/22 ./ArmPlatformPkg/ArmPlatformPkg.dsc 21.03ms
INFO - 14/22 ./ArmPlatformPkg/ArmPlatformPkg.dec 24.63ms
INFO - 15/22 ./ArmPlatformPkg/MemoryInitPei/MemoryInitPeiLib.inf 11.12ms
INFO - 16/22 ./ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.inf 15.85ms
INFO - 17/22 ./ArmPlatformPkg/PlatformPei/PlatformPeiLib.inf 9.89ms
INFO - 18/22 ./ArmPlatformPkg/PlatformPei/PlatformPeim.inf 9.14ms
INFO - 19/22 ./ArmPlatformPkg/PrePeiCore/PrePeiCoreMPCore.inf 13.97ms
INFO - 20/22 ./ArmPlatformPkg/PrePeiCore/PrePeiCoreUniCore.inf 9.92ms
INFO - 21/22 ./ArmPlatformPkg/PrePi/PeiMPCore.inf 12.01ms
INFO - 22/22 ./ArmPlatformPkg/PrePi/PeiUniCore.inf 18.06ms
INFO - CSpell: Files checked: 22, Issues found: 0 in 0 files
INFO - ------------------------------------------------
INFO - --------------Cmd Output Finished---------------
INFO - --------- Running Time (mm:ss): 00:01 ----------
INFO - ----------- Return Code: 0x00000000 ------------
INFO - ------------------------------------------------
PROGRESS - --->Test Success: Spell Check Test NO-TARGET
-------Log end---------

As shown, in the "ArmPlatformPkg/**/*.c" expression, "**" is evaluated as a single directory instead of any number of directories. This can be fixed by:
 - setting the globstar variable (tried on bash): "shopt -s globstar", run "shopt globstar" to check its value, or
 - modifying .pytool/Plugin/SpellCheck/SpellCheck.py to add quotes around the files to check so that cspell evaluates the "**" by itself. This solution seems better as it doesn't require to modify the environment.

Regards,
Pierre

On 6/14/21 7:34 PM, Kun Qin via groups.io wrote:
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3445
>
> This patch series is a follow up of previous submission:
> https://edk2.groups.io/g/devel/message/76419
>
> v2 patches mainly focus on feedback for reviewed commits in v1 patches,
> including:
> a. Adding "Reviewed-by" tags for applicable patches;
> b. Adding "Signed-Off-by" tags for myself for all patches;
>
> Patch v2 branch: https://github.com/kuqin12/edk2/tree/node_14_v2
>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Leif Lindholm <leif@nuviainc.com>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
>
> Kun Qin (1):
>   Azurepipeline: SpellCheck: Enforce Node dependency to use version 14.x
>
> Sean Brogan (3):
>   StandaloneMmPkg: Core: Spelling error in comment
>   ArmPlatformPkg: SpellCheck: Switch spellcheck CI to AuditOnly
>   ArmPkg: SpellCheck: Update valid acronyms in ExtendedWords
>
>  StandaloneMmPkg/Core/Dispatcher.c                      |  2 +-
>  .azurepipelines/templates/spell-check-prereq-steps.yml |  2 +-
>  ArmPkg/ArmPkg.ci.yaml                                  | 19 +++++++++++++++++++
>  ArmPlatformPkg/ArmPlatformPkg.ci.yaml                  |  2 +-
>  4 files changed, 22 insertions(+), 3 deletions(-)
>