Export Commands Into Individual INI files [a better 'exportCommands()' function]

[dbareis]

Whether for Backup or another reason such as ease of automated setup in my msi, I do not like all the commands being jumbled together into one ".ini" file.

The following code has a few options but probably defaults to something you'd find reasonable, it also logs to copyq.log:

//copyq:
    var PgmVersion = '2022.05.23a'
    //MyLog(): source('DB$/$ReusableCode$/[COMMON-FUNCTIONS].js')



//===========================================================================
function ExportCmdsForU3aGeneologyToolsMsi()
//cls & "D:/DBAREIS/TOOLS/[Portable]/$Clipboard Managers/CopyQ/copyq.exe" "source('D:/DBAREIS/TOOLS/[Portable]/$Clipboard Managers/CopyQ/DB$/EXPORT_COMMANDS_TO_INI_FILES.js'); ExportCmdsForU3aGeneologyToolsMsi()" 2>&1 | more
//===========================================================================
{
    var ExportTo      = "D:/DBAREIS/Projects/Win32/U3aGeneologyTools/copyq.ini.4.commands"
    ExportIniFiles(ExportTo, "", "", /U3aGeneologyTools/)
}



//===========================================================================
function ExportIniFiles(DirPath, NameExcludeRegExp, NameIncludeRegExp, ContentsIncludeRegExp)
// 1. Order of regexp checks is in order of parameters
// 2. Pass "" (empty string) for the default value of regular expressions
//    SEE: NOT: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_NOT
// 3. DirPath can be absolute or relative (to COPYQ.exe dir)
//===========================================================================
{
    //MyScriptStarting("ExportIniFiles()", PgmVersion, "")
        //--- Set up Defaults -----------------------------------------------
        BadChars = /[/\\:*?<>|"]/g
        if (DirPath == "")
           DirPath = '[SavedCmds.ini]'        //Default output directory
        if  (typeof ContentsIncludeRegExp != 'object')
            ContentsIncludeRegExp = /./       //Match all contents by default
        if  (typeof NameIncludeRegExp != 'object')
            NameIncludeRegExp     = /./           //Match all files by default
        if  (typeof NameExcludeRegExp != 'object')
            NameExcludeRegExp     = /^(Add a Tag|Clear all tags|Pin|Remove a Tag|Remove tag .Important.|Tag as .Important.|Unpin)$/  //Ignore standard copyq files/commands...

        //--- Get DirPath to save to, make sure it exists -----------------
        DestDir = Dir(".")
        if  (!DestDir.mkpath(DirPath))
        {
            MyLog('ERROR: Could not create the DirPath: "' + DirPath + '"')
            return
        }
        MyLog('PARAMETERS')
        MyLog('~~~~~~~~~~')
        MyLog('\tDESTINATION DIR           : "' + DirPath + '"')
        MyLog('\tCMD NAME RegExp Exclusion : ' + NameExcludeRegExp)
        MyLog('\tCMD NAME RegExp Inclusion : ' + NameIncludeRegExp)
        MyLog('\tCONTENTS RegExp Inclusion : ' + ContentsIncludeRegExp)
        MyLog('\tBAD FILENAME CHARACTERS   : ' + BadChars)

        //--- Get list of Commands and process them -------------------------
        var ExistingCmds = commands()
        var NumCmds      = ExistingCmds.length
        MyLog('There are ' + NumCmds + ' commands to process')
        for (j=0; j < ExistingCmds.length; j++)
        {
            //--- Get the object Info ---------------------------------------
            var CmdObj  = ExistingCmds[j]
            var CmdName = CmdObj.name.trim()   //Strip any leading trailing spaces (accidents)
            if (NameExcludeRegExp.test(CmdName))
                MyLog('[' + (j+1) + ' of ' + NumCmds + '] EXCLUDED BY COMMAND NAME: ' + CmdName)
            else
            {
                if (! NameIncludeRegExp.test(CmdName))
                    MyLog('[' + (j+1) + ' of ' + NumCmds + '] NOT ASKED TO INCLUDE THIS COMMAND BY NAME: ' + CmdName)
                else
                {
                    //--- Get the command's conmtents and check it ----------
                    var ArrayOf1    = [ CmdObj ]
                    var IniContents = exportCommands(ArrayOf1)
                        IniContents = IniContents.replace(/\n*$/, '\n')    //Remove trailing blank lines
                    if (! ContentsIncludeRegExp.test(IniContents))
                    {
                        MyLog('[' + (j+1) + ' of ' + NumCmds + '] EXCLUDED BY COMMAND\'S CONTENTS NOT MATCHING: ' + CmdName)
                        MyLog("\nCONTENTS (stringified):\n" + "~~~~~~~~~~~~~~~~~~~~~~~~~\n" + IniContents + '\n')

                    }
                    else
                    {
                        //--- Export the stringified (serialised) command (files can be read imported with "importCommands()") ---
                        var Suffix = ''
                        var SN = CmdName.replace(BadChars, '_')
                        if  (SN != CmdName)
                        {
                            SN         = '![ ' + SN + ' ]!'                 //Contained one  or more "bad" characters
                            var Suffix = '\nTO: "' + SN + '.ini"'
                        }
                        var IniFileName = DirPath + '/' + SN + '.ini'

                        //--- We will process this item ---------------------
                        MyLog('[' + (j+1) + ' of ' + NumCmds + '] EXPORTING: ' + CmdName + Suffix)
                        MyLog("\nCONTENTS (stringified):\n" + "~~~~~~~~~~~~~~~~~~~~~~~~~\n" + IniContents + '\n')

                        //--- Save to the INI file --------------------------------------
                        var f = new File(IniFileName)
                            f.openWriteOnly()
                            f.write(IniContents)
                            f.close()
                    }
               }
            }
        }

    //MyScriptEnding("")
}


//============================================================================
function MyLog(Text)
//============================================================================
{   var T = Text + '      '
    serverLog(Text)
    //console.log(T)
}