Feature - Automated pull request checks

.github/actions/pull-requests/check-committed-files/.gitignore

@@ -0,0 +1,7 @@
+# ---------------------------------------------------------------------------- #
+#                                     NODE                                     #
+# ---------------------------------------------------------------------------- #
+
+# ------------------------------- Dependencies ------------------------------- #
+
+node_modules/

.github/actions/pull-requests/check-committed-files/action.yml

@@ -0,0 +1,16 @@
+author: 'hozlucas28'
+
+name: 'Check committed files'
+description: 'Check if committed files of a pull request are valid'
+
+runs:
+  using: 'node20'
+  main: 'dist/index.js'
+
+inputs:
+  author:
+    description: 'Name of the user who created the pull request'
+    required: true
+  committed-files:
+    description: 'Committed files of the pull request'
+    required: true

.github/actions/pull-requests/check-committed-files/dist/licenses.txt

@@ -0,0 +1,120 @@
+@actions/core
+MIT
+The MIT License (MIT)
+
+Copyright 2019 GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+@actions/http-client
+MIT
+Actions Http Client for Node.js
+
+Copyright (c) GitHub, Inc.
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+@fastify/busboy
+MIT
+Copyright Brian White. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+tunnel
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2012 Koichi Kobayashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+undici
+MIT
+MIT License
+
+Copyright (c) Matteo Collina and Undici contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.github/actions/pull-requests/check-committed-files/dist/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

.github/actions/pull-requests/check-committed-files/main.js

@@ -0,0 +1,80 @@
+import { debug, getInput, setFailed } from '@actions/core'
+import path from 'node:path'
+import {
+	arraytoString,
+	getProgrammingLanguageExtension,
+	getProgrammingLanguageFolderName,
+	getProgrammingLanguageFolderNames,
+} from '../../utils.mjs'
+
+// Inputs
+const author = getInput('author')
+const committedFiles = getInput('committed-files').split('\\n')
+debug(`'author' (input): ${author}`)
+debug(`'committed-files' (input): ${committedFiles}`)
+
+// Required data
+const authorLowerCase = author.toLowerCase()
+const programmingLanguageFolders = getProgrammingLanguageFolderNames()
+debug(`Author name (lowercase): ${authorLowerCase}`)
+debug(`Programming language folder names: ${programmingLanguageFolders}`)
+
+// Check each commited file
+for (const committedFile of committedFiles) {
+	const parsedFile = path.parse(committedFile)
+	debug(`Committed file properties: ${parsedFile}`)
+
+	// Check file name
+	const isValidFileName = parsedFile.name.toLowerCase() === authorLowerCase
+	debug(`Is valid file name? ${isValidFileName}`)
+
+	if (!isValidFileName) {
+		setFailed(
+			`The file name: '${parsedFile.base}', inside '${parsedFile.dir}' directory doesn't match with the author name of the pull request. ` +
+				'Please rename the file name. ' +
+				`It should be: '${author}', case insensitive. ` +
+				'If you think this is an error, please contact an administrator.'
+		)
+	}
+
+	// Check programming language folder
+	const programmingLanguageFolder = parsedFile.dir.split(path.sep).pop() // Get the last folder, in this case the programming language name.
+	debug(`Last folder of the commited file: ${programmingLanguageFolder}`)
+
+	if (!programmingLanguageFolder) {
+		throw new Error(
+			`The programming language folder of '${parsedFile.base}' (committed file) inside '${parsedFile.dir}' is undefined!`
+		)
+	}
+
+	if (!programmingLanguageFolders.includes(programmingLanguageFolder)) {
+		setFailed(
+			`The programming language folder '${programmingLanguageFolder}', where '${parsedFile.base}' (committed file) is located doesn't match with an existing one. ` +
+				`It should be on of these: ${arraytoString({
+					array: programmingLanguageFolders,
+					finalSeparator: ', or ',
+					separator: ', ',
+				})}. ` +
+				'If you think this is an error, please contact an administrator.'
+		)
+	}
+
+	// Check file extension
+	const expectedFileExtBasedOnLastFolder = getProgrammingLanguageExtension(programmingLanguageFolder)
+	const isValidFileExtension = parsedFile.ext === expectedFileExtBasedOnLastFolder
+	debug(`Expected file extension based on the last folder of the commited file: ${expectedFileExtBasedOnLastFolder}`)
+	debug(`Is valid file extension? ${isValidFileExtension}`)
+
+	if (!isValidFileExtension) {
+		const expectedLastFolderBasedOnCommittedFileExt = getProgrammingLanguageFolderName(parsedFile.ext)
+		debug(`Expected last folder based on the extension of the commited file: ${expectedLastFolderBasedOnCommittedFileExt}`)
+
+		setFailed(
+			`The file extension of '${parsedFile.base}' file, inside '${parsedFile.dir}' directory doesn't match with the programming language folder. ` +
+				'Check the file extension or the programming language folder where it is located. ' +
+				`The file extension should be: '${expectedFileExtBasedOnLastFolder}', ` +
+				`or the programming language folder where it is located should be: '${expectedLastFolderBasedOnCommittedFileExt}'. ` +
+				'If you think this is an error, please contact an administrator.'
+		)
+	}
+}

.github/actions/pull-requests/check-committed-files/package.json

@@ -0,0 +1,19 @@
+{
+	"author": "hozlucas28",
+	"dependencies": {
+		"@actions/core": "1.10.1"
+	},
+	"description": "GitHub Action to check committed files of a pull request",
+	"devDependencies": {
+		"@vercel/ncc": "^0.38.1"
+	},
+	"keywords": [],
+	"license": "MIT",
+	"main": "dist/index.js",
+	"name": "check-committed-files",
+	"scripts": {
+		"build": "ncc build main.js --minify --target es2022 --license licenses.txt"
+	},
+	"type": "module",
+	"version": "1.0.0"
+}