Simplify syntax for exclusion of globs/files in markdownlint-test-repos.js.

This commit is contained in:
David Anson 2021-10-23 22:24:47 -07:00
parent 39724b991a
commit 956b55b55e

View file

@ -67,16 +67,24 @@ function lintTestRepo(t, globPatterns, configPath) {
}); });
} }
/**
* Excludes a list of globs.
*
* @param {string} rootDir Root directory for globs.
* @param {...string} globs Globs to exclude.
* @returns {string[]} Array of excluded globs.
*/
function excludeGlobs(rootDir, ...globs) {
return globs.map((glob) => "!" + join(rootDir, glob));
}
// Run markdownlint the same way the corresponding repositories do // Run markdownlint the same way the corresponding repositories do
test("https://github.com/eslint/eslint", (t) => { test("https://github.com/eslint/eslint", (t) => {
const rootDir = "./test-repos/eslint-eslint"; const rootDir = "./test-repos/eslint-eslint";
const globPatterns = [ const globPatterns = [
join(rootDir, "docs/**/*.md"), join(rootDir, "docs/**/*.md"),
"!" + join( ...excludeGlobs(rootDir, "docs/rules/array-callback-return.md")
rootDir,
"docs/rules/array-callback-return.md"
)
]; ];
const configPath = join(rootDir, ".markdownlint.yml"); const configPath = join(rootDir, ".markdownlint.yml");
return lintTestRepo(t, globPatterns, configPath); return lintTestRepo(t, globPatterns, configPath);
@ -88,7 +96,7 @@ test("https://github.com/mkdocs/mkdocs", (t) => {
join(rootDir, "README.md"), join(rootDir, "README.md"),
join(rootDir, "CONTRIBUTING.md"), join(rootDir, "CONTRIBUTING.md"),
join(rootDir, "docs/**/*.md"), join(rootDir, "docs/**/*.md"),
"!" + join(rootDir, "docs/CNAME") ...excludeGlobs(rootDir, "docs/CNAME")
]; ];
const configPath = join(rootDir, ".markdownlintrc"); const configPath = join(rootDir, ".markdownlintrc");
return lintTestRepo(t, globPatterns, configPath); return lintTestRepo(t, globPatterns, configPath);
@ -112,9 +120,11 @@ test("https://github.com/pi-hole/docs", (t) => {
const rootDir = "./test-repos/pi-hole-docs"; const rootDir = "./test-repos/pi-hole-docs";
const globPatterns = [ const globPatterns = [
join(rootDir, "**/*.md"), join(rootDir, "**/*.md"),
"!" + join(rootDir, "docs/guides/dns/unbound.md"), ...excludeGlobs(rootDir,
"!" + join(rootDir, "docs/index.md"), "docs/guides/dns/unbound.md",
"!" + join(rootDir, "docs/main/prerequisites.md") "docs/index.md",
"docs/main/prerequisites.md"
)
]; ];
const configPath = join(rootDir, ".markdownlint.json"); const configPath = join(rootDir, ".markdownlint.json");
return lintTestRepo(t, globPatterns, configPath); return lintTestRepo(t, globPatterns, configPath);
@ -124,7 +134,7 @@ test("https://github.com/webhintio/hint", (t) => {
const rootDir = "./test-repos/webhintio-hint"; const rootDir = "./test-repos/webhintio-hint";
const globPatterns = [ const globPatterns = [
join(rootDir, "**/*.md"), join(rootDir, "**/*.md"),
"!" + join(rootDir, "**/CHANGELOG.md") ...excludeGlobs(rootDir, "**/CHANGELOG.md")
]; ];
const configPath = join(rootDir, ".markdownlintrc"); const configPath = join(rootDir, ".markdownlintrc");
return lintTestRepo(t, globPatterns, configPath); return lintTestRepo(t, globPatterns, configPath);
@ -145,202 +155,73 @@ if (existsSync(dotnetDocsDir)) {
const rootDir = dotnetDocsDir; const rootDir = dotnetDocsDir;
const globPatterns = [ const globPatterns = [
join(rootDir, "**/*.md"), join(rootDir, "**/*.md"),
"!" + join(rootDir, "samples/**/*.md"), ...excludeGlobs(rootDir,
"!" + join(rootDir, "docs/architecture/cloud-native/candidate-apps.md"), "samples/**/*.md",
"!" + join( /* eslint-disable max-len */
rootDir, "docs/architecture/cloud-native/candidate-apps.md",
"docs/architecture/containerized-lifecycle/docker-devops-workflow" + "docs/architecture/containerized-lifecycle/docker-devops-workflow/docker-application-outer-loop-devops-workflow.md",
"/docker-application-outer-loop-devops-workflow.md" "docs/architecture/dapr-for-net-developers/getting-started.md",
), "docs/architecture/grpc-for-wcf-developers/channel-credentials.md",
"!" + join( "docs/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests.md",
rootDir, "docs/architecture/microservices/multi-container-microservice-net-applications/implement-api-gateways-with-ocelot.md",
"docs/architecture/dapr-for-net-developers/getting-started.md" "docs/architecture/modern-web-apps-azure/architectural-principles.md",
), "docs/architecture/modern-web-apps-azure/azure-hosting-recommendations-for-asp-net-web-apps.md",
"!" + join( "docs/architecture/modern-web-apps-azure/common-client-side-web-technologies.md",
rootDir, "docs/architecture/modern-web-apps-azure/develop-asp-net-core-mvc-apps.md",
"docs/architecture/grpc-for-wcf-developers/channel-credentials.md" "docs/architecture/modern-web-apps-azure/development-process-for-azure.md",
), "docs/architecture/modern-web-apps-azure/index.md",
"!" + join( "docs/core/additional-tools/dotnet-svcutil-guide.md",
rootDir, "docs/core/dependency-loading/collect-details.md",
"docs/architecture/microservices/implement-resilient-applications" + "docs/core/deploying/single-file.md",
"/use-httpclientfactory-to-implement-resilient-http-requests.md" "docs/core/deploying/trimming/trimming-options.md",
), "docs/core/extensions/cloud-service.md",
"!" + join( "docs/core/extensions/console-log-formatter.md",
rootDir, "docs/core/extensions/create-resource-files.md",
"docs/architecture/microservices" + "docs/core/extensions/localization.md",
"/multi-container-microservice-net-applications" + "docs/core/install/linux-alpine.md",
"/implement-api-gateways-with-ocelot.md" "docs/core/install/windows.md",
), "docs/core/porting/third-party-deps.md",
"!" + join( "docs/core/project-sdk/msbuild-props-desktop.md",
rootDir, "docs/core/testing/unit-testing-code-coverage.md",
"docs/architecture/modern-web-apps-azure/architectural-principles.md" "docs/core/tools/troubleshoot-usage-issues.md",
), "docs/core/tutorials/cli-templates-create-item-template.md",
"!" + join( "docs/core/tutorials/cli-templates-create-project-template.md",
rootDir, "docs/core/tutorials/cli-templates-create-template-pack.md",
"docs/architecture/modern-web-apps-azure" + "docs/core/tutorials/cli-templates-create-item-template.md",
"/azure-hosting-recommendations-for-asp-net-web-apps.md" "docs/core/tutorials/cli-templates-create-project-template.md",
), "docs/core/tutorials/cli-templates-create-template-pack.md",
"!" + join( "docs/core/whats-new/dotnet-core-3-0.md",
rootDir, "docs/csharp/language-reference/compiler-options/code-generation.md",
"docs/architecture/modern-web-apps-azure" + "docs/csharp/linq/query-expression-basics.md",
"/common-client-side-web-technologies.md" "docs/csharp/programming-guide/classes-and-structs/named-and-optional-arguments.md",
), "docs/csharp/roslyn-sdk/tutorials/how-to-write-csharp-analyzer-code-fix.md",
"!" + join( "docs/csharp/tutorials/attributes.md",
rootDir, "docs/csharp/whats-new/csharp-version-history.md",
"docs/architecture/modern-web-apps-azure" + "docs/framework/data/adonet/dataset-datatable-dataview/security-guidance.md",
"/develop-asp-net-core-mvc-apps.md" "docs/fsharp/language-reference/compiler-directives.md",
), "docs/fsharp/language-reference/exception-handling/the-try-with-expression.md",
"!" + join( "docs/fsharp/language-reference/xml-documentation.md",
rootDir, "docs/fsharp/style-guide/conventions.md",
"docs/architecture/modern-web-apps-azure" + "docs/fsharp/tutorials/asynchronous-and-concurrent-programming/async.md",
"/development-process-for-azure.md" "docs/fundamentals/code-analysis/configuration-files.md",
), "docs/fundamentals/code-analysis/style-rules/naming-rules.md",
"!" + join(rootDir, "docs/architecture/modern-web-apps-azure/index.md"), "docs/machine-learning/tutorials/health-violation-classification-model-builder.md",
"!" + join(rootDir, "docs/core/additional-tools/dotnet-svcutil-guide.md"), "docs/machine-learning/tutorials/object-detection-model-builder.md",
"!" + join(rootDir, "docs/core/dependency-loading/collect-details.md"), "docs/machine-learning/tutorials/object-detection-onnx.md",
"!" + join(rootDir, "docs/core/deploying/single-file.md"), "docs/machine-learning/tutorials/text-classification-tf.md",
"!" + join(rootDir, "docs/core/deploying/trimming/trimming-options.md"), "docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview.md",
"!" + join(rootDir, "docs/core/extensions/cloud-service.md"), "docs/standard/asynchronous-programming-patterns/implementing-the-event-based-asynchronous-pattern.md",
"!" + join(rootDir, "docs/core/extensions/console-log-formatter.md"), "docs/standard/base-types/string-comparison-net-5-plus.md",
"!" + join(rootDir, "docs/core/extensions/create-resource-files.md"), "docs/standard/delegates-lambdas.md",
"!" + join(rootDir, "docs/core/extensions/localization.md"), "docs/standard/io/isolated-storage.md",
"!" + join(rootDir, "docs/core/install/linux-alpine.md"), "docs/standard/native-interop/tutorial-comwrappers.md",
"!" + join(rootDir, "docs/core/install/windows.md"), "docs/standard/serialization/xml-schema-definition-tool-xsd-exe.md",
"!" + join(rootDir, "docs/core/porting/third-party-deps.md"), "docs/standard/serialization/xml-serializer-generator-tool-sgen-exe.md",
"!" + join(rootDir, "docs/core/project-sdk/msbuild-props-desktop.md"), "docs/standard/native-interop/best-practices.md",
"!" + join(rootDir, "docs/core/testing/unit-testing-code-coverage.md"), "docs/standard/serialization/binaryformatter-security-guide.md",
"!" + join(rootDir, "docs/core/tools/troubleshoot-usage-issues.md"), "docs/framework/windows-workflow-foundation/authoring-workflows-activities-and-expressions-using-imperative-code.md",
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-item-template.md"
),
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-project-template.md"
),
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-template-pack.md"
),
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-item-template.md"
),
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-project-template.md"
),
"!" + join(
rootDir,
"docs/core/tutorials/cli-templates-create-template-pack.md"
),
"!" + join(rootDir, "docs/core/whats-new/dotnet-core-3-0.md"),
"!" + join(
rootDir,
"docs/csharp/language-reference/compiler-options/code-generation.md"
),
"!" + join(rootDir, "docs/csharp/linq/query-expression-basics.md"),
"!" + join(
rootDir,
"docs/csharp/programming-guide/classes-and-structs" +
"/named-and-optional-arguments.md"
),
"!" + join(
rootDir,
"docs/csharp/roslyn-sdk/tutorials" +
"/how-to-write-csharp-analyzer-code-fix.md"
),
"!" + join(rootDir, "docs/csharp/tutorials/attributes.md"),
"!" + join(rootDir, "docs/csharp/whats-new/csharp-version-history.md"),
"!" + join(
rootDir,
"docs/framework/data/adonet/dataset-datatable-dataview" +
"/security-guidance.md"
),
"!" + join(
rootDir,
"docs/fsharp/language-reference/compiler-directives.md"
),
"!" + join(
rootDir,
"docs/fsharp/language-reference/exception-handling" +
"/the-try-with-expression.md"
),
"!" + join(
rootDir,
"docs/fsharp/language-reference/xml-documentation.md"
),
"!" + join(rootDir, "docs/fsharp/style-guide/conventions.md"),
"!" + join(
rootDir,
"docs/fsharp/tutorials/asynchronous-and-concurrent-programming/async.md"
),
"!" + join(
rootDir,
"docs/fundamentals/code-analysis/configuration-files.md"
),
"!" + join(
rootDir,
"docs/fundamentals/code-analysis/style-rules/naming-rules.md"
),
"!" + join(
rootDir,
"docs/machine-learning/tutorials" +
"/health-violation-classification-model-builder.md"
),
"!" + join(
rootDir,
"docs/machine-learning/tutorials/object-detection-model-builder.md"
),
"!" + join(
rootDir,
"docs/machine-learning/tutorials/object-detection-onnx.md"
),
"!" + join(
rootDir,
"docs/machine-learning/tutorials/text-classification-tf.md"
),
"!" + join(
rootDir,
"docs/standard/asynchronous-programming-patterns" +
"/event-based-asynchronous-pattern-overview.md"
),
"!" + join(
rootDir,
"docs/standard/asynchronous-programming-patterns" +
"/implementing-the-event-based-asynchronous-pattern.md"
),
"!" + join(
rootDir,
"docs/standard/base-types/string-comparison-net-5-plus.md"
),
"!" + join(rootDir, "docs/standard/delegates-lambdas.md"),
"!" + join(rootDir, "docs/standard/io/isolated-storage.md"),
"!" + join(
rootDir,
"docs/standard/native-interop/tutorial-comwrappers.md"
),
"!" + join(
rootDir,
"docs/standard/serialization/xml-schema-definition-tool-xsd-exe.md"
),
"!" + join(
rootDir,
"docs/standard/serialization/xml-serializer-generator-tool-sgen-exe.md"
),
"!" + join(rootDir, "docs/standard/native-interop/best-practices.md"),
"!" + join(
rootDir,
"docs/standard/serialization/binaryformatter-security-guide.md"
),
"!" + join(
rootDir,
"docs/framework/windows-workflow-foundation/authoring-workflows-" +
"activities-and-expressions-using-imperative-code.md"
),
"!" + join(
rootDir,
"docs/spark/how-to-guides/deploy-worker-udf-binaries.md" "docs/spark/how-to-guides/deploy-worker-udf-binaries.md"
/* eslint-enable max-len */
) )
]; ];
const configPath = join(rootDir, ".markdownlint.json"); const configPath = join(rootDir, ".markdownlint.json");
@ -354,18 +235,20 @@ if (existsSync(v8v8DevDir)) {
const rootDir = v8v8DevDir; const rootDir = v8v8DevDir;
const globPatterns = [ const globPatterns = [
join(rootDir, "src/**/*.md"), join(rootDir, "src/**/*.md"),
"!" + join(rootDir, "src/blog/array-sort.md"), ...excludeGlobs(rootDir,
"!" + join(rootDir, "src/blog/code-caching-for-devs.md"), "src/blog/array-sort.md",
"!" + join(rootDir, "src/blog/fast-async.md"), "src/blog/code-caching-for-devs.md",
"!" + join(rootDir, "src/blog/liftoff.md"), "src/blog/fast-async.md",
"!" + join(rootDir, "src/blog/pointer-compression.md"), "src/blog/liftoff.md",
"!" + join(rootDir, "src/blog/react-cliff.md"), "src/blog/pointer-compression.md",
"!" + join(rootDir, "src/blog/slack-tracking.md"), "src/blog/react-cliff.md",
"!" + join(rootDir, "src/blog/v8-release-74.md"), "src/blog/slack-tracking.md",
"!" + join(rootDir, "src/features/bigint.md"), "src/blog/v8-release-74.md",
"!" + join(rootDir, "src/features/dynamic-import.md"), "src/features/bigint.md",
"!" + join(rootDir, "src/features/globalthis.md"), "src/features/dynamic-import.md",
"!" + join(rootDir, "src/features/modules.md") "src/features/globalthis.md",
"src/features/modules.md"
)
]; ];
const configPath = join(rootDir, ".markdownlint.json"); const configPath = join(rootDir, ".markdownlint.json");
return lintTestRepo(t, globPatterns, configPath); return lintTestRepo(t, globPatterns, configPath);