fsRenameFolderCore.mjs

import get from 'lodash-es/get.js'
import getPathParent from './getPathParent.mjs'
import fsExistsCore from './fsExistsCore.mjs'
import fsIsFolderCore from './fsIsFolderCore.mjs'
import fsCreateFolderCore from './fsCreateFolderCore.mjs'
import toResultError from './_toResultError.mjs'


/**
 * 後端nodejs重新命名資料夾
 *
 * Unit Test: {@link https://github.com/yuda-lyu/wsemi/blob/master/test/fsRenameFolderCore.test.mjs Github}
 * @memberOf wsemi
 * @param {String} pahOld 輸入資料夾原本路徑字串
 * @param {String} pahNew 輸入資料夾更名路徑字串
 * @returns {Object} 回傳結果物件，提供鍵success代表成功訊息，提供鍵error代表錯誤訊息(說明字串或Error物件)
 * @example
 * need test in nodejs.
 *
 * //see fsRenameFolder
 *
 */
function fsRenameFolderCore(pahOld, pahNew, opt = {}) {
    try {

        //fs, 讀取opt置於try內: opt本身或其屬性不可讀(getter拋錯、已撤銷之Proxy)時get拋出, 於try外即成同步拋錯
        let fs = get(opt, 'fs')

        //check, 前置檢查置於try內: 注入之fs之lstatSync可拋錯, 於try外即成同步拋錯
        if (!fsIsFolderCore(pahOld, { fs })) {
            return {
                error: `pahOld[${pahOld}] is not a folder` //pahOld不是資料夾則視為錯誤
            }
        }

        //check
        if (fsExistsCore(pahNew, { fs })) {
            return {
                error: `pahNew[${pahNew}] already exists` //pahNew存在則視為錯誤
            }
        }

        //fd
        let fd = getPathParent(pahNew)

        //check
        if (!fsIsFolderCore(fd, { fs })) {
            fsCreateFolderCore(fd, { fs })
        }

        //renameSync
        fs.renameSync(pahOld, pahNew)

    }
    catch (err) {
        return {
            error: toResultError(err) //Error或非空字串原樣, 其餘(null、undefined等)轉字串, 恆為truthy
        }
    }

    return {
        success: 'done: ' + pahNew
    }
}


export default fsRenameFolderCore