readme.md document generator All In One

readme.md document generator All In One

docs

documentation

$ npm i -D documentation

markdown

var documentation = require('documentation');
var fs = require('fs');

documentation.build(['index.js'])
  .then(documentation.formats.md)
  .then(output => {
    // output is a string of Markdown data
    fs.writeFileSync('./output.md', output);
  });

https://www.npmjs.com/package/documentation

https://github.com/documentationjs/documentation

https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md#formatsmarkdown

demo

import { Base64 } from "./base64";
class ZxmSpm {
  constructor() {
    this.env = "dev";
    this.baseUrl = "https://p.abczzz.cn/spm/spm";
  }

  setEnv(env) {
    this.env = env;
  }

  /**
   * 设置打点服务器Url
   * @param {String} url
   */
  setUrl(url) {
    this.baseUrl = url;
  }

  test() {
    console.log("test1 111");
  }

  guid2() {
    var s = [];
    var hexDigits = "0123456789abcdef";
    for (var i = 0; i < 36; i++) {
      s[i] = hexDigits.substr(Math.floor(Math.random() * 0x10), 1);
    }
    s[14] = "4";
    s[19] = hexDigits.substr((s[19] & 0x3) | 0x8, 1);
    s[8] = s[13] = s[18] = s[23] = "-";
    var uuid = s.join("");
    return uuid;
  }
  getUUID() {
    var uuid = "";
    if (this.isBorwer()) {
      uuid = localStorage.getItem("zxm_spm_uuid");
    } else if (this.isWinXinXcx()) {
      uuid = wx.getStorageSync("zxm_spm_uuid");
    } else if (this.isAliPayXcx()) {
      uuid = my.getStorageSync("zxm_spm_uuid");
    }
    if (!uuid) {
      uuid = this.guid2();
      if (this.isBorwer()) {
        localStorage.setItem("zxm_spm_uuid", uuid);
      } else if (this.isWinXinXcx()) {
        wx.setStorageSync("zxm_spm_uuid", uuid);
      } else if (this.isAliPayXcx()) {
        my.setStorageSync("zxm_spm_uuid", uuid);
      }
    }
    return uuid;
  }
  encodeParams(type, spm, log_data) {
    var spmData = Object.assign(
      {
        spm: "",
        uuid: this.getUUID(),
        type: "spm",
        page: this.getHref(),
        log_time: new Date().getTime(),
        log_data: JSON.stringify({}),
      },
      {
        spm: spm,
        type: type,
        log_data: JSON.stringify(log_data),
      }
    );
    var params = Base64.encode(encodeURIComponent(JSON.stringify(spmData)))
      .split("")
      .reverse()
      .join("");
    if (this.env === "dev") {
      console.log("打点数据", JSON.stringify(spmData, null, 1));
      // console.log("编码后参数", params);
    }
    return params;
  }

  isWinXinXcx() {
    let flag = false;
    try {
      if (wx && wx.request) {
        flag = true;
      }
    } catch (error) {}
    return flag;
  }

  isAliPayXcx() {
    let flag = false;
    try {
      if (my && my.request) {
        flag = true;
      }
    } catch (error) {}
    return flag;
  }

  isBorwer() {
    let flag = false;
    if (
      typeof XMLHttpRequest != "undefined" &&
      Object.prototype.toString.call(XMLHttpRequest) == "[object Function]"
    ) {
      flag = true;
    }
    return flag;
  }

  isNode() {
    let flag = false;
    if (
      typeof process != "undefined" &&
      Object.prototype.toString.call(process) === "[object process]"
    ) {
      flag = true;
    }
    return flag;
  }

  getHref() {
    let txt = "";
    if (this.isBorwer()) {
      txt = window.location.href;
    } else if (this.isWinXinXcx()) {
      let pages = getCurrentPages();
      let curPage = pages[pages.length - 1];
      let page = curPage.route;
      txt = page;
    } else if (this.isAliPayXcx()) {
      let pages = getCurrentPages();
      let curPage = pages[pages.length - 1];
      let page = curPage.route;
      txt = page;
    } else {
      txt = "";
    }
    return txt;
  }

  sendSpmAliPay(params) {
    var url = this.baseUrl;
    my.request({
      url: url,
      method: "POST",
      data: { p: params },
      header: {
        "content-type": "application/json;charset=UTF-8",
      },
    });
  }

  sendSpmWeixin(params) {
    var url = this.baseUrl;
    wx.request({
      url: url,
      method: "POST",
      data: { p: params },
      header: {
        "content-type": "application/json;charset=UTF-8",
      },
    });
  }

  sendSpmBrower(params) {
    var tmpBlob = new Blob([params]);
    if (tmpBlob.size <= 4096) {
      var url = this.baseUrl + "?p=" + params;
      var img = document.createElement("img");
      img.style.display = "none";
      img.src = url;
      document.body.appendChild(img);
      document.body.removeChild(img);
    } else {
      var xhr = new XMLHttpRequest();
      xhr.open("POST", this.baseUrl);
      xhr.setRequestHeader("Content-type", "application/json");
      xhr.send(
        JSON.stringify({
          p: params,
        })
      );
    }
  }

  sendSpm(params) {
    setTimeout(() => {
      if (this.isBorwer()) {
        this.sendSpmBrower(params);
      } else if (this.isWinXinXcx()) {
        this.sendSpmWeixin(params);
      } else if (this.isAliPayXcx()) {
        this.sendSpmAliPay(params);
      } else {
        console.log("未知环境");
      }
    }, 0);
  }

  /**
   * 打点 (通用类型)
   * @param {String} spm 打点 A.B.C.D.E 域
   * @param {Object} log_data 打点附带数据
   * @param {String} type 打点类型(可选，默认spm) spm / log / err
   * @example
   * ZxmSpm.spm("xxx.xxx.xxx.xxx.xxx", { test1: "1", test2: "2"}, "spm")
   */
  spm(spm, log_data, type) {
    if (!spm) return;
    if (spm.split(".").lengtn == 1) return;
    var typeArr = ["spm", "log", "err"];
    var params = this.encodeParams(
      typeArr.indexOf(type) != -1 ? type : "spm",
      spm,
      log_data
    );
    this.sendSpm(params);
  }

  /**
   * 打点（错误类型）
   * @param {String} spm 打点 A.B.C.D.E 域
   * @param {Object} log_data 打点附带数据
   * @example
   * ZxmSpm.spmErr("xxx.xxx.xxx.xxx.xxx", { test1: "1", test2: "2"})
   */
  spmErr(spm, log_data) {
    if (!spm) return;
    if (spm.split(".").lengtn == 1) return;
    var params = this.encodeParams("err", spm, log_data);
    this.sendSpm(params);
  }

  /**
   * 打点（日志类型）
   * @param {String} spm 打点 A.B.C.D.E 域
   * @param {Object} log_data 打点附带数据
   * @example
   * ZxmSpm.spmLog("xxx.xxx.xxx.xxx.xxx", { test1: "1", test2: "2"})
   */
  spmLog(spm, log_data) {
    if (!spm) return;
    if (spm.split(".").lengtn == 1) return;
    var params = this.encodeParams("log", spm, log_data);
    this.sendSpm(params);
  }
}

export default new ZxmSpm();

https://github.com/zhoujie16/zxm_spm/blob/master/autoDoc.js

export const Base64 = {
  _keyStr: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",
  encode: function (input) {
    var output = "";
    var chr1, chr2, chr3, enc1, enc2, enc3, enc4;
    var i = 0;
    input = Base64._utf8_encode(input);
    while (i < input.length) {
      chr1 = input.charCodeAt(i++);
      chr2 = input.charCodeAt(i++);
      chr3 = input.charCodeAt(i++);
      enc1 = chr1 >> 2;
      enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
      enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
      enc4 = chr3 & 63;
      if (isNaN(chr2)) {
        enc3 = enc4 = 64;
      } else if (isNaN(chr3)) {
        enc4 = 64;
      }
      output =
        output +
        this._keyStr.charAt(enc1) +
        this._keyStr.charAt(enc2) +
        this._keyStr.charAt(enc3) +
        this._keyStr.charAt(enc4);
    }
    return output;
  },
  _utf8_encode: function (string) {
    string = string.replace(/\r\n/g, "\n");
    var utftext = "";
    for (var n = 0; n < string.length; n++) {
      var c = string.charCodeAt(n);
      if (c < 128) {
        utftext += String.fromCharCode(c);
      } else if (c > 127 && c < 2048) {
        utftext += String.fromCharCode((c >> 6) | 192);
        utftext += String.fromCharCode((c & 63) | 128);
      } else {
        utftext += String.fromCharCode((c >> 12) | 224);
        utftext += String.fromCharCode(((c >> 6) & 63) | 128);
        utftext += String.fromCharCode((c & 63) | 128);
      }
    }
    return utftext;
  },
};

https://github.com/zhoujie16/zxm_spm/blob/master/src/base64.js

https://github.com/zhoujie16/zxm_spm/blob/master/package.json

https://github.com/zhoujie16/zxm_spm/blob/master/rollup.config.js

refs

---

---

©xgqfrms 2012-2020

www.cnblogs.com/xgqfrms 发布文章使用：只允许注册用户才可以访问！

原创文章，版权所有©️xgqfrms, 禁止转载 ️，侵权必究⚠️！

---