UNPKG

@alicloud/console-toolkit-plugin-docs

Version:

console toolkit plugin for build docs

165 lines 8.68 kB
"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; var __generator = (this && this.__generator) || function (thisArg, body) { var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; function verb(n) { return function (v) { return step([n, v]); }; } function step(op) { if (f) throw new TypeError("Generator is already executing."); while (_) try { if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; if (y = 0, t) op = [op[0] & 2, t.value]; switch (op[0]) { case 0: case 1: t = op; break; case 4: _.label++; return { value: op[1], done: false }; case 5: _.label++; y = op[1]; op = [0]; continue; case 7: op = _.ops.pop(); _.trys.pop(); continue; default: if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } if (t[2]) _.ops.pop(); _.trys.pop(); continue; } op = body.call(thisArg, _); } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; } }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); var path = __importStar(require("path")); var fs = __importStar(require("fs-extra")); var globby = __importStar(require("globby")); require("dotenv/config"); var console_toolkit_shared_utils_1 = require("@alicloud/console-toolkit-shared-utils"); var docsDev_1 = __importDefault(require("./docsDev")); var docsBuild_1 = __importDefault(require("./docsBuild")); var docsUpload_1 = __importDefault(require("./docsUpload")); exports.default = (function (api, options) { return __awaiter(void 0, void 0, void 0, function () { var env, cwd, baseDir_1, baseDir_2, READMEPath_1, baseDir_3; var _a, _b; return __generator(this, function (_c) { env = (0, console_toolkit_shared_utils_1.getEnv)(); cwd = (_a = env.workingDir) !== null && _a !== void 0 ? _a : process.cwd(); if (env.isCloudBuild() && env.buildDestDir) { options.output = env.buildDestDir; } else { options.output = (_b = options.output) !== null && _b !== void 0 ? _b : 'doc-dist'; } if (!options.getDemos) { baseDir_1 = path.resolve(cwd, 'demos'); // 默认从demos目录查找demo if (fs.existsSync(baseDir_1)) { options.getDemos = function () { var paths = globby.sync('**/*.demo.tsx', { cwd: baseDir_1 }); return paths.map(function (relativePath) { // const fileName = path.basename(relativePath) var demoName = relativePath.replace(/\.demo\.tsx?$/, ''); // 对于每个demo,要返回demo key和demo路径 return { key: demoName, path: path.resolve(baseDir_1, relativePath), }; }); }; } } if (!options.getMarkdownEntries) { baseDir_2 = path.resolve(cwd, 'docs'); READMEPath_1 = path.resolve(cwd, 'README.md'); options.getMarkdownEntries = function () { var result = []; if (fs.existsSync(READMEPath_1)) { result.push({ key: 'README', path: READMEPath_1, }); } if (fs.existsSync(baseDir_2)) { var paths = globby.sync('**/*.doc.md?(x)', { cwd: baseDir_2 }); result.push.apply(result, paths.map(function (relativePath) { // const fileName = path.basename(relativePath) var docName = relativePath.replace(/\.doc\.mdx?$/, ''); // 对于每个doc,要返回key和路径 return { key: "docs/".concat(docName), path: path.resolve(baseDir_2, relativePath), }; })); } return result; }; } if (!options.getTypeInfoEntries) { baseDir_3 = path.resolve(cwd, 'src/types'); if (fs.existsSync(baseDir_3)) { options.getTypeInfoEntries = function () { var paths = globby.sync('**/*.type.ts?(x)', { cwd: baseDir_3 }); return paths.map(function (relativePath) { var typeName = relativePath.replace(/\.type\.tsx?$/, ''); return { key: "types/".concat(typeName), path: path.resolve(baseDir_3, relativePath), }; }); }; } } options.consoleOSId = options.consoleOSId || 'console-os-demos'; if (options.consoleOSId.includes('/') || options.consoleOSId.includes('\\')) throw new Error("consoleOSId \u4E0D\u80FD\u5305\u542B'/'\u548C'\\'\u7B26\u53F7\uFF0C\u60A8\u53EF\u4EE5\u7528'-'\u6216'_'\u6765\u4EE3\u66FF"); api.registerCommand('docs-dev', { description: 'generate locally developed online documentation', usage: 'docs:dev [options]', options: {}, }, function (commandInfo) { return (0, docsDev_1.default)(commandInfo, cwd, options); }); api.registerCommand('docs-build', { description: 'building online documentation', usage: 'docs:build [options]', options: {}, }, function (commandInfo) { return (0, docsBuild_1.default)(commandInfo, cwd, options); }); api.registerCommand('docs-upload', { description: 'upload locally built online document files', usage: 'docs:upload [options]', options: {}, }, function (commandInfo) { return (0, docsUpload_1.default)(commandInfo, api, cwd, options); }); return [2 /*return*/]; }); }); }); //# sourceMappingURL=index.js.map