feat: add homeDir() API method (#10) (#12)

* feat: add homeDir() API method (#10)

README.md

@@ -111,6 +111,16 @@ export interface writePartialPayload {
 export type writeOptions = writeCompletePayload | writePartialPayload;
 ```
 
+### homedir(): string
+
+Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
+
+```ts
+import * as RC from "@nodesecure/rc";
+
+const homedir = RC.homedir();
+```
+
 ### CONSTANTS
 
 ```ts

src/constants.ts

@@ -1,2 +1,2 @@
-
 export const CONFIGURATION_NAME = ".nodesecurerc";
+export const GLOBAL_CONFIGURATION_DIRECTORY = "nodesecure";

src/index.ts

@@ -2,4 +2,4 @@ export * from "./functions/read.js";
 export * from "./functions/write.js";
 export * as CONSTANTS from "./constants.js";
 
-export { RC, JSONSchema } from "./rc.js";
+export { RC, JSONSchema, homedir } from "./rc.js";

src/rc.ts

@@ -1,8 +1,13 @@
-// Import Types Dependencies
+// Import Node.js Dependencies
+import os from "node:os";
+import path from "node:path";
+
+// Import Third-party Dependencies
 import i18n from "@nodesecure/i18n";
 import * as vuln from "@nodesecure/vuln";
 
 // Import Internal Dependencies
+import { GLOBAL_CONFIGURATION_DIRECTORY } from "./constants.js";
 import { loadJSONSchemaSync } from "./schema/loader.js";
 import { generateCIConfiguration, CiConfiguration, CiWarnings } from "./projects/ci.js";
 import { generateReportConfiguration, ReportConfiguration, ReportChart } from "./projects/report.js";
@@ -58,6 +63,13 @@ export function generateDefaultRC(mode: RCGenerationMode | RCGenerationMode[] =
   );
 }
 
+/**
+ * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
+ */
+export function homedir(): string {
+  return path.join(os.homedir(), GLOBAL_CONFIGURATION_DIRECTORY);
+}
+
 export {
   generateCIConfiguration,
   CiConfiguration,