Add cSpell to NUKE build pipeline

[IT-VBFK]

This ref. and finishes #2017

IMPORTANT

• If the PR touches the public API, the changes have been approved in a separate issue with the "api-approved" label.
• The code complies with the Coding Guidelines for C#.
• The changes are covered by unit tests which follow the Arrange-Act-Assert syntax and the naming conventions such as is used in these tests.
• If the PR adds a feature or fixes a bug, please update the release notes with a functional description that explains what the change means to consumers of this library, which are published on the website.
• If the PR changes the public API the changes needs to be included by running AcceptApiChanges.ps1 or AcceptApiChanges.sh.
• If the PR affects the documentation, please include your changes in this pull request so the documentation will appear on the website.
  • Please also run ./build.sh --target spellcheck or .\build.ps1 --target spellcheck before pushing and check the good outcome

[coveralls]

Pull Request Test Coverage Report for Build 3856028965

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 95.984%

---

Totals
Change from base Build 3853478629:	0.0%
Covered Lines:	8525
Relevant Lines:	8768

---

💛 - Coveralls

[IT-VBFK]

So.. now I cannot imagine how to move more steps to .NET 😆

[dennisdoomen]

Nice!

[jnyrup]

I had a play with this, and here's my best attempt

Node($"{YarnCli} install --silent", workingDirectory: RootDirectory);
Node($"{YarnCli} --silent run cspell --no-summary", workingDirectory: RootDirectory,
    customLogger: (_, msg) => Error(msg));

Without spelling errors

With spelling errors

[IT-VBFK]

That looks great.. Just changed it :)

Edit: Tried to make some mistakes.. I cannot get the target to fail? Why?

I changed Sometimes to Somtimes and Sometmies in docs/_pages/basicassertions.md

Edit2: This was an error in the code blocks regex pattern. Fixed that (and several spelling issues too) :D

[dennisdoomen]

I had a play with this, and here's my best attempt

What was the important trick? The --silent --no-summary?

[jnyrup]

I had a play with this, and here's my best attempt

What was the important trick? The --silent --no-summary?

At a second look, only the --no-summary is necessary as it prevents cspell from always printing a summary to stderr.
(This is what happens when messing with technologies without knowing them 🤷 )

So this seems sufficient:

Node($"{YarnCli} install --silent", workingDirectory: RootDirectory);
Node($"{YarnCli} run cspell --no-summary", workingDirectory: RootDirectory);

[IT-VBFK]

But now you cannot see the misspelled words in the summary

[IT-VBFK]

Sorry for the bad commit messages I am on my mobile device right now 🫣

[jnyrup]

Third attempt...
Here are screenshots of what happens with each extra argument.
I guess(?) the third snippet here produces the most desired output.

Node($"{YarnCli} run cspell --no-summary", workingDirectory: RootDirectory);

Node($"{YarnCli} run cspell --no-summary", workingDirectory: RootDirectory,
    customLogger: (_, msg) => Error(msg));

Node($"{YarnCli} --silent run cspell --no-summary", workingDirectory: RootDirectory,
    customLogger: (_, msg) => Error(msg));

[IT-VBFK]

I have meant this:

I think this is the simplest solution (3)

[IT-VBFK]

I think wrapping only the attribute into preprocessor directives reads less noisy..

What do you think @jnyrup @dennisdoomen ?

[IT-VBFK]

@jnyrup or @dennisdoomen Do you mind re-running the pipeline on develop?

Thanks

[jnyrup]

I'm re-running now

[IT-VBFK]

Thanks.. this little red X driving me nuts :D

[SeanKilleen]

Hey, I was going through old PRs etc. and I just wanted to say, I love that you followed through on this, @IT-VBFK! I got to read it and learn more about Nuke and how you accomplished it. Thanks!