Cake.Frosting.Issues.Markdownlint
4.9.0
See the version list below for details.
dotnet add package Cake.Frosting.Issues.Markdownlint --version 4.9.0
NuGet\Install-Package Cake.Frosting.Issues.Markdownlint -Version 4.9.0
<PackageReference Include="Cake.Frosting.Issues.Markdownlint" Version="4.9.0" />
paket add Cake.Frosting.Issues.Markdownlint --version 4.9.0
#r "nuget: Cake.Frosting.Issues.Markdownlint, 4.9.0"
#addin nuget:?package=Cake.Frosting.Issues.Markdownlint&version=4.9.0
Markdownlint support for the Cake.Issues addin for Cake Frosting
NOTE: This is the version of the addin compatible with Cake Frosting. For addin compatible with Cake .NET Tool see Cake.Issues.Markdownlint.
The Markdownlint support for the Cake.Issues addin for Cake allows you to read issues logged by Markdownlint.
Cake.Issues redefines issue management within the Cake build system by offering a comprehensive, universal, and extensible solution. The unique capabilities of the addins empower development teams to enforce coding standards, generate insightful reports, seamlessly incorporate various linting tools, and streamlining the integration with pull requests. With its modular architecture and extensive set of aliases, Cake.Issues provides a future-proof infrastructure for issue management in Cake builds, fostering a more efficient and adaptable development process.
For more information and extensive documentation see the Cake.Issues website. For general information about the Cake build automation system see the Cake website.
How to use
Integrating Cake.Issues into your Cake build is straightforward. With minimal setup, teams can enjoy the benefits of enhanced code quality management seamlessly integrated into their existing build pipeline.
After adding the addin the log file of a Markdownlint run can be parsed:
[TaskName("Lint-Documentation")]
public sealed class LintDocumentationTask : FrostingTask<BuildContext>
{
public override void Run(BuildContext context)
{
var logPath = @"c:\build\markdownlint.log";
var repoRootPath = @"c:\repo";
// Run markdownlint-cli using Cake.Markdownlint addin.
var settings =
MarkdownlintNodeJsRunnerSettings.ForDirectory(repoRootPath.Combine("docs"));
settings.OutputFile = logPath;
settings.ThrowOnIssue = false;
context.RunMarkdownlintNodeJs(settings);
// Read issues.
var issues =
context.ReadIssues(
context.MarkdownlintIssuesFromFilePath(
logPath,
MarkdownlintCliLogFileFormat),
repoRootPath);
context.Information("{0} issues are found.", issues.Count());
}
}
Support & Discussion
For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.
Contributing
Contributions are welcome. See Contribution Guidelines.
License
MIT License - Copyright © Cake Issues contributors
Binary distributions for some addins contain third-party code which is licensed under its own respective license. See LICENSE for details.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Cake.Core (>= 4.0.0)
- Cake.Issues (>= 4.0.0-beta0001 && < 5.0.0)
-
net7.0
- Cake.Core (>= 4.0.0)
- Cake.Issues (>= 4.0.0-beta0001 && < 5.0.0)
-
net8.0
- Cake.Core (>= 4.0.0)
- Cake.Issues (>= 4.0.0-beta0001 && < 5.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Cake.Frosting.Issues.Markdownlint:
Package | Downloads |
---|---|
Cake.Frosting.Issues.Recipe
Cake.Frosting.Issues.Recipe provides a build script which can be used inside your projects Cake Frosting build to add issue management. See the Project Site for documentation and an overview of the whole ecosystem of addins for working with issues in Cake builds. NOTE: This is the version of the recipe compatible with Cake Frosting. For recipe compatible with Cake Script Runners see Cake.Issues.Recipe. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
4.10.1 | 7,142 | 8/20/2024 |
4.10.0 | 7,085 | 7/30/2024 |
4.9.0 | 1,098 | 7/25/2024 |
4.8.1 | 2,637 | 7/19/2024 |
4.8.0 | 398 | 7/19/2024 |
4.7.2 | 394 | 7/18/2024 |
4.7.1 | 909 | 7/17/2024 |
4.7.0 | 550 | 7/16/2024 |
4.6.0 | 9,186 | 6/24/2024 |
4.5.1 | 12,818 | 5/24/2024 |
4.5.0 | 711 | 5/23/2024 |
4.4.0 | 3,734 | 5/18/2024 |
4.3.1 | 9,430 | 4/25/2024 |
4.3.0 | 3,006 | 4/20/2024 |
4.2.1 | 1,678 | 4/16/2024 |
4.2.0 | 1,855 | 4/14/2024 |