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.

Sign up for GitHub

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

Jump to bottom

Add cSpell to NUKE build pipeline #2086

Merged
merged 19 commits into from Jan 6, 2023
Merged

Add cSpell to NUKE build pipeline #2086

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
2a55fb4
Add `cSpell` to NUKE build pipeline
IT-VBFK Jan 4, 2023
d26fac8
Using bash for calling cspell
IT-VBFK Jan 4, 2023
8df996c
Update .github/workflows/spellcheck.yml
IT-VBFK Jan 4, 2023
f0f3e25
Update .github/workflows/spellcheck.yml
IT-VBFK Jan 4, 2023
8c7c869
Fix `Could not inject value for "Build.GitVersion"`
IT-VBFK Jan 4, 2023
4cd27ba
Migrate yaml node install to .NET
IT-VBFK Jan 5, 2023
d70b139
Remove dead code
IT-VBFK Jan 5, 2023
d4dc7b8
Install cSpell version which is defined in package.json
IT-VBFK Jan 5, 2023
1509a00
Shut up `yarn install`
IT-VBFK Jan 5, 2023
5439f38
Log errors as warnings and clean-ups
IT-VBFK Jan 5, 2023
c069f40
Remove unnecessary `ignoreWords` in spell check config file
IT-VBFK Jan 5, 2023
a3bd839
Add spell check before executing jekyll
IT-VBFK Jan 5, 2023
bb851fe
Add note to CONTRIBUTING.md about spell check
IT-VBFK Jan 5, 2023
3b24ec4
Simplify the error handling
IT-VBFK Jan 6, 2023
929b1d1
Tweak the cSpell multiline code blocks regex
IT-VBFK Jan 6, 2023
ebefed7
Set the cSpell.json version to 1
IT-VBFK Jan 6, 2023
ffc770f
Enable spell check for all .md files in the repo
IT-VBFK Jan 6, 2023
8439ac1
Add spell checking note also to the pull request template
IT-VBFK Jan 6, 2023
6f7438f
Simplify and deduplicate `Tool` declaration
IT-VBFK Jan 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 5 additions & 12 deletions Build/Build.cs
View file
Open in desktop
Expand Up @@ -49,8 +49,8 @@ class Build : NukeBuild
[PackageExecutable("nspec", "NSpecRunner.exe", Version = "3.1.0")]
Tool NSpec3;

[PathExecutable("cspell")]
Tool CSpell;
[PathExecutable("bash")]
Tool Bash;

AbsolutePath ArtifactsDirectory => RootDirectory / "Artifacts";

Expand Down Expand Up @@ -252,27 +252,20 @@ class Build : NukeBuild
});

Target Spellcheck => _ => _
.OnlyWhenDynamic(() => !IsLocalBuild)
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
.Executes(() =>
{
InstallCSpell();

var cSpellFile = RootDirectory / "cSpell.json";
var docsDirectory = RootDirectory / "docs";
CSpell($"--config {cSpellFile} \"{docsDirectory}/**/*.md\" --no-progress");
Bash($"-c \"cspell --config {cSpellFile} '{docsDirectory}/**/*.md' --no-progress\"");
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
});

private void InstallCSpell()
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
{
var output = CSpell("--help");

if (IsCSpellInstalled(output))
{
Npm("install -g cspell");
}
Npm("install -g cspell");
}

private bool IsCSpellInstalled(IReadOnlyCollection<Output> output) =>
!output.Any(o => o.Text == "Usage: cspell [options] [command]");

bool IsTag => BranchSpec != null && BranchSpec.Contains("refs/tags", StringComparison.InvariantCultureIgnoreCase);
}