Add/tweak CMake, GitHub, and lefthook lint config

Author: hyperupcall

config/common.ts

@@ -23,6 +23,41 @@ export const octokit = new Octokit({ auth: process.env.GITHUB_AUTH_TOKEN })
 
 export const skipHyperupcallFunding = ['ecc-computing-club']
 
+export async function* fileMustHaveName(
+	mapping: Record<string, string[]>,
+): AsyncGenerator<Issue> {
+	for (let goodFile in mapping) {
+		const badFiles = mapping[goodFile]
+		if (goodFile.slice(0, 2) === './') {
+			goodFile = goodFile.slice(2)
+		}
+
+		for (let badFile of badFiles) {
+			if (badFile.slice(0, 2) === './') {
+				badFile = badFile.slice(2)
+			}
+
+			if (await fileExists(badFile)) {
+				const correctFileExists = await fileExists(goodFile)
+				if (correctFileExists) {
+					yield {
+						message: dedent`
+							-> Expected file "${badFile}" to not exist because "${goodFile}" already exists
+							-> But, found both files exist`,
+					}
+				} else {
+					yield {
+						message: dedent`
+							-> Expected file to be named "${goodFile}"
+							-> But, found file named "${badFile}"`,
+						fix: () => fs.rename(badFile, goodFile),
+					}
+				}
+			}
+		}
+	}
+}
+
 export async function* filesMustHaveContent(
 	mapping: Record<string, null | string>,
 ): AsyncGenerator<Issue> {

config/lint-rules/300-remote-url/40-github.ts

@@ -0,0 +1,31 @@
+import * as fs from 'node:fs/promises'
+import path from 'node:path'
+import { fileExists } from '#common'
+import { globby } from 'globby'
+import type { Issues } from '#types'
+
+export const issues: Issues = async function* issues() {
+	const workflowsDir = '.github/workflows'
+
+	if (!(await fileExists(workflowsDir))) {
+		return
+	}
+
+	const yamlFiles = await globby(['*.yml'], { cwd: workflowsDir })
+
+	if (yamlFiles.length > 0) {
+		yield {
+			message: [
+				`Expected GitHub workflow files to use ".yaml" extension`,
+				`But, found ${yamlFiles} file with ".yml" extension`,
+			],
+			fix: () =>
+				Promise.all(yamlFiles.map((file) =>
+					fs.rename(
+						path.join(workflowsDir, file),
+						path.join(workflowsDir, file).replace(/\.yml$/, '.yaml'),
+					)
+				)),
+		}
+	}
+}

config/lint-rules/400-ecosystem/_/lefthook.ts

@@ -1,22 +1,39 @@
 import type { Issues } from '#types'
-import { fileExists, filesMustHaveContent } from '#common'
+import { fileExists, fileMustHaveName, filesMustHaveContent } from '#common'
 import * as yaml from 'std/yaml'
 import { execa } from 'execa'
 
 export const issues: Issues = async function* issues() {
 	// Check that there is only one configuration file.
 	{
 		// https://lefthook.dev/configuration/index.html#config-file-name
+		yield* fileMustHaveName({
+			'.lefthook.yaml': [
+				'.lefthook.yml',
+				'lefthook.yaml',
+				'lefthook.yml',
+			],
+		})
+
 		yield* filesMustHaveContent({
-			'lefthook.yml': null,
-			'.lefthook.yml': null,
-			'lefthook.yaml': null,
-			'.lefthook.yaml': `assert_lefthook_installed: true`,
-			'lefthook.toml': null,
 			'.lefthook.toml': null,
-			'lefthook.json': null,
 			'.lefthook.json': null,
+			'lefthook.toml': null,
+			'lefthook.json': null,
 		})
+
+		if (!await fileExists('.lefthook.yaml')) {
+			yield {
+				message: [
+					`Expected to find a ".lefthook.yaml" file`,
+				],
+				fix: () =>
+					Deno.writeTextFile(
+						'.lefthook.yaml',
+						`assert_lefthook_installed: true\n`,
+					),
+			}
+		}
 	}
 
 	// Check that lefthook is activated for the current project.
@@ -26,17 +43,22 @@ export const issues: Issues = async function* issues() {
 				message: [
 					`Expected lefthook to be activated for current project`,
 				],
-				fix: async () => execa`lefthook install`,
+				fix: () => execa`lefthook install`,
 			}
 		}
 	}
 
+	type LefthookConfig = { assert_lefthook_installed: boolean }
 	// Check that specific values are set.
 	{
-		const lefthookConfig = yaml.parse(await Deno.readTextFile('.lefthook.yaml')) as Record<
-			PropertyKey,
-			unknown
-		>
+		const lefthookConfig = yaml.parse(await Deno.readTextFile('.lefthook.yaml'))
+		if (typeof lefthookConfig !== 'object' || lefthookConfig === null) {
+			yield {
+				message: [
+					`Expected ".lefthook.yaml" to contain an object`,
+				],
+			}
+		}
 		if (lefthookConfig.assert_lefthook_installed != true) {
 			yield {
 				message: [

config/lint-rules/400-ecosystem/c/cmake.ts

@@ -0,0 +1 @@
+export { issues } from '../cpp/cmake.ts'

config/lint-rules/400-ecosystem/cpp/cmake.ts

@@ -0,0 +1,49 @@
+import * as fs from 'node:fs/promises'
+import { fileExists } from '#common'
+import type { Issues } from '#types'
+
+export const issues: Issues = async function* issues() {
+	const CmakeListsText = 'CMakeLists.txt'
+
+	if (!(await fileExists(CmakeListsText))) {
+		return
+	}
+
+	const content = await fs.readFile(CmakeListsText, 'utf-8')
+
+	if (!/^[ \t]*cmake_minimum_required[ \t]*\([ \t]*VERSION[ \t]+/i.test(content)) {
+		yield {
+			message: [
+				`Expected file "${CmakeListsText}" to include cmake_minimum_required(VERSION ...)`,
+				'But, it could not be found',
+			],
+		}
+	}
+
+	if (!/^[ \t]*project[ \t]*\(/im.test(content)) {
+		yield {
+			message: [
+				`Expected file "${CmakeListsText}" to include project(...)`,
+				'But, it could not be found',
+			],
+		}
+	}
+
+	if (!/^[ \t]*set[ \t]*\([ \t]*CMAKE_EXPORT_COMPILE_COMMANDS[ \t]+ON[ \t]*\)/im.test(content)) {
+		yield {
+			message: [
+				`Expected file "${CmakeListsText}" to include set(CMAKE_EXPORT_COMPILE_COMMANDS ON)`,
+				'But, found no CMAKE_EXPORT_COMPILE_COMMANDS setting',
+			],
+		}
+	}
+
+	if (!/^[ \t]*set[ \t]*\([ \t]*CMAKE_COLOR_DIAGNOSTICS[ \t]+ON[ \t]*\)/im.test(content)) {
+		yield {
+			message: [
+				`Expected file "${CmakeListsText}" to include set(CMAKE_COLOR_DIAGNOSTICS ON)`,
+				'But, found no CMAKE_COLOR_DIAGNOSTICS setting',
+			],
+		}
+	}
+}