api documentation for github-crud (2019.1.21)

this zero-dependency package will provide a simple cli-tool to PUT / GET / DELETE github files

module github-crud
1. function github-crud.ajax (option, onError)
2. function github-crud.assertThrow (passed, message)
3. function github-crud.cliRun (option)
4. function github-crud.functionOrNop (fnc)
5. function github-crud.githubCrudAjax (option, onError)
6. function github-crud.githubCrudContentDelete (option, onError)
7. function github-crud.githubCrudContentGet (option, onError)
8. function github-crud.githubCrudContentPut (option, onError)
9. function github-crud.githubCrudContentPutFile (option, onError)
10. function github-crud.githubCrudContentTouch (option, onError)
11. function github-crud.githubCrudContentTouchList (option, onError)
12. function github-crud.githubCrudRepoCreate (option, onError)
13. function github-crud.githubCrudRepoCreateList (option, onError)
14. function github-crud.githubCrudRepoDelete (option, onError)
15. function github-crud.githubCrudRepoDeleteList (option, onError)
16. function github-crud.identity (value)
17. function github-crud.nop ()
18. function github-crud.objectAssignDefault (target, source)
19. function github-crud.onErrorDefault (error)
20. function github-crud.onErrorWithStack (onError)
21. function github-crud.onNext (option, onError)
22. function github-crud.onParallel (onError, onEach, onRetry)
23. function github-crud.onParallelList (option, onEach, onError)
24. number github-crud.timeExit
25. object github-crud.cliDict
26. object github-crud.github_crud
27. object github-crud.local
28. object github-crud.timerTimeoutAjaxProgressHide
29. string github-crud.__dirname
module github-crud.cliDict

module github-crud

function github-crud.ajax (option, onError)

description and source-code

ajax = function (option, onError) {
/*
 * this function will send an ajax-request with given <option>.url,
 * with error-handling and timeout
 * example usage:
    local.ajax({
        data: "hello world",
        header: {"x-header-hello": "world"},
        method: "POST",
        url: "/index.html"
    }, function (error, xhr) {
        console.log(xhr.statusCode);
        console.log(xhr.responseText);
    });
 */
    var ajaxProgressUpdate;
    var bufferValidateAndCoerce;
    var isDone;
    var local2;
    var onEvent;
    var streamCleanup;
    var timeout;
    var tmp;
    var xhr;
    var xhrInit;
    // init local2
    local2 = local.utility2 || {};
    // init function
    ajaxProgressUpdate = local2.ajaxProgressUpdate || local.nop;
    bufferValidateAndCoerce = local2.bufferValidateAndCoerce || function (
        bff,
        mode
    ) {
    /*
     * this function will validate and coerce/convert <bff> -> Buffer
     * (or String if <mode> = "string")
     */
        // coerce ArrayBuffer -> Buffer
        if (Object.prototype.toString.call(bff) === "[object ArrayBuffer]") {
            bff = new Uint8Array(bff);
        }
        // convert Buffer -> utf8
        if (mode === "string" && typeof bff !== "string") {
            bff = String(bff);
        }
        return bff;
    };
    onEvent = function (event) {
    /*
     * this function will handle events
     */
        if (Object.prototype.toString.call(event) === "[object Error]") {
            xhr.error = xhr.error || event;
            xhr.onEvent({
                type: "error"
            });
            return;
        }
        // init statusCode
        xhr.statusCode = (xhr.statusCode || xhr.status) | 0;
        switch (event.type) {
        case "abort":
        case "error":
        case "load":
            if (isDone) {
                return;
            }
            isDone = true;
            // decrement ajaxProgressCounter
            local2.ajaxProgressCounter = Math.max(
                local2.ajaxProgressCounter - 1,
                0
            );
            ajaxProgressUpdate();
            // handle abort or error event
            switch (!xhr.error && event.type) {
            case "abort":
            case "error":
                xhr.error = new Error("ajax - event " + event.type);
                break;
            case "load":
                if (xhr.statusCode >= 400) {
                    xhr.error = new Error(
                        "ajax - statusCode " + xhr.statusCode
                    );
                }
                break;
            }
            // debug statusCode / method / url
            if (xhr.error) {
                xhr.statusCode = xhr.statusCode || 500;
                xhr.error.statusCode = xhr.statusCode;
                tmp = (
                    // ternary-condition
                    (
                        local.isBrowser
                        ? "browser"
                        : "node"
                    )
                    + " - " + xhr.statusCode + " " + xhr.method + " " + xhr.url
                    + "\n"
                );
                xhr.error.message = tmp + xhr.error.message;
                xhr.error.stack = tmp + xhr.error.stack;
            }
            // update responseHeaders
            // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/getAllResponseHeaders
            if (xhr.getAllResponseHeaders) {
                xhr.getAllResponseHeaders().replace((
                    /(.*?):\u0020*(.*?)\r\n/g
                ), function (ignore, match1, match2) {
                    xhr.responseHeaders[match1.toLowerCase()] = match2;
                });
            }
            // debug ajaxResponse
            xh...

example usage

...

/* validateLineSortedReset */
local.ajax = function (option, onError) {
/*
* this function will send an ajax-request with given <option>.url,
* with error-handling and timeout
* example usage:
   local.ajax({
       data: "hello world",
       header: {"x-header-hello": "world"},
       method: "POST",
       url: "/index.html"
   }, function (error, xhr) {
       console.log(xhr.statusCode);
       console.log(xhr.responseText);
...

function github-crud.assertThrow (passed, message)

description and source-code

assertThrow = function (passed, message) {
/*
 * this function will throw error <message> if <passed> is falsy
 */
    var error;
    if (passed) {
        return;
    }
    error = (
        // ternary-condition
        (
            message
            && typeof message.message === "string"
            && typeof message.stack === "string"
        )
        // if message is an error-object, then leave it as is
        ? message
        : new Error(
            typeof message === "string"
            // if message is a string, then leave it as is
            ? message
            // else JSON.stringify message
            : JSON.stringify(message, null, 4)
        )
    );
    throw error;
}

example usage

...
    commandList[ii] = option.rgxComment.exec(text);
    commandList[ii] = {
        argList: (commandList[ii][1] || "").trim(),
        command: [key],
        description: commandList[ii][2]
    };
} catch (ignore) {
    local.assertThrow(null, new Error(
        "cliRun - cannot parse comment in COMMAND "
        + key + ":\nnew RegExp("
        + JSON.stringify(option.rgxComment.source)
        + ").exec(" + JSON.stringify(text)
        .replace((
            /\\\\/g
        ), "\u0000")
...

function github-crud.cliRun (option)

description and source-code

cliRun = function (option) {
/*
 * this function will run cli
 */
    local.cliDict._eval = local.cliDict._eval || function () {
    /*
     * <code>
     * will eval <code>
     */
        globalThis.local = local;
        local.vm.runInThisContext(process.argv[3]);
    };
    local.cliDict["--eval"] = local.cliDict["--eval"] || local.cliDict._eval;
    local.cliDict["-e"] = local.cliDict["-e"] || local.cliDict._eval;
    local.cliDict._help = local.cliDict._help || function () {
    /*
     *
     * will print help
     */
        var commandList;
        var file;
        var packageJson;
        var text;
        var textDict;
        commandList = [{
            argList: "<arg2>  ...",
            description: "usage:",
            command: ["<arg1>"]
        }, {
            argList: "'console.log(\"hello world\")'",
            description: "example:",
            command: ["--eval"]
        }];
        file = __filename.replace((
            /.*\//
        ), "");
        option = Object.assign({}, option);
        packageJson = require("./package.json");
        // validate comment
        option.rgxComment = option.rgxComment || (
            /\)\u0020\{\n(?:|\u0020{4})\/\*\n(?:\u0020|\u0020{5})\*((?:\u0020<[^>]*?>|\u0020\.\.\.)*?)\n(?:\u0020|\u0020{5})\*\u0020
(will\u0020.*?\S)\n(?:\u0020|\u0020{5})\*\/\n(?:\u0020{4}|\u0020{8})\S/
        );
        textDict = {};
        Object.keys(local.cliDict).sort().forEach(function (key, ii) {
            if (key[0] === "_" && key !== "_default") {
                return;
            }
            text = String(local.cliDict[key]);
            if (key === "_default") {
                key = "";
            }
            textDict[text] = textDict[text] || (ii + 2);
            ii = textDict[text];
            if (commandList[ii]) {
                commandList[ii].command.push(key);
                return;
            }
            try {
                commandList[ii] = option.rgxComment.exec(text);
                commandList[ii] = {
                    argList: (commandList[ii][1] || "").trim(),
                    command: [key],
                    description: commandList[ii][2]
                };
            } catch (ignore) {
                local.assertThrow(null, new Error(
                    "cliRun - cannot parse comment in COMMAND "
                    + key + ":\nnew RegExp("
                    + JSON.stringify(option.rgxComment.source)
                    + ").exec(" + JSON.stringify(text)
                    .replace((
                        /\\\\/g
                    ), "\u0000")
                    .replace((
                        /\\n/g
                    ), "\\n\\\n")
                    .replace((
                        /\u0000/g
                    ), "\\\\") + ");"
                ));
            }
        });
        text = "";
        text += packageJson.name + " (" + packageJson.version + ")\n\n";
        text += commandList
        .filter(function (element) {
            return element;
        })
        .map(function (element, ii) {
            element.command = element.command.filter(function (element) {
                return element;
            });
            switch (ii) {
            case 0:
            case 1:
                element.argList = [element.argList];
                break;
            default:
                element.argList = element.argList.split(" ");
                element.description = (
                    "# COMMAND "
                    + (element.command[0] || "<none>") + "\n# "
                    + element.description
                );
            }
            return (
                el...

example usage

...
    }, function (error) {
        process.exit(Boolean(error));
    });
};

// run cli
if (module === require.main && !globalThis.utility2_rollup) {
    local.cliRun();
}
}());



}());
...

function github-crud.functionOrNop (fnc)

description and source-code

functionOrNop = function (fnc) {
/*
 * this function will if <fnc> exists,
 * them return <fnc>,
 * else return <nop>
 */
    return fnc || local.nop;
}

example usage

...
xhr.addEventListener("loadstart", ajaxProgressUpdate);
xhr.addEventListener("progress", ajaxProgressUpdate);
// https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/upload
if (xhr.upload && xhr.upload.addEventListener) {
    xhr.upload.addEventListener("progress", ajaxProgressUpdate);
}
// open url - corsForwardProxyHost
if (local.functionOrNop(local2.corsForwardProxyHostIfNeeded)(xhr)) {
    xhr.open(xhr.method, local2.corsForwardProxyHostIfNeeded(xhr));
    xhr.setRequestHeader(
        "forward-proxy-headers",
        JSON.stringify(xhr.headers)
    );
    xhr.setRequestHeader("forward-proxy-url", xhr.url);
// open url - default
...

function github-crud.githubCrudAjax (option, onError)

description and source-code

githubCrudAjax = function (option, onError) {
/*
 * this function will make a low-level content-request to github
 * https://developer.github.com/v3/repos/contents/
 */
    // init option
    option = {
        content: option.content,
        headers: Object.assign({
            // github oauth authentication
            Authorization: "token " + (
                typeof process === "object" && process && process.env.GITHUB_TOKEN
            ),
            // bug-workaround - https://developer.github.com/v3/#user-agent-required
            "User-Agent": "undefined"
        }, option.headers),
        httpRequest: option.httpRequest,
        message: option.message,
        method: option.method || "GET",
        responseJson: {},
        sha: option.sha,
        url: option.url
    };
    option.url = option.url
/* jslint ignore:start */
// parse https://github.com/:owner/:repo/blob/:branch/:path
.replace(
    (/^https:\/\/github.com\/([^\/]+?\/[^\/]+?)\/blob\/([^\/]+?)\/(.+)/),
    'https://api.github.com/repos/$1/contents/$3?branch=$2'
)
// parse https://github.com/:owner/:repo/tree/:branch/:path
.replace(
    (/^https:\/\/github.com\/([^\/]+?\/[^\/]+?)\/tree\/([^\/]+?)\/(.+)/),
    'https://api.github.com/repos/$1/contents/$3?branch=$2'
)
// parse https://raw.githubusercontent.com/:owner/:repo/:branch/:path
.replace(
(/^https:\/\/raw.githubusercontent.com\/([^\/]+?\/[^\/]+?)\/([^\/]+?)\/(.+)/),
    'https://api.github.com/repos/$1/contents/$3?branch=$2'
)
// parse https://:owner.github.io/:repo/:path
.replace(
    (/^https:\/\/([^\.]+?)\.github\.io\/([^\/]+?)\/(.+)/),
    'https://api.github.com/repos/$1/$2/contents/$3?branch=gh-pages'
)
// parse :owner/:repo
.replace(
    (/^([^\/]+?\/[^\/]+?)$/),
    'https://github.com/$1'
)
/* jslint ignore:end */
    .replace((
        /\?branch=(.*)/
    ), function (match0, match1) {
        option.branch = match1;
        if (option.method === "GET") {
            match0 = match0.replace("branch", "ref");
        }
        return match0;
    });
    if ((
        /^https:\/\/github\.com\/[^\/]+?\/[^\/]+?$/
    ).test(option.url)) {
        option.data = JSON.stringify({
            name: option.url.split("/")[4]
        });
        switch (option.method) {
        case "DELETE":
            option.url = (
                "https://api.github.com/repos/"
                + option.url.split("/").slice(3).join("/")
            );
            break;
        case "POST_ORG":
            option.url = (
                "https://api.github.com/orgs/"
                + option.url.split("/")[3] + "/repos"
            );
            break;
        case "POST_USER":
            option.url = "https://api.github.com/user/repos";
            break;
        }
        option.method = option.method.split("_")[0];
    } else {
        if (option.url.indexOf("https://api.github.com/repos/") !== 0) {
            console.error("githubCrud - invalid url " + option.url);
            onError(new Error("invalid url " + option.url));
            return;
        }
        if (option.method !== "GET") {
            option.message = (
                option.message
                || "[ci skip] " + option.method + " file "
                + option.url.replace((
                    /\?.*/
                ), "")
            );
            option.url += "&message=" + encodeURIComponent(option.message);
            if (option.sha) {
                option.url += "&sha=" + option.sha;
            }
            option.data = JSON.stringify({
                branch: option.branch,
                content: Buffer.from(option.content || "").toString("base64"),
                message: option.me...

example usage

...
    message: option.message,
    url: option.url
};
local.onNext(option, function (error, data) {
    switch (option.modeNext) {
    case 1:
        // get sha
        local.githubCrudAjax({
            httpRequest: option.httpRequest,
            url: option.url
        }, option.onNext);
        break;
    case 2:
        // delete file with sha
        if (!error && data.sha) {
...

function github-crud.githubCrudContentDelete (option, onError)

description and source-code

githubCrudContentDelete = function (option, onError) {
/*
 * this function will delete github-file <option>.url
 * https://developer.github.com/v3/repos/contents/#delete-a-file
 */
    option = {
        httpRequest: option.httpRequest,
        message: option.message,
        url: option.url
    };
    local.onNext(option, function (error, data) {
        switch (option.modeNext) {
        case 1:
            // get sha
            local.githubCrudAjax({
                httpRequest: option.httpRequest,
                url: option.url
            }, option.onNext);
            break;
        case 2:
            // delete file with sha
            if (!error && data.sha) {
                local.githubCrudAjax({
                    httpRequest: option.httpRequest,
                    message: option.message,
                    method: "DELETE",
                    sha: data.sha,
                    url: option.url
                }, option.onNext);
                return;
            }
            // delete tree
            local.onParallelList({
                list: data
            }, function (option2, onParallel) {
                onParallel.counter += 1;
                // recurse
                local.githubCrudContentDelete({
                    httpRequest: option.httpRequest,
                    message: option.message,
                    url: option2.element.url
                }, onParallel);
            }, option.onNext);
            break;
        default:
            onError(error, data);
        }
    });
    option.modeNext = 0;
    option.onNext();
}

example usage

...
    }
    // delete tree
    local.onParallelList({
        list: data
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        // recurse
        local.githubCrudContentDelete({
            httpRequest: option.httpRequest,
            message: option.message,
            url: option2.element.url
        }, onParallel);
    }, option.onNext);
    break;
default:
...

function github-crud.githubCrudContentGet (option, onError)

description and source-code

githubCrudContentGet = function (option, onError) {
/*
 * this function will get github-file <option>.url
 * https://developer.github.com/v3/repos/contents/#get-contents
 */
    option = {
        httpRequest: option.httpRequest,
        url: option.url
    };
    local.onNext(option, function (error, data) {
        switch (option.modeNext) {
        case 1:
            local.githubCrudAjax({
                httpRequest: option.httpRequest,
                url: option.url
            }, option.onNext);
            break;
        case 2:
            option.onNext(null, Buffer.from(data.content || "", "base64"));
            break;
        default:
            onError(error, !error && data);
        }
    });
    option.modeNext = 0;
    option.onNext();
}

example usage

...
};

local.cliDict.get = function () {
/*
* <fileRemote>
* will get from github <fileRemote>
*/
   local.github_crud.githubCrudContentGet({
       url: process.argv[3]
   }, function (error, data) {
       try {
           process.stdout.write(data);
       } catch (ignore) {}
       process.exit(Boolean(error));
   });
...

function github-crud.githubCrudContentPut (option, onError)

description and source-code

githubCrudContentPut = function (option, onError) {
/*
 * this function will put <option>.content to github-file <option>.url
 * https://developer.github.com/v3/repos/contents/#create-a-file
 * https://developer.github.com/v3/repos/contents/#update-a-file
 */
    option = {
        content: option.content,
        httpRequest: option.httpRequest,
        message: option.message,
        modeErrorIgnore: true,
        url: option.url
    };
    local.onNext(option, function (error, data) {
        switch (option.modeNext) {
        case 1:
            // get sha
            local.githubCrudAjax({
                httpRequest: option.httpRequest,
                url: option.url
            }, option.onNext);
            break;
        case 2:
            // put file with sha
            local.githubCrudAjax({
                content: option.content,
                httpRequest: option.httpRequest,
                message: option.message,
                method: "PUT",
                sha: data.sha,
                url: option.url
            }, option.onNext);
            break;
        default:
            onError(error, data);
        }
    });
    option.modeNext = 0;
    option.onNext();
}

example usage

...
        });
        return;
    }
    // get file
    local.fs.readFile(option.file, option.onNext);
    break;
case 2:
    local.githubCrudContentPut({
        content: data,
        httpRequest: option.httpRequest,
        message: option.message,
        // resolve file in url
        url: (
            // ternary-condition
            (
...

function github-crud.githubCrudContentPutFile (option, onError)

description and source-code

githubCrudContentPutFile = function (option, onError) {
/*
 * this function will put option.file to github-file <option>.url
 * https://developer.github.com/v3/repos/contents/#update-a-file
 */
    option = {
        file: option.file,
        httpRequest: option.httpRequest,
        message: option.message,
        url: option.url
    };
    local.onNext(option, function (error, data) {
        switch (option.modeNext) {
        case 1:
            // get file from url
            if ((
                /^(?:http|https):\/\//
            ).test(option.file)) {
                local.ajax({
                    httpRequest: option.httpRequest,
                    url: option.file
                }, function (error, response) {
                    option.onNext(error, response && response.data);
                });
                return;
            }
            // get file
            local.fs.readFile(option.file, option.onNext);
            break;
        case 2:
            local.githubCrudContentPut({
                content: data,
                httpRequest: option.httpRequest,
                message: option.message,
                // resolve file in url
                url: (
                    // ternary-condition
                    (
                        /\/$/
                    ).test(option.url)
                    ? option.url + local.path.basename(option.file)
                    : option.url
                )
            }, option.onNext);
            break;
        default:
            onError(error, data);
        }
    });
    option.modeNext = 0;
    option.onNext();
}

example usage

...
};

local.cliDict.put = function () {
/*
 * <fileRemote> <fileLocal> <commitMessage>
 * will put on github <fileRemote> to <fileLocal>
 */
    local.github_crud.githubCrudContentPutFile({
        message: process.argv[5],
        url: process.argv[3],
        file: process.argv[4]
    }, function (error) {
        process.exit(Boolean(error));
    });
};
...

function github-crud.githubCrudContentTouch (option, onError)

description and source-code

githubCrudContentTouch = function (option, onError) {
/*
 * this function will touch github-file <option>.url
 * https://developer.github.com/v3/repos/contents/#update-a-file
 */
    option = {
        httpRequest: option.httpRequest,
        message: option.message,
        modeErrorIgnore: true,
        url: option.url
    };
    local.onNext(option, function (error, data) {
        switch (option.modeNext) {
        case 1:
            // get sha
            local.githubCrudAjax({
                httpRequest: option.httpRequest,
                url: option.url
            }, option.onNext);
            break;
        case 2:
            // put file with sha
            local.githubCrudAjax({
                content: Buffer.from(data.content || "", "base64"),
                httpRequest: option.httpRequest,
                message: option.message,
                method: "PUT",
                sha: data.sha,
                url: option.url
            }, option.onNext);
            break;
        default:
            onError(error, data);
        }
    });
    option.modeNext = 0;
    option.onNext();
}

example usage

...
 * this function will touch github-files <option>.urlList in parallel
 * https://developer.github.com/v3/repos/contents/#update-a-file
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudContentTouch({
            httpRequest: option.httpRequest,
            message: option.message,
            url: option2.element
        }, onParallel);
    }, onError);
};
...

function github-crud.githubCrudContentTouchList (option, onError)

description and source-code

githubCrudContentTouchList = function (option, onError) {
/*
 * this function will touch github-files <option>.urlList in parallel
 * https://developer.github.com/v3/repos/contents/#update-a-file
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudContentTouch({
            httpRequest: option.httpRequest,
            message: option.message,
            url: option2.element
        }, onParallel);
    }, onError);
}

example usage

...
};

local.cliDict.touch = function () {
/*
* <fileRemoteList> <commitMessage>
* will touch on github in parallel, comma-separated <fileRemoteList>
*/
   local.github_crud.githubCrudContentTouchList({
       message: process.argv[4],
       urlList: process.argv[3].split(
           /[,\s]/g
       ).filter(local.identity)
   }, function (error) {
       process.exit(Boolean(error));
   });
...

function github-crud.githubCrudRepoCreate (option, onError)

description and source-code

githubCrudRepoCreate = function (option, onError) {
/*
 * this function will create github-repo <option>.url
 * https://developer.github.com/v3/repos/#create
 */
    local.githubCrudAjax({
        httpRequest: option.httpRequest,
        method: "POST_ORG",
        url: option.url
    }, function (error, data) {
        if (!(error && error.statusCode === 404)) {
            onError(error, data);
            return;
        }
        local.githubCrudAjax({
            httpRequest: option.httpRequest,
            method: "POST_USER",
            url: option.url
        }, onError);
    });
}

example usage

...
 * this function will create github-repos <option>.urlList in parallel
 * https://developer.github.com/v3/repos/#create
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudRepoCreate({
            httpRequest: option.httpRequest,
            url: option2.element
        }, onParallel);
    }, onError);
};

local.githubCrudRepoDelete = function (option, onError) {
...

function github-crud.githubCrudRepoCreateList (option, onError)

description and source-code

githubCrudRepoCreateList = function (option, onError) {
/*
 * this function will create github-repos <option>.urlList in parallel
 * https://developer.github.com/v3/repos/#create
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudRepoCreate({
            httpRequest: option.httpRequest,
            url: option2.element
        }, onParallel);
    }, onError);
}

example usage

...
};

local.cliDict.repo_create = function () {
/*
 * <repoList>
 * will create on github in parallel, comma-separated <repoList>
 */
    local.github_crud.githubCrudRepoCreateList({
        urlList: process.argv[3].split(
            /[,\s]/g
        ).filter(local.identity)
    }, function (error) {
        process.exit(Boolean(error));
    });
};
...

function github-crud.githubCrudRepoDelete (option, onError)

description and source-code

githubCrudRepoDelete = function (option, onError) {
/*
 * this function will delete github-repo <option>.url
 * https://developer.github.com/v3/repos/#delete-a-repository
 */
    local.githubCrudAjax({
        httpRequest: option.httpRequest,
        method: "DELETE",
        url: option.url
    }, onError);
}

example usage

...
 * this function will delete github-repos <option>.urlList in parallel
 * https://developer.github.com/v3/repos/#delete-a-repository
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudRepoDelete({
            httpRequest: option.httpRequest,
            url: option2.element
        }, onParallel);
    }, onError);
};
}());
...

function github-crud.githubCrudRepoDeleteList (option, onError)

description and source-code

githubCrudRepoDeleteList = function (option, onError) {
/*
 * this function will delete github-repos <option>.urlList in parallel
 * https://developer.github.com/v3/repos/#delete-a-repository
 */
    local.onParallelList({
        list: option.urlList
    }, function (option2, onParallel) {
        onParallel.counter += 1;
        local.githubCrudRepoDelete({
            httpRequest: option.httpRequest,
            url: option2.element
        }, onParallel);
    }, onError);
}

example usage

...
};

local.cliDict.repo_delete = function () {
/*
 * <repoList>
 * will delete from github in parallel, comma-separated <repoList>
 */
    local.github_crud.githubCrudRepoDeleteList({
        urlList: process.argv[3].split(
            /[,\s]/g
        ).filter(local.identity)
    }, function (error) {
        process.exit(Boolean(error));
    });
};
...

function github-crud.identity (value)

description and source-code

identity = function (value) {
/*
 * this function will return <value>
 */
    return value;
}

example usage

...
    local.isBrowser
    && !option.httpRequest
    && !(local2.serverLocalUrlTest && local2.serverLocalUrlTest(option.url))
    && new XMLHttpRequest()
);
// init xhr - http.request
if (!xhr) {
    xhr = local.identity(local2.urlParse || require("url").parse)(
        option.url
    );
    // init xhr
    xhrInit();
    // init xhr - http.request
    xhr = local.identity(
        option.httpRequest
...

function github-crud.nop ()

description and source-code

nop = function () {
/*
 * this function will do nothing
 */
    return;
}

example usage
```
n/a
```

function github-crud.objectAssignDefault (target, source)

description and source-code

objectAssignDefault = function (target, source) {
/*
 * this function will if items from <target> are
 * null, undefined, or empty-string,
 * then overwrite them with items from <source>
 */
    Object.keys(source).forEach(function (key) {
        if (
            target[key] === null
            || target[key] === undefined
            || target[key] === ""
        ) {
            target[key] = target[key] || source[key];
        }
    });
    return target;
}

example usage

...
    if (key[0] !== "_") {
        xhr[key] = option[key];
    }
});
// init timeout
timeout = xhr.timeout || local2.timeoutDefault || 30000;
// init defaults
local.objectAssignDefault(xhr, {
    corsForwardProxyHost: local2.corsForwardProxyHost,
    headers: {},
    location: (local.isBrowser && location) || {},
    method: "GET",
    responseType: ""
});
// init headers
...

function github-crud.onErrorDefault (error)

description and source-code

onErrorDefault = function (error) {
/*
 * this function will if <error> exists, then print it to stderr
 */
    if (error) {
        console.error(error);
    }
    return error;
}

example usage

...
            list: option.list,
            retry: 0
        }, onParallel);
    }
};
onParallel = local.onParallel(onError, onEach2, function (error, data) {
    if (error && data && data.retry < option.retryLimit) {
        local.onErrorDefault(error);
        data.retry += 1;
        setTimeout(function () {
            onParallel.counter -= 1;
            onEach(data, onParallel);
        }, 1000);
        return true;
    }
...

function github-crud.onErrorWithStack (onError)

description and source-code

onErrorWithStack = function (onError) {
/*
 * this function will create a new callback that will call onError,
 * and append the current stack to any error
 */
    var onError2;
    var stack;
    stack = new Error().stack.replace((
        /(.*?)\n.*?$/m
    ), "$1");
    onError2 = function (error, data, meta) {
        if (
            error
            && typeof error.stack === "string"
            && error !== local.errorDefault
            && String(error.stack).indexOf(stack.split("\n")[2]) < 0
        ) {
            // append the current stack to error.stack
            error.stack += "\n" + stack;
        }
        onError(error, data, meta);
    };
    // debug onError
    onError2.toString = function () {
        return String(onError);
    };
    return onError2;
}

example usage

...
    local2._debugXhr = xhr;
    xhr.onEvent = onEvent;
    xhr.responseHeaders = {};
    xhr.timeStart = xhr.timeStart || Date.now();
};
// init onError
if (local2.onErrorWithStack) {
    onError = local2.onErrorWithStack(onError);
}
// init xhr - XMLHttpRequest
xhr = (
    local.isBrowser
    && !option.httpRequest
    && !(local2.serverLocalUrlTest && local2.serverLocalUrlTest(option.url))
    && new XMLHttpRequest()
...

function github-crud.onNext (option, onError)

description and source-code

onNext = function (option, onError) {
/*
 * this function will wrap onError inside recursive-function <option>.onNext,
 * and append the current stack to any error
 */
    option.onNext = local.onErrorWithStack(function (error, data, meta) {
        try {
            option.modeNext += (
                (error && !option.modeErrorIgnore)
                ? 1000
                : 1
            );
            if (option.modeDebug) {
                console.error("onNext - " + JSON.stringify({
                    modeNext: option.modeNext,
                    errorMessage: error && error.message
                }));
                if (error && error.stack) {
                    console.error(error.stack);
                }
            }
            onError(error, data, meta);
        } catch (errorCaught) {
            // throw errorCaught to break infinite recursion-loop
            if (option.errorCaught) {
                local.assertThrow(null, option.errorCaught);
            }
            option.errorCaught = errorCaught;
            option.onNext(errorCaught, data, meta);
        }
    });
    return option;
}

example usage

...
            onError(error, data, meta);
        } catch (errorCaught) {
            // throw errorCaught to break infinite recursion-loop
            if (option.errorCaught) {
                local.assertThrow(null, option.errorCaught);
            }
            option.errorCaught = errorCaught;
            option.onNext(errorCaught, data, meta);
        }
    });
    return option;
};

local.onParallel = function (onError, onEach, onRetry) {
/*
...

function github-crud.onParallel (onError, onEach, onRetry)

description and source-code

onParallel = function (onError, onEach, onRetry) {
/*
 * this function will create a function that will
 * 1. run async tasks in parallel
 * 2. if counter === 0 or error occurred, then call onError with error
 */
    var onParallel;
    onError = local.onErrorWithStack(onError);
    onEach = onEach || local.nop;
    onRetry = onRetry || local.nop;
    onParallel = function (error, data) {
        if (onRetry(error, data)) {
            return;
        }
        // decrement counter
        onParallel.counter -= 1;
        // validate counter
        if (!(onParallel.counter >= 0 || error || onParallel.error)) {
            error = new Error(
                "invalid onParallel.counter = " + onParallel.counter
            );
        // ensure onError is run only once
        } else if (onParallel.counter < 0) {
            return;
        }
        // handle error
        if (error) {
            onParallel.error = error;
            // ensure counter <= 0
            onParallel.counter = -Math.abs(onParallel.counter);
        }
        // call onError when isDone
        if (onParallel.counter <= 0) {
            onError(error, data);
            return;
        }
        onEach();
    };
    // init counter
    onParallel.counter = 0;
    // return callback
    return onParallel;
}

example usage

...
            element: option.list[onParallel.ii],
            ii: onParallel.ii,
            list: option.list,
            retry: 0
        }, onParallel);
    }
};
onParallel = local.onParallel(onError, onEach2, function (error, data) {
    if (error && data && data.retry < option.retryLimit) {
        local.onErrorDefault(error);
        data.retry += 1;
        setTimeout(function () {
            onParallel.counter -= 1;
            onEach(data, onParallel);
        }, 1000);
...

function github-crud.onParallelList (option, onEach, onError)

description and source-code

onParallelList = function (option, onEach, onError) {
/*
 * this function will
 * 1. async-run onEach in parallel,
 *    with given option.rateLimit and option.retryLimit
 * 2. call onError when onParallel.ii + 1 === option.list.length
 */
    var isListEnd;
    var onEach2;
    var onParallel;
    option.list = option.list || [];
    onEach2 = function () {
        while (true) {
            if (!(onParallel.ii + 1 < option.list.length)) {
                isListEnd = true;
                return;
            }
            if (!(onParallel.counter < option.rateLimit + 1)) {
                return;
            }
            onParallel.ii += 1;
            onEach({
                element: option.list[onParallel.ii],
                ii: onParallel.ii,
                list: option.list,
                retry: 0
            }, onParallel);
        }
    };
    onParallel = local.onParallel(onError, onEach2, function (error, data) {
        if (error && data && data.retry < option.retryLimit) {
            local.onErrorDefault(error);
            data.retry += 1;
            setTimeout(function () {
                onParallel.counter -= 1;
                onEach(data, onParallel);
            }, 1000);
            return true;
        }
        // restart if option.list has grown
        if (isListEnd && (onParallel.ii + 1 < option.list.length)) {
            isListEnd = null;
            onEach2();
        }
    });
    onParallel.ii = -1;
    option.rateLimit = Number(option.rateLimit) || 6;
    option.rateLimit = Math.max(option.rateLimit, 1);
    option.retryLimit = Number(option.retryLimit) || 2;
    onParallel.counter += 1;
    onEach2();
    onParallel();
}

example usage

...
        method: "DELETE",
        sha: data.sha,
        url: option.url
    }, option.onNext);
    return;
}
// delete tree
local.onParallelList({
    list: data
}, function (option2, onParallel) {
    onParallel.counter += 1;
    // recurse
    local.githubCrudContentDelete({
        httpRequest: option.httpRequest,
        message: option.message,
...

module github-crud.cliDict

function github-crud.cliDict.delete ()

description and source-code

delete = function () {
/*
 * <fileRemote|dirRemote> <commitMessage>
 * will delete from github <fileRemote|dirRemote>
 */
    local.github_crud.githubCrudContentDelete({
        message: process.argv[4],
        url: process.argv[3]
    }, function (error) {
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

function github-crud.cliDict.get ()

description and source-code

get = function () {
/*
 * <fileRemote>
 * will get from github <fileRemote>
 */
    local.github_crud.githubCrudContentGet({
        url: process.argv[3]
    }, function (error, data) {
        try {
            process.stdout.write(data);
        } catch (ignore) {}
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

function github-crud.cliDict.put ()

description and source-code

put = function () {
/*
 * <fileRemote> <fileLocal> <commitMessage>
 * will put on github <fileRemote> to <fileLocal>
 */
    local.github_crud.githubCrudContentPutFile({
        message: process.argv[5],
        url: process.argv[3],
        file: process.argv[4]
    }, function (error) {
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

function github-crud.cliDict.repo_create ()

description and source-code

repo_create = function () {
/*
 * <repoList>
 * will create on github in parallel, comma-separated <repoList>
 */
    local.github_crud.githubCrudRepoCreateList({
        urlList: process.argv[3].split(
            /[,\s]/g
        ).filter(local.identity)
    }, function (error) {
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

function github-crud.cliDict.repo_delete ()

description and source-code

repo_delete = function () {
/*
 * <repoList>
 * will delete from github in parallel, comma-separated <repoList>
 */
    local.github_crud.githubCrudRepoDeleteList({
        urlList: process.argv[3].split(
            /[,\s]/g
        ).filter(local.identity)
    }, function (error) {
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

function github-crud.cliDict.touch ()

description and source-code

touch = function () {
/*
 * <fileRemoteList> <commitMessage>
 * will touch on github in parallel, comma-separated <fileRemoteList>
 */
    local.github_crud.githubCrudContentTouchList({
        message: process.argv[4],
        urlList: process.argv[3].split(
            /[,\s]/g
        ).filter(local.identity)
    }, function (error) {
        process.exit(Boolean(error));
    });
}

example usage
```
n/a
```

[ this document was created with utility2 ]

api documentation for github-crud (2019.1.21)

this zero-dependency package will provide a simple cli-tool to PUT / GET / DELETE github files

table of contents