runScripts.js

var runScripts = {
  extMan: null,
  scriptDir: '../scripts',
  showOutput: true,
  hist: [],
  histFile: '',
  extdir: null,
  fs: null,
  template: `
#!/bin/zsh

#
# The following Environment Variables are created by Modal File Manager 
# before running your script:
#
# $CURRENT_DIRECTORY          The current directory for the cursor
# $CURRENT_FILE               The current file name for the cursor
# $LEFT_PANE                  The directory of the left file pane
# $LEFT_PANE_SELECTED_FILE    The last highlighted file in the left file pane
# $RIGHT_PANE                 The directory of the right file pane
# $RIGHT_PANE_SELECTED_FILE   The last highlighted file in the right file pane
# $FILES_SELECTED             A newline separated list of selected files
# 
# After creating the script, you have to set the mode to executable for 
# it to be ran. You can change the shebang to run any language on your 
# computer (and then change the comments also).
#
  `,
  init: async function(extManager) {
    runScripts.extMan = extManager;
    const cmds = runScripts.extMan.getCommands();
    var lfs = extManager.localFS;
    const extdir = extManager.getExtensionDir();
    runScripts.extdir = extdir;
    runScripts.fs = lfs;
    runScripts.histFile = await lfs.appendPath(extdir, '../cmdhist.json');
    runScripts.scriptDir = await lfs.appendPath(extdir, '../scripts');
    if (! await lfs.dirExists(runScripts.scriptDir)) {
      await lfs.makeDir(runScripts.scriptDir);
      await runScripts.copyExampleScripts();
    }
    if (! await lfs.fileExists(runScripts.histFile)) {
      await lfs.writeFile(runScripts.histFile, JSON.stringify(['ls']));
      runScripts.hist = ['ls'];
    } else {
      runScripts.hist = await lfs.readFile(runScripts.histFile);
      runScripts.hist = JSON.parse(runScripts.hist);
    }
    cmds.addCommand('Run Script', 'runScripts.runScript', 'Run a user created script.', runScripts.runScript);
    cmds.addCommand('Run NPM Script', 'runScripts.runNpmScript', 'Run a npm script.', runScripts.runNpmScript);
    cmds.addCommand('Run Mask Script', 'runScripts.runMaskScript', 'Run a Mask script.', runScripts.runMaskScript);
    cmds.addCommand('Create Script', 'runScripts.createScript', 'Create a script.', runScripts.createScript);
    cmds.addCommand('Toggle Show Output', 'runScripts.toggleShowOutput', 'Toggle the showing of an output from running scripts.', runScripts.toggleShowOutput);
    cmds.addCommand('Run Command Line', 'runScripts.runCommandLine', 'Run a command line the user gives.', runScripts.runCommandLine);
    cmds.addCommand('Edit Script', 'runScripts.editScript', 'Edit the user specified script.', runScripts.editScript);
    cmds.addCommand('Go To Scripts Directory', 'runScripts.goToScript', 'Open the scripts directory.', runScripts.goToScript);
    cmds.addCommand('Install Example Scripts', 'runScripts.copyExampleScripts', 'Install the example scripts. If you have changed any, they will be overwritten.', runScripts.copyExampleScripts);
  },
  copyExampleScripts: async function() {
    var lfs = runScripts.fs;
    if (await lfs.dirExists(runScripts.scriptDir)) {
      var orgScriptDir = await lfs.appendPath(runScripts.extdir, 'runScripts-ModalFileManagerExtension/scripts');
      if (await lfs.dirExists(orgScriptDir)) {
        var scrpts = await lfs.getDirList(orgScriptDir);
        runScripts.extMan.getExtCommand('copyEntriesCommand').command(scrpts, {
          dir: runScripts.scriptDir,
          name: ''
        });
      }
    }
  },
  saveHistFile: async function() {
    runScripts.hist = [...new Set(runScripts.hist)];
    await runScripts.fs.writeFile(runScripts.histFile, JSON.stringify(runScripts.hist));
  },
  unload: function() {
    runScripts.saveHistFile();
  },
  installKeyMaps: function() {
  },
  goToScript: function() {
    runScripts.extMan.getExtCommand('changeDir').command({
      path: runScripts.scriptDir
    });
  },
  toggleShowOutput: function() {
    if (runScripts.showOutput) {
      runScripts.showOutput = false;
    } else {
      runScripts.showOutput = true;
    }
  },
  runCommandLine: function() {
    // 
    // This will prompt the user for a command line to run. It shows 
    // past command lines to pick from as well.
    //
    runScripts.extMan.getExtCommand('pickItem').command('Command Line:', runScripts.hist.map(item => {
      return ({
        name: item,
        value: item
      });
    }), runScripts.runCommandLineReturn, true);
  },
  runCommandLineReturn: function(value) {
    if (value !== null) {
      runScripts.hist.push(value);
      runScripts.saveHistFile();
      runScripts.returnScript(value);
    } else {
      runScripts.extMan.getExtCommand('showMessage').command('Run Command Line', 'Not a proper command line. Try again.');
    }
  },
  runNpmScript: async function() {
    //
    // This will show all npm scripts in the current directory and prompt the 
    // user to select one.
    //
    var lfs = runScripts.fs;
    const lcursor = runScripts.extMan.getExtCommand('getCursor').command();
    var npmf = await lfs.appendPath(lcursor.entry.dir, 'package.json');
    if (await lfs.fileExists(npmf)) {
      var npmFile = await lfs.readFile(npmf);
      npmFile = JSON.parse(npmFile);
      var scripts = [];
      Object.keys(npmFile.scripts).forEach(item => {
        scripts.push({
          name: item,
          value: item
        });
      });
      runScripts.extMan.getExtCommand('pickItem').command('Which Npm Script?', scripts, runScripts.runNpmScriptReturn);
    } else {
      runScripts.extMan.getExtCommand('showMessage').command('Run User Scripts', 'No package.json file in this directory!');
    }
  },
  runNpmScriptReturn: function(value) {
    runScripts.returnScript('npm run ' + value);
  },
  runMaskScript: async function() {
    //
    // This will show all Mask scripts in the current directory and prompt the 
    // user to select one.
    //
    var lfs = runScripts.fs;
    const lcursor = runScripts.extMan.getExtCommand('getCursor').command();
    var maskf = await lfs.appendPath(lcursor.entry.dir, 'maskfile.md');
    var scripts = [];
    if (await lfs.fileExists(maskf)) {
      var npmFile = await lfs.readFile(maskf);
      npmFile = String(npmFile).split('\n').forEach(el => {
        var mtch = el.match(/##\ ([^\ ]*)/);
        if (mtch !== null) {
          scripts.push({
            name: mtch[1],
            value: mtch[1]
          })
        }
      });
      runScripts.extMan.getExtCommand('pickItem').command('Which Mask Script?', scripts, runScripts.runMaskScriptReturn);
    } else {
      runScripts.extMan.getExtCommand('showMessage').command('Run User Scripts', 'No maskfile.md file in this directory!');
    }
  },
  runMaskScriptReturn: function(value) {
    runScripts.returnScript('mask ' + value);
  },
  runScript: async function() {
    var lfs = runScripts.fs;
    var scrpts = await lfs.getDirList(runScripts.scriptDir);
    var scrptsArray = [];
    for (var i = 0; i < scrpts.length; i++) {
      var pth = await lfs.appendPath(scrpts[i].dir, scrpts[i].name);
      scrptsArray.push({
        name: scrpts[i].name,
        value: pth
      });
    }
    if (scrptsArray.length < 1) {
      // 
      // Tell the user to create some scripts.
      //
      runScripts.extMan.getExtCommand('showMessage').command('Run User Scripts', 'No scripts created yet. Start making some!');
    } else {
      //
      // List the scripts for the user to pick from.
      //
      runScripts.extMan.getExtCommand('pickItem').command('Which Script?', scrptsArray, runScripts.returnScript);
    }
  },
  returnScript: async function(value) {
    var lfs = runScripts.fs;
    var sEnv = [];

    const lcursor = runScripts.extMan.getExtCommand('getCursor').command();
    const lLeftFile = runScripts.extMan.getExtCommand('getLeftFile').command();
    const lRightFile = runScripts.extMan.getExtCommand('getRightFile').command();
    const lLeftDir = runScripts.extMan.getExtCommand('getLeftDir').command();
    const lRightDir = runScripts.extMan.getExtCommand('getRightDir').command();
    const sFileList = runScripts.extMan.getExtCommand('getSelectedFiles').command()
    var filelst = [];
    for (var i = 0; i < sFileList.length; i++) {
      var pth = await lfs.appendPath(sFileList[i].dir, sFileList[i].name);
      filelst.push(pth);
    }

    sEnv['CURRENT_DIRECTORY'] = lcursor.entry.dir;
    sEnv['CURRENT_FILE'] = lcursor.entry.name;
    sEnv['LEFT_PANE'] = lLeftDir.path;
    sEnv['LEFT_PANE_SELECTED_FILE'] = lLeftFile.entry.name;
    sEnv['RIGHT_PANE'] = lRightDir.path;
    sEnv['RIGHT_PANE_SELECTED_FILE'] = lRightFile.entry.name;
    sEnv['FILES_SELECTED'] = filelst.join(', ');

    await lfs.runCommandLine(value, sEnv, (err, data) => {
      if (runScripts.showOutput) {
        //
        // Show the user the output from the script.
        //
        if (err) {
          runScripts.showOutputDialog('Error: ' + err);
        } else {
          runScripts.showOutputDialog(data);
        }
      }
    },
      lcursor.entry.dir);
  },
  showOutputDialog: function(msg) {
    //
    // Show the user the message.
    //
    msg = msg.replaceAll('\n', '<br />');
    msg = msg.replaceAll(/Error/gi, '<span style="color: red;">Error</span>');
    msg = "<div style='display: flex; flex-direction: column; overflow: auto; height: 200px;'>" + msg + "</div>";
    runScripts.extMan.getExtCommand('showMessage').command('Script Output', msg);
  },
  createScript: function() {
    runScripts.extMan.getExtCommand('askQuestion').command('Create User Scripts', 'Name of the script file (with extension):', runScripts.createScriptReturn);
  },
  createScriptReturn: async function(value) {
    var lfs = runScripts.fs;
    value = value.trim();
    var sptFile = await lfs.appendPath(runScripts.scriptDir, value);
    if (! await lfs.fileExists(sptFile)) {
      await lfs.writeFile(sptFile, runScripts.template);
      runScripts.returnEdit(sptFile);
    } else {
      runScripts.extMan.getExtCommand('showMessage').command('Create User Script', 'Script already exists!');
    }
  },
  editScript: async function() {
    //
    // Show the user the list of scripts and open the selected one in the 
    // editor.
    //
    var lfs = runScripts.fs;
    var lscrpts = await lfs.getDirList(runScripts.scriptDir);
    var scrpts = [];
    for (var i = 0; i < lscrpts.length; i++) {
      var pth = await lfs.appendPath(lscrpts[i].dir, lscrpts[i].name);
      scrpts.push({
        name: lscrpts[i].name,
        value: pth
      });
    }
    if (scrpts.length < 1) {
      // 
      // Tell the user to create some scripts.
      //
      runScripts.extMan.getExtCommand('showMessage').command('Run User Scripts', 'No scripts created yet. Start making some!');
    } else {
      //
      // List the scripts for the user to pick from.
      //
      runScripts.extMan.getExtCommand('pickItem').command('Which Script?', scrpts, runScripts.returnEdit);
    }
  },
  returnEdit: function(value) {
    runScripts.extMan.getExtCommand('editEntryCommand').command(value);
  }
};
return (runScripts);