git0 0.2.3 → 0.2.5

package/docs-config/docusaurus.config.ts

@@ -0,0 +1,350 @@
+import type * as Preset from "@docusaurus/preset-classic";
+import type { Config } from "@docusaurus/types";
+import type * as Plugin from "@docusaurus/types/src/plugin";
+import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
+import { type ApiPageMetadata } from "docusaurus-plugin-openapi-docs/lib/types";
+import { type MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
+//OpenAPI integration
+import { createAuthorization } from "docusaurus-plugin-openapi-docs/lib/markdown/createAuthorization";
+import { createCallbacks } from "docusaurus-plugin-openapi-docs/lib/markdown/createCallbacks";
+import { createDeprecationNotice } from "docusaurus-plugin-openapi-docs/lib/markdown/createDeprecationNotice";
+import { createDescription } from "docusaurus-plugin-openapi-docs/lib/markdown/createDescription";
+import { createHeading } from "docusaurus-plugin-openapi-docs/lib/markdown/createHeading";
+import { createMethodEndpoint } from "docusaurus-plugin-openapi-docs/lib/markdown/createMethodEndpoint";
+import { createParamsDetails } from "docusaurus-plugin-openapi-docs/lib/markdown/createParamsDetails";
+import { createRequestBodyDetails } from "docusaurus-plugin-openapi-docs/lib/markdown/createRequestBodyDetails";
+import { createRequestHeader } from "docusaurus-plugin-openapi-docs/lib/markdown/createRequestHeader";
+import { createStatusCodes } from "docusaurus-plugin-openapi-docs/lib/markdown/createStatusCodes";
+import { createVendorExtensions } from "docusaurus-plugin-openapi-docs/lib/markdown/createVendorExtensions";
+import { render } from "docusaurus-plugin-openapi-docs/lib/markdown/utils";
+import customizeDocs from "./config/customize-docs";
+import fs from "fs";
+
+/**
+ * Generate docs from JSDoc comments in files, OpenAPI.yml spec for 
+ * routes, search index of everything, custom pages, sidebar & theme.
+ * 
+ * Files: openapi-docs.yaml, docs-theme.css, plugin-openapi.mustache, 
+ *  plugin-typedoc.js, sidebars.ts, docusaurus.config.ts, typedoc.json, tsconfig.json
+ * 
+ * *Install dependencies*:
+ * bun install -D @docusaurus/core @docusaurus/faster @docusaurus/plugin-google-gtag
+ *  @docusaurus/preset-classic docusaurus-lunr-search docusaurus-plugin-openapi-docs 
+ * docusaurus-plugin-typedoc docusaurus-theme-openapi-docs prism-react-renderer react
+ *  react-dom clsx typedoc typedoc-plugin-markdown typescript
+ * https://github.com/vtempest/ai-research-agent/blob/master/docs/api.mustache
+ * *Add to package.json*:
+ * "docs": "docusaurus serve --dir web-app/static/docs",
+ * "docs:build": "NODE_NO_WARNINGS=1 docusaurus clean-api-docs  all --all-versions ;
+ *  NODE_NO_WARNINGS=1 docusaurus  gen-api-docs all  --all-versions ;
+ *  rm -rf web-app/static/docs;  DOCUSAURUS_IGNORE_SSG_WARNINGS=true docusaurus 
+ *  build --out-dir web-app/static/docs",
+ * 
+ * For homepage Add to docs/functions/index.md
+ * 
+    ---
+    sidebar_position: 1
+    sidebar_label:  Introduction
+    title:  Introduction    
+    slug: /
+    ---
+
+ * @see
+ * [Docusaurus Docs](https://docusaurus.io/docs)
+ * [Typedoc Docs](https://typedoc.org/documents/)
+ * [Typedoc Plugin Docs](https://typedoc-plugin-markdown.org/docs/options)
+ * [OpenAPI Plugin Docs](https://docusaurus-openapi.tryingpan.dev)
+ * @returns {Promise<Config>}
+ * @author [vtempest](https://github.com/vtempest/)
+ */
+export default async function createConfig(options: any = {}) {
+  const {
+    name = "App",
+    domain = "https://example.org",
+    baseFolder = "./",
+    typedocFolders = [],
+    showEditsOnGitHub = true,
+    GOOGLE_ANALYTICS_ID = undefined,
+    compileForSubdomain = !!process.env.DOCS_ON_SUBDOMAIN,
+    tsconfig = "./tsconfig.json",
+    readme = "../readme.md",
+    sanitizeComments = false,
+    favicon = undefined,
+    logo = undefined,
+    logoURL = "/",
+    topbar = [],
+    enableFasterBuildV4 = false,
+    enableReadmeAsHome = true,
+  } = { ...customizeDocs, ...options };
+
+
+  // make sure src folder exists
+  if (!fs.existsSync(baseFolder + "src")) {
+    fs.mkdirSync(baseFolder + "src");
+  }
+
+  //copy readme into ./src
+  if (fs.existsSync(readme) && enableReadmeAsHome) {
+
+
+    var index_frontmatter = '---\nid: index\ntitle: Overview\n' +
+      'sidebar_position: 1\ndisplayed_sidebar: '
+      + 'default' + '\n---\n\n'
+
+    var readmeContent = fs.readFileSync(readme, "utf8")
+    fs.writeFileSync(baseFolder + "src/index.md",
+      index_frontmatter + readmeContent);
+  }
+
+  //prepend to index
+
+
+  // foldersWithFunctions - should also add to tsconfig.json include:[]
+  // compileForSubdomain is used to generate at domain.com/docs 
+  // but on github pages workflow, it outputs to
+  // subdomain like docprojects.user.github.io
+  // sanitizeComments helps avoid errors in markdown like <> {} etc
+  return {
+    future: enableFasterBuildV4 ? {
+      v4: {
+        removeLegacyPostBuildHeadAttribute: true, // REQUIRED for ssgWorkerThreads
+      },
+      experimental_faster: true,
+    } : undefined,
+    title: name + " Docs",
+    url: domain,
+    baseUrl: compileForSubdomain ? "/" : "/docs/",
+    onBrokenLinks: "ignore",
+    onBrokenMarkdownLinks: "ignore",
+    favicon,
+    projectName: name.replaceAll(" ", "-"),
+    presets: [
+      [
+        "classic",
+        {
+          docs: {
+            path: "src",
+            routeBasePath: "/",
+            sidebarPath: "./config/sidebars.ts",
+          },
+          blog: false,
+          theme: {
+            customCss: baseFolder + "config/docs-theme.css",
+          },
+          gtag: {
+            trackingID: GOOGLE_ANALYTICS_ID,
+            anonymizeIP: false,
+          },
+        } satisfies Preset.Options,
+      ],
+    ],
+
+    headTags: [
+      {
+        tagName: 'script',
+        attributes: {
+          src: 'https://cdn.tailwindcss.com',
+        },
+      },
+    ],
+
+    plugins: [
+
+
+      require.resolve("docusaurus-lunr-search"),
+
+      ...(typedocFolders.map(({ id, entryPoints }) => [
+        "docusaurus-plugin-typedoc",
+        {
+          id,
+          entryPoints,
+          exclude: [
+            "**/node_modules/**/*",
+            "pages/**/*"
+          ],
+          tsconfig,
+          out: baseFolder + "src/" + id,
+          readme,
+          disableSources: !showEditsOnGitHub,
+          sidebar: { pretty: true },
+          textContentMappings: {
+            "title.indexPage": name + " API",
+            "title.memberPage": "{name}",
+          },
+          parametersFormat: "htmlTable",
+          indexFormat: "list",
+          expandParameters: true,
+          interfacePropertiesFormat: "htmlTable",
+          propertyMembersFormat: "htmlTable",
+          enumMembersFormat: "htmlTable",
+          typeDeclarationFormat: "htmlTable",
+          typeDeclarationVisibility: "compact",
+          sanitizeComments,
+          useHTMLEncodedBrackets: true,
+          hideBreadcrumbs: false,
+          hideGroupHeadings: true,
+          hidePageHeader: true,
+          hidePageTitle: true,
+          outputFileStrategy: "modules",
+          useCodeBlocks: true,
+        },
+      ]))
+    ],
+
+    themeConfig: {
+      src: {
+        sidebar: {
+          hideable: true,
+        },
+      },
+      navbar: {
+        title: name + " Docs",
+        logo: {
+          alt: "logo",
+          src: logo,
+          href: logoURL || "/",
+        },
+        items: topbar
+      },
+
+      languageTabs: [
+        {
+          highlight: "javascript",
+          language: "nodejs",
+          logoClass: "nodejs",
+        },
+        {
+          highlight: "javascript",
+          language: "javascript",
+          logoClass: "javascript",
+        },
+        {
+          highlight: "python",
+          language: "python",
+          logoClass: "python",
+        },
+        {
+          highlight: "bash",
+          language: "curl",
+          logoClass: "curl",
+        },
+        {
+          highlight: "powershell",
+          language: "powershell",
+          logoClass: "powershell",
+        },
+
+        {
+          highlight: "rust",
+          language: "rust",
+          logoClass: "rust",
+        },
+        {
+          highlight: "c",
+          language: "c",
+          logoClass: "c",
+        },
+        {
+          highlight: "swift",
+          language: "swift",
+          logoClass: "swift",
+        },
+        {
+          highlight: "kotlin",
+          language: "kotlin",
+          logoClass: "kotlin",
+        },
+        {
+          highlight: "java",
+          language: "java",
+          logoClass: "java",
+        },
+        {
+          highlight: "php",
+          language: "php",
+          logoClass: "php",
+        },
+      ],
+    } satisfies Preset.ThemeConfig,
+
+    themes: [
+      "docusaurus-theme-openapi-docs"
+    ],
+    stylesheets: [
+      {
+        href: "https://use.fontawesome.com/releases/v5.11.0/css/all.css",
+        type: "text/css",
+      },
+    ],
+  } satisfies Config;
+}
+
+
+function createServersTable(servers: any = []) {
+  if (typeof servers === 'object' && servers && servers.length) {
+    return `| URL | Description |
+| ---- | ----- |
+${servers
+        .map((server) => {
+          return `| ${server.url} | ${server.description} | `.replace("\n", "<br/>");
+        })
+        .join("\n")}
+    `;
+  }
+}
+
+export function createApiPageMD({
+  title,
+  api: {
+    deprecated,
+    "x-deprecated-description": deprecatedDescription,
+    description,
+    method,
+    path,
+    extensions,
+    parameters,
+    requestBody,
+    responses,
+    callbacks,
+    servers, // destructure servers here
+  },
+  infoPath,
+  frontMatter,
+}: ApiPageMetadata) {
+  return render([
+    `import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`,
+    `import ParamsDetails from "@theme/ParamsDetails";\n`,
+    `import RequestSchema from "@theme/RequestSchema";\n`,
+    `import StatusCodes from "@theme/StatusCodes";\n`,
+    `import OperationTabs from "@theme/OperationTabs";\n`,
+    `import TabItem from "@theme/TabItem";\n`,
+    `import Heading from "@theme/Heading";\n\n`,
+    createHeading(title),
+    createMethodEndpoint(method, path),
+    // createServersTable(servers),
+    infoPath && createAuthorization(infoPath),
+    frontMatter.show_extensions
+      ? createVendorExtensions(extensions)
+      : undefined,
+    createDeprecationNotice({ deprecated, description: deprecatedDescription }),
+    createDescription(description),
+    requestBody || parameters ? createRequestHeader("Request") : undefined,
+    createParamsDetails({ parameters }),
+    createRequestBodyDetails({
+      title: "Body",
+      body: requestBody,
+    } as RequestBodyProps),
+    createStatusCodes({ responses }),
+    createCallbacks({ callbacks }),
+  ]);
+}
+interface RequestBodyProps {
+  title: string;
+  body: {
+    content?: {
+      [key: string]: MediaTypeObject;
+    };
+    description?: string;
+    required?: boolean;
+  };
+}

package/docs-config/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "create-apidocs",
+  "version": "4.2.0",
+  "description": "Docusaurus autogenerated from OpenAPI spec & Typedoc functions (with Lunr Search)",
+  "bin": {
+    "create-apidocs": "./bin/create-apidocs"
+  },
+  "scripts": {
+    "docs": "concurrently \"npx docusaurus serve --dir ../docs\" \"wait-on http://localhost:3000 && opener http://localhost:3000\"",
+    "build:docs:subdomain": "DOCS_ON_SUBDOMAIN=true npm run docs:build",
+    "build:docs": " mkdir ../docs; NODE_NO_WARNINGS=1 npx docusaurus clean-api-docs  all --all-versions  ; NODE_NO_WARNINGS=1 npx docusaurus  gen-api-docs all  --all-versions ;  DOCUSAURUS_IGNORE_SSG_WARNINGS=true npx docusaurus build --out-dir ../docs; npm run docs",
+    "docs:copy": "cp ../docs/functions/index.html ../docs/index.html; rm -rf ../web-app/static/docs; cp -r ../docs ../web-app/static; mv ../web-app/static/dist ../web-app/static/docs"
+  },
+  "dependencies": {
+    "@docusaurus/core": "^3.8.0",
+    "@docusaurus/faster": "^3.8.0",
+    "@docusaurus/plugin-google-gtag": "^3.8.0",
+    "@docusaurus/preset-classic": "^3.8.0",
+    "@tailwindcss/postcss": "^4.1.8",
+    "ajv": "^8.17.1",
+    "clsx": "^2.1.1",
+    "docusaurus": "^1.14.7",
+    "docusaurus-lunr-search": "^3.6.0",
+    "docusaurus-plugin-openapi-docs": "^4.4.0",
+    "docusaurus-plugin-typedoc": "^1.4.0",
+    "docusaurus-theme-openapi-docs": "^4.4.0",
+    "eslint-plugin-prettier": "^5.4.0",
+    "postcss": "^8.5.4",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "tailwindcss": "^4.1.8"
+  },
+  "devDependencies": {
+    "concurrently": "^9.1.2",
+    "lucide-react": "^0.513.0",
+    "opener": "^1.5.2",
+    "wait-on": "^8.0.3"
+  }
+}

package/docs-config/src/functions/globals.md

@@ -0,0 +1,153 @@
+## downloadRepo()
+
+```ts
+function downloadRepo(repo: any): Promise<void>;
+```
+
+Defined in: [git0.js:506](https://github.com/vtempest/git0/blob/f5565c601a25c627e02f22dfda1f72982fbcaeae/git0.js#L506)
+
+### Parameters
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Type</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`repo`
+
+</td>
+<td>
+
+`any`
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Returns
+
+`Promise`&lt;`void`&gt;
+
+***
+
+## installDependencies()
+
+```ts
+function installDependencies(targetDir: any): Promise<void>;
+```
+
+Defined in: [git0.js:397](https://github.com/vtempest/git0/blob/f5565c601a25c627e02f22dfda1f72982fbcaeae/git0.js#L397)
+
+### Parameters
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Type</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`targetDir`
+
+</td>
+<td>
+
+`any`
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Returns
+
+`Promise`&lt;`void`&gt;
+
+***
+
+## openInIDE()
+
+```ts
+function openInIDE(targetDir: any): void;
+```
+
+Defined in: [git0.js:354](https://github.com/vtempest/git0/blob/f5565c601a25c627e02f22dfda1f72982fbcaeae/git0.js#L354)
+
+### Parameters
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Type</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`targetDir`
+
+</td>
+<td>
+
+`any`
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Returns
+
+`void`
+
+***
+
+## searchRepositories()
+
+```ts
+function searchRepositories(query: any): Promise<any>;
+```
+
+Defined in: [git0.js:467](https://github.com/vtempest/git0/blob/f5565c601a25c627e02f22dfda1f72982fbcaeae/git0.js#L467)
+
+### Parameters
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Type</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+
+`query`
+
+</td>
+<td>
+
+`any`
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Returns
+
+`Promise`&lt;`any`&gt;

package/docs-config/src/functions/index.md

@@ -0,0 +1,114 @@
+<p align="center">
+    <img  src="https://i.imgur.com/poOtI3N.png" />
+</p>
+<p align="center">
+    <a href="https://discord.gg/SJdBqBz3tV">
+        <img src="https://img.shields.io/discord/1110227955554209923.svg?label=Chat&logo=Discord&colorB=7289da&style=flat"
+            alt="Join Discord" />
+    </a>
+     <a href="https://github.com/vtempest/git0/discussions">
+     <img alt="GitHub Stars" src="https://img.shields.io/github/stars/vtempest/git0" /></a>
+    <a href="https://github.com/vtempest/git0/discussions">
+    <img alt="GitHub Discussions"
+        src="https://img.shields.io/github/discussions/vtempest/git0" />
+    </a>
+    <a href="https://github.com/vtempest/git0/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/vtempest/git0" />
+    </a>
+    <img src="https://img.shields.io/github/last-commit/vtempest/git0.svg?style=flat-square" alt="GitHub last commit" />
+</p>
+<p align="center">
+        <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"
+            alt="PRs Welcome" />
+    <a href="https://codespaces.new/vtempest/git0">
+    <img src="https://github.com/codespaces/badge.svg" width="150" height="20" />
+    </a>
+</p>  
+
+# Git0: Download Git Repo on Step Zero 
+CLI tool to search GitHub repositories, download source & releases for your system, and instantly set up, then install dependencies and open code editor.
+
+## 🚀 Installation
+
+```bash
+npm install -g git0
+```
+
+```bash
+bun install -g git0
+```
+
+![livepreview](https://i.imgur.com/Io3ukRC.gif)
+![preview](https://i.imgur.com/K22NiBq.png)
+
+## ✨ Features
+
+- **Search GitHub repositories** by name with fuzzy matching
+- **Download repositories** directly from GitHub URLs or owner/repo shortcuts. Skip the manual git clone, cd, install dance
+- **Get Releases** instantly download latest release for your system or all systems
+- **Automatic dependency detection** and installation for multiple project types
+- **Smart IDE integration** - automatically opens projects in your preferred editor
+- **Cross-platform support** - works on Windows, macOS, and Linux
+- **Conflict resolution** - handles directory naming conflicts automatically
+
+## 🎯 Usage
+
+```bash
+# Search for repositories by name
+gg react starter
+
+# Direct download from GitHub URL
+## gg and git0 both work
+gg https://github.com/facebook/react
+
+# Download using owner/repo shorthand
+git0 react starter
+
+## Use git0 without installing, (only node needed)
+# (copy into your project's readme for quick setup)
+npx git0 facebook/react
+```
+
+### Supported Project Types
+
+git0 automatically detects and sets up the following project types:
+
+| Project Type | Detection | Installation |
+|-------------|-----------|-------------|
+| **Node.js** | `package.json` | `bun install` (fallback to `npm install`) |
+| **Docker** | `Dockerfile`, `docker-compose.yml` | `docker-compose up -d` or `docker build` |
+| **Python** | `requirements.txt`, `setup.py` | Virtual environment + pip install |
+| **Rust** | `Cargo.toml` | `cargo build` |
+| **Go** | `go.mod` | `go mod tidy` |
+
+### Supported IDEs
+
+git0 automatically detects and opens projects in your preferred IDE:
+
+- **Cursor** (`cursor`)
+- **Windsurf** (`windsurf`) 
+- **VS Code** (`code`)
+- **Code Server** (`code-server`)
+- **Neovim** (`nvim`)
+
+## 🔧 Configuration
+
+### What Happens After Download
+
+1. **Repository is downloaded** to your current directory
+2. **Project type is detected** automatically
+3. **Dependencies are installed** based on project type
+4. **IDE is launched** automatically (if available)
+5. **Development server starts** (for Node.js projects)
+
+If a directory with the same name exists, git0 automatically appends a number (e.g., `react-2`, `react-3`).
+
+### GitHub Token (Optional)
+
+For higher API rate limits, set [your GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token):
+
+```bash
+export GITHUB_TOKEN=your_github_token_here
+```
+
+Without a token, you're limited to 60 requests per hour. With a token, you get 5,000 requests per hour.

package/docs-config/src/functions/typedoc-sidebar.cjs

@@ -0,0 +1,6 @@
+// @ts-check
+/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
+const typedocSidebar = {
+  items: []
+};
+module.exports = typedocSidebar.items;