@docsalot/previewing 0.1.0-beta.0

package/dist/util.js

@@ -0,0 +1,92 @@
+import Ora from "ora";
+import shell from "shelljs";
+export const MintConfig = (name, color, ctaName, ctaUrl, filename) => {
+    return {
+        name,
+        logo: "",
+        favicon: "",
+        colors: {
+            primary: color,
+        },
+        topbarLinks: [],
+        topbarCtaButton: {
+            name: ctaName,
+            url: ctaUrl,
+        },
+        anchors: [],
+        navigation: [
+            {
+                group: "Home",
+                pages: [filename],
+            },
+        ],
+        // footerSocials: {}, // support object type for footer tyoes
+    };
+};
+export const Page = (title, description, markdown) => {
+    // If we are an empty String we want to add two quotes,
+    // if we added as we went we would detect the first quote
+    // as the closing quote.
+    const startsWithQuote = title.startsWith('"');
+    const endsWithQuote = title.startsWith('"');
+    if (!startsWithQuote) {
+        title = '"' + title;
+    }
+    if (!endsWithQuote) {
+        title = title + '"';
+    }
+    const optionalDescription = description
+        ? `\ndescription: "${description}"`
+        : "";
+    return `---\ntitle: ${title}${optionalDescription}\n---\n\n${markdown}`;
+};
+export function getOrigin(url) {
+    // eg. https://google.com -> https://google.com
+    // https://google.com/page -> https://google.com
+    return new URL(url).origin;
+}
+export function objToReadableString(objs) {
+    // Two spaces as indentation
+    return objs.map((obj) => JSON.stringify(obj, null, 2)).join(",\n");
+}
+export const toFilename = (title) => {
+    // Gets rid of special characters at the start and end
+    // of the name by converting to spaces then using trim.
+    return title
+        .replace(/[^a-z0-9]/gi, " ")
+        .trim()
+        .replace(/ /g, "-")
+        .toLowerCase();
+};
+export const addMdx = (fileName) => {
+    if (fileName.endsWith(".mdx")) {
+        return fileName;
+    }
+    return fileName + ".mdx";
+};
+export const buildLogger = (startText = "") => {
+    const logger = Ora().start(startText);
+    return logger;
+};
+export const getFileExtension = (filename) => {
+    const ext = filename.substring(filename.lastIndexOf(".") + 1, filename.length);
+    if (filename === ext)
+        return undefined;
+    return ext;
+};
+export const fileBelongsInPagesFolder = (filename) => {
+    const extension = getFileExtension(filename);
+    return (extension &&
+        (extension === "mdx" || extension === "md" || extension === "tsx"));
+};
+export const ensureYarn = (logger) => {
+    const yarnInstalled = shell.which("yarn");
+    if (!yarnInstalled) {
+        logger.fail(`yarn must be installed, run
+
+    npm install --global yarn
+
+    `);
+        process.exit(1);
+    }
+};

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@docsalot/previewing",
+  "version": "0.1.0-beta.0",
+  "description": "Preview DocsALot docs locally",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": "SlashML Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/slashml/docsalot",
+    "directory": "packages/docsalot-previewing"
+  },
+  "bugs": {
+    "url": "https://github.com/slashml/docsalot/issues"
+  },
+  "license": "Elastic-2.0",
+  "keywords": [
+    "docsalot",
+    "docs",
+    "previewing"
+  ],
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "lint": "eslint . --cache"
+  },
+  "dependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
+    "@docsalot/prebuild": "0.1.0-beta.0",
+    "@docsalot/validation": "0.1.0-beta.0",
+    "@octokit/rest": "^19.0.5",
+    "axios": "^1.2.2",
+    "chalk": "^5.1.0",
+    "chokidar": "^3.5.3",
+    "fs-extra": "^11.1.0",
+    "gray-matter": "^4.0.3",
+    "inquirer": "^9.1.0",
+    "is-absolute-url": "^4.0.1",
+    "is-internet-available": "^3.1.0",
+    "open": "^8.4.0",
+    "openapi-types": "^12.0.2",
+    "ora": "^6.1.2",
+    "remark": "^14.0.2",
+    "remark-frontmatter": "^4.0.1",
+    "remark-gfm": "^3.0.1",
+    "remark-mdx": "^2.2.1",
+    "shelljs": "^0.8.5",
+    "unist-util-visit": "^4.1.1",
+    "yargs": "^17.6.0"
+  },
+  "devDependencies": {
+    "@mintlify/eslint-config": "1.0.3",
+    "@mintlify/eslint-config-typescript": "1.0.7",
+    "@mintlify/ts-config": "1.0.7",
+    "@tsconfig/recommended": "1.x",
+    "@types/fs-extra": "^9.0.13",
+    "@types/inquirer": "^9.0.1",
+    "@types/node": "^18.7.13",
+    "@types/shelljs": "^0.8.11",
+    "@types/yargs": "^17.0.13",
+    "@typescript-eslint/eslint-plugin": "5.x",
+    "@typescript-eslint/parser": "5.x",
+    "eslint": "8.x",
+    "eslint-config-prettier": "8.x",
+    "eslint-plugin-unused-imports": "2.x",
+    "prettier": "2.x",
+    "typescript": "^4.8.2"
+  }
+}