@mintlify/cli 3.0.0

package/.eslintcache

@@ -0,0 +1 @@
+[{"/Users/bshen/mintlify/mint/packages/mintlify-cli/src/index.ts":"1"},{"size":813,"mtime":1676618123558,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"16pu3nx","/Users/bshen/mintlify/mint/packages/mintlify-cli/src/index.ts",[],["7","8"],{"ruleId":"9","severity":2,"message":"10","line":12,"column":11,"nodeType":"11","messageId":"12","endLine":12,"endColumn":13,"suppressions":"13"},{"ruleId":"9","severity":2,"message":"10","line":20,"column":11,"nodeType":"11","messageId":"12","endLine":20,"endColumn":13,"suppressions":"14"},"@typescript-eslint/no-empty-function","Unexpected empty arrow function.","ArrowFunctionExpression","unexpected",["15"],["16"],{"kind":"17","justification":"18"},{"kind":"17","justification":"18"},"directive",""]

package/.eslintignore

@@ -0,0 +1 @@
+bin/

package/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@mintlify/eslint-config-typescript"
+}

package/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Running CLI Locally
+
+Note - contributing requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
+
+Run `npm run local` to build and install the CLI locally.
+
+You need to run the command after every change you want to test.
+
+## Updating Version of Mint Client
+
+The CLI uses GitHub releases to download specific versions of the client code used in `mintlify dev`. Older CLI versions will continue using the client code they were bundled with. Users need to update to a newer version of the CLI to get the newest client code. CLI contributors bump the client version used by the CLI whenever there are major changes.
+
+Here's how to publish new client changes to the CLI:
+
+1. Publish a new GitHub release. You can click the releases menu at the right of the repo page. Make the release title the same as the new release tag. Optionally, you can also use the description to keep track of what changed in that release.
+2. Set `TARGET_MINT_VERSION` in `src/constants.ts` to to the new release tag.
+3. Publish a new CLI version to npm.

package/README.md

@@ -0,0 +1,78 @@
+<div align="center">
+  <a href="https://mintlify.com">
+    <img
+      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
+      alt="Mintlify Logo"
+      height="64"
+    />
+  </a>
+  <br />
+  <p>
+    <h3>
+      <b>
+        Mintlify CLI
+      </b>
+    </h3>
+  </p>
+  <p>
+    The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
+  </p>
+  <p>
+
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Unit Tests](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)
+
+  </p>
+  <p>
+    <sub>
+      Built with ❤︎ by
+      <a href="https://mintlify.com">
+        Mintlify
+      </a>
+    </sub>
+  </p>
+</div>
+
+### 🚀 Installation
+
+Download the Mintlify CLI using the following command
+
+```
+npm i -g mintlify
+```
+
+### 👩‍💻 Development
+
+Run the following command at the root of your Mintlify application to preview changes locally.
+
+```
+mintlify dev
+```
+
+Note - `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
+
+### Custom Ports
+
+Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
+
+```
+mintlify dev --port 3333
+```
+
+You will see an error like this if you try to run Mintlify in a port that's already taken:
+
+```
+Error: listen EADDRINUSE: address already in use :::3000
+```
+
+#### Troubleshooting
+
+Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
+
+- Make sure you are running in a folder with a `mint.json` file.
+- Make sure you are using Node v18 or higher.
+- Run `mintlify install` to re-install dependencies.
+- Navigate to the `.mintlify` folder in your home directory and delete its contents.
+
+### 🏃 Get Started
+
+[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.

package/bin/index.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-empty-function */
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { dev, installDepsCommand } from "@mintlify/previewing";
+yargs(hideBin(process.argv))
+    .command("dev", "Runs Mintlify locally (Must run in directory with mint.json)", () => { }, async (argv) => {
+    await dev(argv);
+})
+    .command("install", "Install dependencies for local Mintlify", () => { }, installDepsCommand)
+    // Print the help menu when the user enters an invalid command.
+    .strictCommands()
+    .demandCommand(1, "Unknown command. See above for the list of supported commands.")
+    // Alias option flags --help = -h, --version = -v
+    .alias("h", "help")
+    .alias("v", "version")
+    .parse();
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,yDAAyD;AAEzD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,GAAG,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,KAAK,EACL,8DAA8D,EAC9D,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC,CACF;KACA,OAAO,CACN,SAAS,EACT,yCAAyC,EACzC,GAAG,EAAE,GAAE,CAAC,EACR,kBAAkB,CACnB;IACD,+DAA+D;KAC9D,cAAc,EAAE;KAChB,aAAa,CACZ,CAAC,EACD,gEAAgE,CACjE;IAED,iDAAiD;KAChD,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;KAClB,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC;KAErB,KAAK,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@mintlify/cli",
+  "version": "3.0.0",
+  "description": "The Mintlify CLI",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": "Mintlify, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mintlify/mint",
+    "directory": "packages/mintlify-cli"
+  },
+  "bugs": {
+    "url": "https://github.com/mintlify/mint/issues"
+  },
+  "license": "Elastic-2.0",
+  "keywords": [
+    "mintlify",
+    "mint",
+    "cli"
+  ],
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": "./bin/index.js",
+  "bin": {
+    "mintlify": "bin/index.js"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "lint": "eslint . --cache"
+  },
+  "dependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
+    "@mintlify/previewing": "3.1.0",
+    "@mintlify/validation": "^0.1.9",
+    "@octokit/rest": "^19.0.5",
+    "axios": "^1.2.2",
+    "chalk": "^5.1.0",
+    "cheerio": "^0.22.0",
+    "chokidar": "^3.5.3",
+    "favicons": "^7.0.1",
+    "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",
+    "minimist-lite": "^2.2.1",
+    "node-html-markdown": "^1.3.0",
+    "open": "^8.4.0",
+    "openapi-types": "^12.0.2",
+    "ora": "^6.1.2",
+    "puppeteer": "^19.4.0",
+    "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/cheerio": "^0.22.31",
+    "@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"
+  }
+}

package/src/index.ts

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-empty-function */
+
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { dev, installDepsCommand } from "@mintlify/previewing";
+
+yargs(hideBin(process.argv))
+  .command(
+    "dev",
+    "Runs Mintlify locally (Must run in directory with mint.json)",
+    () => {},
+    async (argv) => {
+      await dev(argv);
+    }
+  )
+  .command(
+    "install",
+    "Install dependencies for local Mintlify",
+    () => {},
+    installDepsCommand
+  )
+  // Print the help menu when the user enters an invalid command.
+  .strictCommands()
+  .demandCommand(
+    1,
+    "Unknown command. See above for the list of supported commands."
+  )
+
+  // Alias option flags --help = -h, --version = -v
+  .alias("h", "help")
+  .alias("v", "version")
+
+  .parse();

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  // "extends": "@mintlify/ts-config",
+  "compilerOptions": {
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "target": "es2020",
+    "lib": ["es2020", "dom", "ES2021.String"],
+    "sourceMap": true,
+    "outDir": "bin",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/*", "src/types/*"]
+    },
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*"]
+}