💡 docs-code(repo_management_files/extractfilescopes.js): renamed and documented extracfilescopes.js

rename functions and edited the document blocks to reflect the changes

Author: jebarpg

Diff for: package.json

@@ -146,63 +146,63 @@
         "package.json",
         "release.config.ts",
         "renovate.json",
-        "typedoc.json",
         "tsconfig.json",
-        "public/.gitkeep",
+        "typedoc.json",
         ".vscode/settings.json",
+        "public/.gitkeep",
         "repo_management_files/cz-emoji-type-extract.js",
         "repo_management_files/cz-type-extract.js",
         "repo_management_files/directorystructuredocument.md",
         "repo_management_files/extractfilescopes.js",
         "repo_management_files/genericcommitmessages.md",
         "repo_management_files/gitmojisemver-extract.js",
         "repo_management_files/issues.sh",
-        "repo_management_files/packagejsondocument.md",
         "repo_management_files/labels.sh",
-        ".github/dependabot.yml",
-        ".github/workflows/build.yml",
-        ".github/workflows/lint.yml",
-        ".github/workflows/docs.yml",
-        ".github/workflows/pr.yml",
-        ".github/workflows/test.yml",
-        ".github/workflows/release.yml",
+        "repo_management_files/packagejsondocument.md",
         ".husky/commit-msg",
         ".husky/prepare-commit-msg",
         ".husky/_/.gitignore",
         ".husky/_/applypatch-msg",
-        ".husky/_/h",
         ".husky/_/commit-msg",
-        ".husky/_/post-checkout",
         ".husky/_/post-applypatch",
+        ".husky/_/post-checkout",
         ".husky/_/post-commit",
+        ".husky/_/h",
         ".husky/_/post-rewrite",
         ".husky/_/pre-applypatch",
         ".husky/_/pre-auto-gc",
+        ".husky/_/post-merge",
         ".husky/_/pre-commit",
         ".husky/_/pre-rebase",
-        ".husky/_/pre-push",
         ".husky/_/prepare-commit-msg",
-        ".husky/_/post-merge",
+        ".husky/_/pre-push",
+        ".github/dependabot.yml",
+        ".github/workflows/build.yml",
+        ".github/workflows/docs.yml",
+        ".github/workflows/pr.yml",
+        ".github/workflows/lint.yml",
+        ".github/workflows/release.yml",
+        ".github/workflows/test.yml",
+        "src/app.ts",
+        "src/bin/.gitkeep",
+        "src/controllers/.gitkeep",
+        "src/middleware/.gitkeep",
+        "src/configs/.gitkeep",
+        "src/models/.gitkeep",
+        "src/plugins/.gitkeep",
+        "src/routes/.gitkeep",
+        "src/utils/.gitkeep",
+        "src/views/.gitkeep",
         "test/.gitkeep",
         "test/bin/.gitkeep",
         "test/configs/.gitkeep",
         "test/controllers/.gitkeep",
         "test/plugins/.gitkeep",
-        "test/views/.gitkeep",
-        "test/utils/.gitkeep",
         "test/models/.gitkeep",
+        "test/views/.gitkeep",
         "test/routes/.gitkeep",
         "test/middleware/.gitkeep",
-        "src/app.ts",
-        "src/controllers/.gitkeep",
-        "src/bin/.gitkeep",
-        "src/configs/.gitkeep",
-        "src/middleware/.gitkeep",
-        "src/models/.gitkeep",
-        "src/utils/.gitkeep",
-        "src/routes/.gitkeep",
-        "src/views/.gitkeep",
-        "src/plugins/.gitkeep"
+        "test/utils/.gitkeep"
       ],
       "questions": {
         "scope": "Specify a scope: "
@@ -271,4 +271,4 @@
       }
     }
   }
-}
+}

Diff for: repo_management_files/extractFileScopes.js

@@ -6,6 +6,8 @@ import { fileURLToPath } from 'url';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+// TODO First extract the current scopes and keep any scopes that were manually added in without completely overwriting them with the new file list scope array.
+
 // Project root directory, back one directory from repo_management_files.
 // normalize the 'directoryPath' string to go from the form `/absolute_path/template-nodes-project/repo_management_files/../`
 // to `/absolute_path/template-nodes-project/` to subtract from the beginning of the filePath
@@ -15,15 +17,14 @@ const directoryPath = path.normalize(__dirname + '/../');
 const exclude = ['.dccache', '.git', 'node_modules', 'dist', 'coverage', 'CHANGELOG.md', 'bun.lockb', 'docs'];
 
 /**
- * Subtracts all occurrences of a sub-string from a main string.
+ * Removes absolute path sub-string from a main string.
  * 
- * This function takes two strings as input: a main string and a sub-string.
- * It removes all occurrences of the sub-string from the main string.
+ * This function removes all occurrences of the absolute path to the project directory from the main string.
  * 
- * @param {string} mainString - The main string from which sub-string will be removed.
- * @return {string} The resulting string after removing all occurrences of the sub-string.
+ * @param {string} mainString - The main string from which absolute path sub-string will be removed.
+ * @return {string} The resulting lower case string after removing all occurrences of the absolute path sub-string.
  */
-function subtractStrings(mainString) {
+function removeAbsolutePathToLowerCase(mainString) {
     // Create a regular expression to match all occurrences of the subString 
     const regex = new RegExp(directoryPath, 'g');
 
@@ -32,7 +33,6 @@ function subtractStrings(mainString) {
     return mainString.replace(regex, '').toLowerCase();
 }
 
-
 /**
  * Lists all files and directories in a directory excluding specified items.
  * @param {string} dirPath - The directory path to list items from.
@@ -83,7 +83,6 @@ function listFilesAndDirectories(dirPath, excludeList) {
     });
 }
 
-
 /**
  * Updates the scopes array in the package.json file.
  *
@@ -129,9 +128,10 @@ function updateScopesInPackageJson(packageJsonPath, newScopes) {
     });
 }
 
+// scan all the files not in the exlude list and then update the package.json scopes array
 listFilesAndDirectories(directoryPath, exclude)
     .then(fileScopes => {
-        updateScopesInPackageJson(directoryPath + 'package.json', fileScopes.map(subtractStrings));
+        updateScopesInPackageJson(directoryPath + 'package.json', fileScopes.map(removeAbsolutePathToLowerCase));
     })
     .catch(err => {
         console.error('Error:', err);