config.json

{
  "name": "TextEditor",
  "viewName": "Text Editor",
  "type": "executer",
  "main": "app.js",
  "execProgram": "node",
  "version": "1.7.0",
  "description": "Basic create, read, edit, search functions for text files",
  "imgUrl": "logo.png",
  "category": [
    "Basic Tools"
  ],
  "keywords": [
    "text",
    "file",
    "vault",
    "search",
    "replace",
    "line",
    "regexp",
    "write",
    "append"
   ],
  "methods": [
    {
      "name": "createFile",
      "viewName": "Create New File",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for the new file",
          "placeholder": "scripts/export.sh"
        },
        {
          "name": "CONTENT",
          "viewName": "File Content",
          "type": "text",
          "required": true,
          "description": "The initial contents of the file",
          "placeholder": "#!/bin/bash\ntar -czvf logs-$(date +%F).tgz /var/log/*.log"
        },
        {
          "name": "overwrite",
          "viewName": "Overwrite Existing",
          "description": "If enabled, any existing file at the File Path will be overwritten.",
          "type": "boolean",
          "default": true
        },
        {
          "name": "return",
          "viewName": "Return File Content",
          "type": "boolean",
          "default": false,
          "description": "If enabled, after writing the file, the contents are also returned to Final Result."
        }
      ]
    },
    {
      "name": "createVaultFile",
      "viewName": "Create File From Vault",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for the new file",
          "placeholder": "secrets/gcp_creds.json"
        },
        {
          "name": "CONTENT",
          "viewName": "File Content",
          "type": "vault",
          "required": true,
          "description": "The Kaholo vault item continaing the contents for the file"
        },
        {
          "name": "overwrite",
          "viewName": "Overwrite Existing",
          "description": "If enabled, any existing file at the File Path will be overwritten.",
          "type": "boolean",
          "default": true
        }
      ]
    },
    {
      "name": "appendToFile",
      "viewName": "Append To File",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for file to be appended",
          "placeholder": "logs/build_results.log"
        },
        {
          "name": "CONTENT",
          "viewName": "Content",
          "type": "text",
          "required": true,
          "description": "The text to append to the file",
          "placeholder": "project kaholo-enterprise built successfully"
        },
        {
          "name": "dontCreate",
          "viewName": "Don't Create",
          "type": "boolean",
          "description": "If enabled, append only if file at File Path already exists"
        },
        {
          "name": "return",
          "viewName": "Return New Content",
          "type": "boolean",
          "default": "false",
          "description": "If enabled, after appending the entire contents of the file are returned to Final Result."
        }
      ]
    },
    {
      "name": "searchInFile",
      "viewName": "Search In File",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for file to search",
          "placeholder": "project/log/build.log"
        },
        {
          "name": "REGEX",
          "viewName": "RegExp",
          "type": "string",
          "description": "Regular expressions are patterns used to match character combinations in strings.",
          "placeholder": "^.*ERROR.*$"
        },
        {
          "name": "return",
          "viewName": "Return Matches",
          "type": "boolean",
          "default": false,
          "description": "If enabled, all matches are returned. Otherwise only found: true/false"
        }
      ]
    },
    {
      "name": "replaceText",
      "viewName": "Replace Text In File",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for the file to have replacements made",
          "placeholder": "scripts/export.sh"
        },
        {
          "name": "REGEX",
          "viewName": "Search RegExp Expression",
          "type": "string",
          "required": true,
          "description": "Regular expression used to match strings in the file",
          "placeholder": "[eE][rR][rR][oO][rR]"
        },
        {
          "name": "REPLACE",
          "viewName": "Replace Value",
          "type": "text",
          "required": false,
          "description": "The string to replace those matching the Search RegExp Expression",
          "placeholder": "(Leave undefined to simply delete matches)"
        },
        {
          "name": "return",
          "viewName": "Return New Content",
          "type": "boolean",
          "default": false,
          "description": "If enabled, after replacing the entire contents of the file are returned to Final Result."
        }
      ]
    },
    {
      "name": "getFileContent",
      "viewName": "Read File Content",
      "params": [
        {
          "name": "PATH",
          "viewName": "File Path",
          "type": "string",
          "required": true,
          "description": "Path and filename for the file to read",
          "placeholder": "scripts/export.sh"
        }
      ]
    }
  ]
}