Merge pull request #47 from Exabyte-io/chore/SOF-6464

chore/SOF-6464

Author: azech-hqs

src/utils/file.js

@@ -58,3 +58,21 @@ export function getDirectories(currentPath) {
         .filter((dirent) => dirent.isDirectory())
         .map((dirent) => dirent.name);
 }
+
+/**
+ * Construct object path compatible with lodash.get/lodash.set from file path.
+ * Note: if no root path is provided the file's dirname is taken instead.
+ * @param {string} filePath - Path to file.
+ * @param {string} root - Path to a parent directory to construct relative path.
+ * @return {string} - Object path reflecting file path.
+ * @example
+ * createObjectPathFromFilePath("/a/b/c/d/e.yml", "/a/b");
+ * // "['c']['d']['e']"
+ */
+export function createObjectPathFromFilePath(filePath, root) {
+    const dirname = path.dirname(filePath);
+    const extension = path.extname(filePath);
+    const basename = path.basename(filePath, extension);
+    const parentDirs = root ? path.relative(root, dirname).split(path.sep) : [];
+    return [...parentDirs, basename].map((item) => `['${item}']`).join("");
+}

src/utils/index.js

@@ -4,6 +4,7 @@ import { cloneClass, extendClass, extendClassStaticProps, extendThis } from "./c
 import { deepClone } from "./clone";
 import { refreshCodeMirror } from "./codemirror";
 import {
+    createObjectPathFromFilePath,
     formatFileSize,
     getDirectories,
     getFilesInDirectory,
@@ -87,4 +88,5 @@ export {
     filterEntityList,
     getFilesInDirectory,
     getDirectories,
+    createObjectPathFromFilePath,
 };

tests/utils/file.tests.js

@@ -0,0 +1,11 @@
+import { expect } from "chai";
+
+import { createObjectPathFromFilePath } from "../../src/utils/file";
+
+describe("file utilities", () => {
+    it("should create an object path from a file path", () => {
+        const thisFile = "/code.js/tests/utils/file.tests.js";
+        const objectPath = createObjectPathFromFilePath(thisFile, "/code.js");
+        expect(objectPath).to.be.equal("['tests']['utils']['file.tests']");
+    });
+});