miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(nx-dev): update workspace conformance rule to check md files in general

Browse Source
This commit is contained in:
Juri 2025-02-24 21:12:28 +01:00 committed by Juri Strumpflohner
parent c698b1ef9c
commit d428eec060
2 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nx.json
View File

@ -253,7 +253,7 @@
"rule": "@nx/workspace-plugin/conformance-rules/blog-description", "rule": "@nx/workspace-plugin/conformance-rules/blog-description",
"projects": ["docs"], "projects": ["docs"],
"options": { "options": {
"mdGlobPattern": "blog/**/*.md" "mdGlobPattern": "{blog,shared}/**/*.md"
} }
}, },
{ {

16
tools/workspace-plugin/src/conformance-rules/blog-description/index.ts
View File

@ -12,7 +12,7 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
name: 'blog-description', name: 'blog-description',
category: 'consistency', category: 'consistency',
description: description:
'Ensures that blog posts have a description in their frontmatter', 'Ensures that markdown documentation files have a description in their frontmatter',
reporter: 'project-files-reporter', reporter: 'project-files-reporter',
implementation: async ({ projectGraph, ruleOptions }) => { implementation: async ({ projectGraph, ruleOptions }) => {
const violations: ProjectFilesViolation[] = []; const violations: ProjectFilesViolation[] = [];
@ -43,8 +43,15 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
const content = readFileSync(file, 'utf-8'); const content = readFileSync(file, 'utf-8');
const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/); const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
// Only check files with frontmatter if (!frontmatterMatch) {
if (frontmatterMatch) { violations.push({
message: 'Markdown documentation files must have frontmatter',
sourceProject: docsProject.name,
file: file,
});
continue;
}
try { try {
const frontmatter = yamlLoad(frontmatterMatch[1]) as Record< const frontmatter = yamlLoad(frontmatterMatch[1]) as Record<
string, string,
@ -54,7 +61,7 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
if (!frontmatter.description) { if (!frontmatter.description) {
violations.push({ violations.push({
message: message:
'Blog posts with frontmatter must have a description field', 'Markdown documentation files must have a description field in their frontmatter',
sourceProject: docsProject.name, sourceProject: docsProject.name,
file: file, file: file,
}); });
@ -64,7 +71,6 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
continue; continue;
} }
} }
}
return { return {
severity: 'high', severity: 'high',