git0 0.3.18 → 0.3.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/package.json +3 -2
  2. package/docs/404.html +0 -26
  3. package/docs/CNAME +0 -1
  4. package/docs/Footer/index.html +0 -26
  5. package/docs/assets/css/styles.3dd00f8d.css +0 -1
  6. package/docs/assets/js/17896441.79ceefeb.js +0 -1
  7. package/docs/assets/js/1df93b7f.1385eba0.js +0 -2
  8. package/docs/assets/js/1df93b7f.1385eba0.js.LICENSE.txt +0 -6
  9. package/docs/assets/js/22dd74f7.e13ac7a4.js +0 -1
  10. package/docs/assets/js/237.daf7efdf.js +0 -1
  11. package/docs/assets/js/278.1628756c.js +0 -1
  12. package/docs/assets/js/28ab763d.192aa3bb.js +0 -1
  13. package/docs/assets/js/299d276b.c9496717.js +0 -1
  14. package/docs/assets/js/577.78325c02.js +0 -1
  15. package/docs/assets/js/591.2156b33d.js +0 -2
  16. package/docs/assets/js/591.2156b33d.js.LICENSE.txt +0 -61
  17. package/docs/assets/js/5e95c892.bd6c1093.js +0 -1
  18. package/docs/assets/js/68cef36b.e5b1975b.js +0 -1
  19. package/docs/assets/js/a7456010.3054873b.js +0 -1
  20. package/docs/assets/js/a7bd4aaa.87229397.js +0 -1
  21. package/docs/assets/js/a94703ab.6d39a596.js +0 -1
  22. package/docs/assets/js/a9cef9d5.a7253e41.js +0 -1
  23. package/docs/assets/js/aba21aa0.dfebd789.js +0 -1
  24. package/docs/assets/js/ac46717f.32345167.js +0 -2
  25. package/docs/assets/js/ac46717f.32345167.js.LICENSE.txt +0 -6
  26. package/docs/assets/js/c3a618e1.1c56fb03.js +0 -590
  27. package/docs/assets/js/main.1f646b09.js +0 -2
  28. package/docs/assets/js/main.1f646b09.js.LICENSE.txt +0 -68
  29. package/docs/assets/js/runtime~main.f69f8f44.js +0 -1
  30. package/docs/functions/fm/index.html +0 -26
  31. package/docs/functions/git0/index.html +0 -48
  32. package/docs/functions/github-api/index.html +0 -149
  33. package/docs/functions/index.html +0 -891
  34. package/docs/functions/modules/index.html +0 -31
  35. package/docs/index.html +0 -26
  36. package/docs/lunr-index-1749760982052.json +0 -1
  37. package/docs/lunr-index.json +0 -1
  38. package/docs/search-doc-1749760982052.json +0 -1
  39. package/docs/search-doc.json +0 -1
  40. package/docs/sitemap.xml +0 -1
  41. package/docs-config/.docusaurus/DONT-EDIT-THIS-FOLDER +0 -5
  42. package/docs-config/.docusaurus/client-manifest.json +0 -271
  43. package/docs-config/.docusaurus/client-modules.js +0 -8
  44. package/docs-config/.docusaurus/codeTranslations.json +0 -1
  45. package/docs-config/.docusaurus/docusaurus-lunr-search/default/__plugin.json +0 -4
  46. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/__mdx-loader-dependency.json +0 -1
  47. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/__plugin.json +0 -4
  48. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/p/docs-175.json +0 -1
  49. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/p/index-466.json +0 -1
  50. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-fm-md-a9c.json +0 -19
  51. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-git-0-1-md-d3e.json +0 -19
  52. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-git-0-md-299.json +0 -23
  53. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-github-api-md-28a.json +0 -23
  54. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-globals-md-4a8.json +0 -19
  55. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-index-md-c3a.json +0 -23
  56. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-functions-modules-md-68c.json +0 -19
  57. package/docs-config/.docusaurus/docusaurus-plugin-content-docs/default/site-src-index-md-d14.json +0 -21
  58. package/docs-config/.docusaurus/docusaurus-plugin-content-pages/default/__plugin.json +0 -4
  59. package/docs-config/.docusaurus/docusaurus-plugin-google-gtag/default/__plugin.json +0 -4
  60. package/docs-config/.docusaurus/docusaurus.config.mjs +0 -378
  61. package/docs-config/.docusaurus/globalData.json +0 -70
  62. package/docs-config/.docusaurus/i18n.json +0 -17
  63. package/docs-config/.docusaurus/lunr.client.js +0 -5
  64. package/docs-config/.docusaurus/registry.js +0 -16
  65. package/docs-config/.docusaurus/routes.js +0 -67
  66. package/docs-config/.docusaurus/routesChunkNames.json +0 -49
  67. package/docs-config/.docusaurus/site-metadata.json +0 -51
  68. package/docs-config/.docusaurus/site-storage.json +0 -4
  69. package/docs-config/config/customize-docs.js +0 -31
  70. package/docs-config/config/docs-theme.css +0 -358
  71. package/docs-config/config/openapi.mustache +0 -39
  72. package/docs-config/config/sidebars.ts +0 -21
  73. package/docs-config/config/typedoc.json +0 -40
  74. package/docs-config/docusaurus.config.ts +0 -341
  75. package/docs-config/package.json +0 -40
  76. package/docs-config/src/functions/fm.md +0 -1
  77. package/docs-config/src/functions/git0.md +0 -101
  78. package/docs-config/src/functions/github-api.md +0 -761
  79. package/docs-config/src/functions/index.md +0 -103
  80. package/docs-config/src/functions/modules.md +0 -5
  81. package/docs-config/src/functions/typedoc-sidebar.cjs +0 -22
  82. package/docs-config/src/pages/Footer.tsx +0 -67
  83. package/docs-config/src/pages/index.tsx +0 -433
  84. package/docs-config/static/CNAME +0 -1
  85. package/docs-config/tsconfig.json +0 -27
@@ -1,341 +0,0 @@
1
- import type * as Preset from "@docusaurus/preset-classic";
2
- import type { Config } from "@docusaurus/types";
3
- import type * as Plugin from "@docusaurus/types/src/plugin";
4
- import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
5
- import { type ApiPageMetadata } from "docusaurus-plugin-openapi-docs/lib/types";
6
- import { type MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
7
- //OpenAPI integration
8
- import { createAuthorization } from "docusaurus-plugin-openapi-docs/lib/markdown/createAuthorization";
9
- import { createCallbacks } from "docusaurus-plugin-openapi-docs/lib/markdown/createCallbacks";
10
- import { createDeprecationNotice } from "docusaurus-plugin-openapi-docs/lib/markdown/createDeprecationNotice";
11
- import { createDescription } from "docusaurus-plugin-openapi-docs/lib/markdown/createDescription";
12
- import { createHeading } from "docusaurus-plugin-openapi-docs/lib/markdown/createHeading";
13
- import { createMethodEndpoint } from "docusaurus-plugin-openapi-docs/lib/markdown/createMethodEndpoint";
14
- import { createParamsDetails } from "docusaurus-plugin-openapi-docs/lib/markdown/createParamsDetails";
15
- import { createRequestBodyDetails } from "docusaurus-plugin-openapi-docs/lib/markdown/createRequestBodyDetails";
16
- import { createRequestHeader } from "docusaurus-plugin-openapi-docs/lib/markdown/createRequestHeader";
17
- import { createStatusCodes } from "docusaurus-plugin-openapi-docs/lib/markdown/createStatusCodes";
18
- import { createVendorExtensions } from "docusaurus-plugin-openapi-docs/lib/markdown/createVendorExtensions";
19
- import { render } from "docusaurus-plugin-openapi-docs/lib/markdown/utils";
20
- import customizeDocs from "./config/customize-docs";
21
- import fs from "fs";
22
-
23
- /**
24
- * Generate docs from JSDoc comments in files, OpenAPI.yml spec for
25
- * routes, search index of everything, custom pages, sidebar & theme.
26
- *
27
- * Files: openapi-docs.yaml, docs-theme.css, plugin-openapi.mustache,
28
- * plugin-typedoc.js, sidebars.ts, docusaurus.config.ts, typedoc.json, tsconfig.json
29
- *
30
- * *Install dependencies*:
31
- * bun install -D @docusaurus/core @docusaurus/faster @docusaurus/plugin-google-gtag
32
- * @docusaurus/preset-classic docusaurus-lunr-search docusaurus-plugin-openapi-docs
33
- * docusaurus-plugin-typedoc docusaurus-theme-openapi-docs prism-react-renderer react
34
- * react-dom clsx typedoc typedoc-plugin-markdown typescript
35
- * https://github.com/vtempest/ai-research-agent/blob/master/docs/api.mustache
36
- * *Add to package.json*:
37
- * "docs": "docusaurus serve --dir web-app/static/docs",
38
- * "docs:build": "NODE_NO_WARNINGS=1 docusaurus clean-api-docs all --all-versions ;
39
- * NODE_NO_WARNINGS=1 docusaurus gen-api-docs all --all-versions ;
40
- * rm -rf web-app/static/docs; DOCUSAURUS_IGNORE_SSG_WARNINGS=true docusaurus
41
- * build --out-dir web-app/static/docs",
42
- *
43
- * For homepage Add to docs/functions/index.md
44
- *
45
- ---
46
- sidebar_position: 1
47
- sidebar_label: Introduction
48
- title: Introduction
49
- slug: /
50
- ---
51
-
52
- * @see
53
- * [Docusaurus Docs](https://docusaurus.io/docs)
54
- * [Typedoc Docs](https://typedoc.org/documents/)
55
- * [Typedoc Plugin Docs](https://typedoc-plugin-markdown.org/docs/options)
56
- * [OpenAPI Plugin Docs](https://docusaurus-openapi.tryingpan.dev)
57
- * @returns {Promise<Config>}
58
- * @author [vtempest](https://github.com/vtempest/)
59
- */
60
- export default async function createConfig(options: any = {}) {
61
- const {
62
- name = "App",
63
- domain = "https://example.org",
64
- baseFolder = "./",
65
- typedocFolders = [],
66
- showEditsOnGitHub = true,
67
- GOOGLE_ANALYTICS_ID = undefined,
68
- compileForSubdomain = !!process.env.DOCS_ON_SUBDOMAIN,
69
- tsconfig = "./tsconfig.json",
70
- readme = "../readme.md",
71
- sanitizeComments = false,
72
- favicon = undefined,
73
- logo = undefined,
74
- logoURL = "/",
75
- topbar = [],
76
- enableFasterBuildV4 = false,
77
- enableReadmeAsHome = true,
78
- } = { ...customizeDocs, ...options };
79
-
80
-
81
- // make sure src folder exists
82
- if (!fs.existsSync(baseFolder + "src")) {
83
- fs.mkdirSync(baseFolder + "src");
84
- }
85
-
86
- //copy readme into ./src
87
- if (fs.existsSync(readme) && enableReadmeAsHome) {
88
-
89
-
90
- var index_frontmatter = '---\nid: index\ntitle: Overview\n' +
91
- 'sidebar_position: 1\ndisplayed_sidebar: '
92
- + 'default' + '\n---\n\n'
93
-
94
- var readmeContent = fs.readFileSync(readme, "utf8")
95
- fs.writeFileSync(baseFolder + "src/index.md",
96
- index_frontmatter + readmeContent);
97
- }
98
-
99
- //prepend to index
100
-
101
-
102
- // foldersWithFunctions - should also add to tsconfig.json include:[]
103
- // compileForSubdomain is used to generate at domain.com/docs
104
- // but on github pages workflow, it outputs to
105
- // subdomain like docprojects.user.github.io
106
- // sanitizeComments helps avoid errors in markdown like <> {} etc
107
- return {
108
- future: enableFasterBuildV4 ? {
109
- v4: {
110
- removeLegacyPostBuildHeadAttribute: true, // REQUIRED for ssgWorkerThreads
111
- },
112
- experimental_faster: true,
113
- } : undefined,
114
- title: name + " Docs",
115
- url: domain,
116
- baseUrl: compileForSubdomain ? "/" : "/docs/",
117
- onBrokenLinks: "ignore",
118
- onBrokenMarkdownLinks: "ignore",
119
- favicon,
120
- projectName: name.replaceAll(" ", "-"),
121
- presets: [
122
- [
123
- "classic",
124
- {
125
- docs: {
126
- path: "src",
127
- routeBasePath: "/",
128
- sidebarPath: "./config/sidebars.ts",
129
- },
130
- blog: false,
131
- theme: {
132
- customCss: baseFolder + "config/docs-theme.css",
133
- },
134
- gtag: {
135
- trackingID: GOOGLE_ANALYTICS_ID,
136
- anonymizeIP: false,
137
- },
138
- } satisfies Preset.Options,
139
- ],
140
- ],
141
-
142
- plugins: [
143
-
144
-
145
- require.resolve("docusaurus-lunr-search"),
146
-
147
- ...(typedocFolders.map(({ id, entryPoints }) => [
148
- "docusaurus-plugin-typedoc",
149
- {
150
- id,
151
- entryPoints,
152
- exclude: [
153
- "**/node_modules/**/*",
154
- "pages/**/*"
155
- ],
156
- tsconfig,
157
- out: baseFolder + "src/" + id,
158
- readme,
159
- disableSources: !showEditsOnGitHub,
160
- sidebar: { pretty: true },
161
- textContentMappings: {
162
- "title.indexPage": name + " API",
163
- "title.memberPage": "{name}",
164
- },
165
- parametersFormat: "htmlTable",
166
- indexFormat: "list",
167
- expandParameters: true,
168
- interfacePropertiesFormat: "htmlTable",
169
- propertyMembersFormat: "htmlTable",
170
- enumMembersFormat: "htmlTable",
171
- typeDeclarationFormat: "htmlTable",
172
- typeDeclarationVisibility: "compact",
173
- sanitizeComments,
174
- useHTMLEncodedBrackets: true,
175
- hideBreadcrumbs: false,
176
- hideGroupHeadings: true,
177
- hidePageHeader: true,
178
- hidePageTitle: true,
179
- outputFileStrategy: "modules",
180
- useCodeBlocks: true,
181
- },
182
- ]))
183
- ],
184
-
185
- themeConfig: {
186
- src: {
187
- sidebar: {
188
- hideable: true,
189
- },
190
- },
191
- navbar: {
192
- title: name + " Docs",
193
- logo: {
194
- alt: "logo",
195
- src: logo,
196
- href: logoURL || "/",
197
- },
198
- items: topbar
199
- },
200
-
201
- languageTabs: [
202
- {
203
- highlight: "javascript",
204
- language: "nodejs",
205
- logoClass: "nodejs",
206
- },
207
- {
208
- highlight: "javascript",
209
- language: "javascript",
210
- logoClass: "javascript",
211
- },
212
- {
213
- highlight: "python",
214
- language: "python",
215
- logoClass: "python",
216
- },
217
- {
218
- highlight: "bash",
219
- language: "curl",
220
- logoClass: "curl",
221
- },
222
- {
223
- highlight: "powershell",
224
- language: "powershell",
225
- logoClass: "powershell",
226
- },
227
-
228
- {
229
- highlight: "rust",
230
- language: "rust",
231
- logoClass: "rust",
232
- },
233
- {
234
- highlight: "c",
235
- language: "c",
236
- logoClass: "c",
237
- },
238
- {
239
- highlight: "swift",
240
- language: "swift",
241
- logoClass: "swift",
242
- },
243
- {
244
- highlight: "kotlin",
245
- language: "kotlin",
246
- logoClass: "kotlin",
247
- },
248
- {
249
- highlight: "java",
250
- language: "java",
251
- logoClass: "java",
252
- },
253
- {
254
- highlight: "php",
255
- language: "php",
256
- logoClass: "php",
257
- },
258
- ],
259
- } satisfies Preset.ThemeConfig,
260
-
261
- themes: [
262
- "docusaurus-theme-openapi-docs"
263
- ],
264
- stylesheets: [
265
- {
266
- href: "https://use.fontawesome.com/releases/v5.11.0/css/all.css",
267
- type: "text/css",
268
- },
269
- ],
270
- } satisfies Config;
271
- }
272
-
273
-
274
- function createServersTable(servers: any = []) {
275
- if (typeof servers === 'object' && servers && servers.length) {
276
- return `| URL | Description |
277
- | ---- | ----- |
278
- ${servers
279
- .map((server) => {
280
- return `| ${server.url} | ${server.description} | `.replace("\n", "<br/>");
281
- })
282
- .join("\n")}
283
- `;
284
- }
285
- }
286
-
287
- export function createApiPageMD({
288
- title,
289
- api: {
290
- deprecated,
291
- "x-deprecated-description": deprecatedDescription,
292
- description,
293
- method,
294
- path,
295
- extensions,
296
- parameters,
297
- requestBody,
298
- responses,
299
- callbacks,
300
- servers, // destructure servers here
301
- },
302
- infoPath,
303
- frontMatter,
304
- }: ApiPageMetadata) {
305
- return render([
306
- `import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`,
307
- `import ParamsDetails from "@theme/ParamsDetails";\n`,
308
- `import RequestSchema from "@theme/RequestSchema";\n`,
309
- `import StatusCodes from "@theme/StatusCodes";\n`,
310
- `import OperationTabs from "@theme/OperationTabs";\n`,
311
- `import TabItem from "@theme/TabItem";\n`,
312
- `import Heading from "@theme/Heading";\n\n`,
313
- createHeading(title),
314
- createMethodEndpoint(method, path),
315
- // createServersTable(servers),
316
- infoPath && createAuthorization(infoPath),
317
- frontMatter.show_extensions
318
- ? createVendorExtensions(extensions)
319
- : undefined,
320
- createDeprecationNotice({ deprecated, description: deprecatedDescription }),
321
- createDescription(description),
322
- requestBody || parameters ? createRequestHeader("Request") : undefined,
323
- createParamsDetails({ parameters }),
324
- createRequestBodyDetails({
325
- title: "Body",
326
- body: requestBody,
327
- } as RequestBodyProps),
328
- createStatusCodes({ responses }),
329
- createCallbacks({ callbacks }),
330
- ]);
331
- }
332
- interface RequestBodyProps {
333
- title: string;
334
- body: {
335
- content?: {
336
- [key: string]: MediaTypeObject;
337
- };
338
- description?: string;
339
- required?: boolean;
340
- };
341
- }
@@ -1,40 +0,0 @@
1
- {
2
- "name": "create-apidocs",
3
- "version": "4.2.0",
4
- "description": "Docusaurus autogenerated from OpenAPI spec & Typedoc functions (with Lunr Search)",
5
- "bin": {
6
- "create-apidocs": "./bin/create-apidocs"
7
- },
8
- "scripts": {
9
- "docs": "concurrently \"npx docusaurus serve --dir ../docs\" \"wait-on http://localhost:3000 && opener http://localhost:3000\"",
10
- "build:docs:subdomain": "DOCS_ON_SUBDOMAIN=true npm run docs:build",
11
- "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",
12
- "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"
13
- },
14
- "dependencies": {
15
- "@docusaurus/core": "^3.8.0",
16
- "@docusaurus/faster": "^3.8.0",
17
- "@docusaurus/plugin-google-gtag": "^3.8.0",
18
- "@docusaurus/preset-classic": "^3.8.0",
19
- "@tailwindcss/postcss": "^4.1.8",
20
- "ajv": "^8.17.1",
21
- "clsx": "^2.1.1",
22
- "docusaurus": "^1.14.7",
23
- "docusaurus-lunr-search": "^3.6.0",
24
- "docusaurus-plugin-openapi-docs": "^4.4.0",
25
- "docusaurus-plugin-typedoc": "^1.4.0",
26
- "docusaurus-theme-openapi-docs": "^4.4.0",
27
- "eslint-plugin-prettier": "^5.4.0",
28
- "postcss": "^8.5.4",
29
- "prism-react-renderer": "^2.4.1",
30
- "react": "^19.1.0",
31
- "react-dom": "^19.1.0",
32
- "tailwindcss": "^4.1.8"
33
- },
34
- "devDependencies": {
35
- "concurrently": "^9.1.2",
36
- "lucide-react": "^0.513.0",
37
- "opener": "^1.5.2",
38
- "wait-on": "^8.0.3"
39
- }
40
- }
@@ -1 +0,0 @@
1
- [Documentation](modules.md) / fm
@@ -1,101 +0,0 @@
1
- [Documentation](modules.md) / git0
2
-
3
- ## installDependencies()
4
-
5
- ```ts
6
- function installDependencies(targetDir: string): Promise<void>;
7
- ```
8
-
9
- Defined in: [src/git0.js:207](https://github.com/vtempest/git0/blob/59ed406649e41b4d7072fd6657f693b571f0088e/src/git0.js#L207)
10
-
11
- Automatically detects project type and installs dependencies
12
- Supports Node.js, Docker, Python, Rust, and Go projects
13
-
14
- ### Parameters
15
-
16
- <table>
17
- <thead>
18
- <tr>
19
- <th>Parameter</th>
20
- <th>Type</th>
21
- <th>Description</th>
22
- </tr>
23
- </thead>
24
- <tbody>
25
- <tr>
26
- <td>
27
-
28
- `targetDir`
29
-
30
- </td>
31
- <td>
32
-
33
- `string`
34
-
35
- </td>
36
- <td>
37
-
38
- Path to the project directory
39
-
40
- </td>
41
- </tr>
42
- </tbody>
43
- </table>
44
-
45
- ### Returns
46
-
47
- `Promise`&lt;`void`&gt;
48
-
49
- ### Export
50
-
51
- ### Async
52
-
53
- ***
54
-
55
- ## openInIDE()
56
-
57
- ```ts
58
- function openInIDE(targetDir: string): void;
59
- ```
60
-
61
- Defined in: [src/git0.js:157](https://github.com/vtempest/git0/blob/59ed406649e41b4d7072fd6657f693b571f0088e/src/git0.js#L157)
62
-
63
- Opens a directory in the first available IDE/editor
64
- Also attempts to open a README or package.json file after 3 seconds
65
-
66
- ### Parameters
67
-
68
- <table>
69
- <thead>
70
- <tr>
71
- <th>Parameter</th>
72
- <th>Type</th>
73
- <th>Description</th>
74
- </tr>
75
- </thead>
76
- <tbody>
77
- <tr>
78
- <td>
79
-
80
- `targetDir`
81
-
82
- </td>
83
- <td>
84
-
85
- `string`
86
-
87
- </td>
88
- <td>
89
-
90
- Path to the directory to open
91
-
92
- </td>
93
- </tr>
94
- </tbody>
95
- </table>
96
-
97
- ### Returns
98
-
99
- `void`
100
-
101
- ### Export