feat: init command to scaffold a new project from a template (#217)

* feat: `init` command to scaffold a project from a template * feat: `node-typescript` project template * feat: `electron-typescript-react` project template * feat: debug mode * feat: load LoRA adapters * feat: link to CLI command docs from the CLI help * feat: improve Electron support * fix: improve binary compatibility detection on Linux * docs: CLI commands syntax highlighting
withcatai · May 18, 2024 · d6a0f43 · d6a0f43
1 parent d321fe3
commit d6a0f43
Show file tree

Hide file tree

Showing 119 changed files with 7,528 additions and 3,210 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -5,7 +5,7 @@
         "browser": false,
         "es6": true
     },
-    "ignorePatterns": ["/dist", "/llama", "/docs-site"],
+    "ignorePatterns": ["/dist", "/llama", "/docs-site", "/packages/create-node-llama-cpp/dist"],
     "extends": [
         "eslint:recommended",
         "plugin:jsdoc/recommended"
@@ -15,10 +15,7 @@
         "SharedArrayBuffer": "readonly"
     },
     "parserOptions": {
-        "ecmaFeatures": {
-            "jsx": true
-        },
-        "ecmaVersion": 2021,
+        "ecmaVersion": 2023,
         "sourceType": "module"
     },
     "overrides": [{
@@ -148,7 +145,9 @@
         }],
         "keyword-spacing": ["warn"],
         "space-infix-ops": ["warn"],
-        "spaced-comment": ["warn", "always"],
+        "spaced-comment": ["warn", "always", {
+            "markers": ["/"]
+        }],
         "eol-last": ["warn", "always"],
         "max-len": ["warn", {
             "code": 140,

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -39,7 +39,7 @@ body:
         Your bug can be investigated much faster if your code can be run without any dependencies other than `node-llama-cpp`.
         Issues without reproduction steps or code examples may be closed as not actionable.
         Please try to provide a Minimal, Complete, and Verifiable example ([link](http://stackoverflow.com/help/mcve)).
-        Also, please enable enable debug logs by using `getLlama({logLevel: LlamaLogLevel.debug})` to get more information.
+        Also, please enable enable debug logs by using `getLlama({debug: true})` to get more information.
       placeholder: >-
         Please try to provide a Minimal, Complete, and Verifiable example.
         http://stackoverflow.com/help/mcve

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -334,6 +334,7 @@ jobs:
       contents: write
       issues: write
       pull-requests: write
+      discussions: write
     needs:
       - build
       - build-binaries
@@ -381,6 +382,32 @@ jobs:
           if [ -f .semanticRelease.npmPackage.deployedVersion.txt ]; then
             echo "npm-url=https://www.npmjs.com/package/node-llama-cpp/v/$(cat .semanticRelease.npmPackage.deployedVersion.txt)" >> $GITHUB_OUTPUT
           fi
+      - name: Prepare `create-node-llama-cpp` module
+        if: steps.set-npm-url.outputs.npm-url != ''
+        run: |
+          export DEPLOYED_PACKAGE_VERSION=$(cat .semanticRelease.npmPackage.deployedVersion.txt)
+          
+          pushd packages/create-node-llama-cpp
+          npm ci --ignore-scripts
+          popd
+          
+          npx --no vite-node ./scripts/prepareCreateNodeLlamaCppModuleForPublish.ts --packageVersion "$DEPLOYED_PACKAGE_VERSION"
+          
+          pushd packages/create-node-llama-cpp
+          npm run build
+      - name: Release `create-node-llama-cpp` module
+        if: steps.set-npm-url.outputs.npm-url != ''
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GH_RELEASE_REF: ${{ github.ref }}
+        run: |
+          cd packages/create-node-llama-cpp
+          
+          if [ "$GH_RELEASE_REF" == "refs/heads/beta" ]; then
+              npm publish --tag beta
+          else
+              npm publish
+          fi
       - name: Generate docs with updated version
         if: steps.set-npm-url.outputs.npm-url != '' && github.ref == 'refs/heads/master'
         env:

diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ node_modules
 /dist
 /docs-site
 /docs/api
+/templates/packed
 
 /.env
 /.eslintcache

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx --no -- commitlint --edit $1
+npx --no -- commitlint --edit "$1"
diff --git a/.vitepress/config.ts b/.vitepress/config.ts
@@ -226,6 +226,7 @@ export default defineConfig({
                 items: [
                     {text: "Pull", link: "/pull"},
                     {text: "Chat", link: "/chat"},
+                    {text: "Init", link: "/init"},
                     {text: "Download", link: "/download"},
                     {text: "Complete", link: "/complete"},
                     {text: "Infill", link: "/infill"},

diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css
@@ -50,6 +50,7 @@
     transition: opacity 0.5s;
     opacity: 0;
     pointer-events: none;
+    z-index: -1;
 }
 
 .VPNavBar:not(.home) .divider-line[class] {
@@ -84,6 +85,7 @@
     content: "";
     transition: opacity 0.5s;
     pointer-events: none;
+    z-index: -1;
 }
 
 .main-badges>p {
@@ -94,6 +96,27 @@
     gap: 4px;
 }
 
+.VPSidebarItem .text {
+    word-break: break-word;
+    line-height: 20px;
+    padding: 6px 0px;
+}
+
+a.inlineCodeLink {
+    /*text-decoration: none;*/
+    text-underline-offset: 4px;
+    color: transparent;
+}
+a.inlineCodeLink:hover {
+    color: inherit;
+}
+
+a.inlineCodeLink pre>code {
+    border-radius: 4px;
+    padding: 3px 6px;
+    background-color: var(--vp-code-bg);
+}
+
 img[src$="assets/logo.roundEdges.png"],
 img[src$="assets/logo.png"] {
     box-shadow: 0px 4px 12px 0px rgb(0 0 0 / 16%), 0px 8px 64px 0px rgb(0 0 0 / 24%);

diff --git a/.vitepress/tsconfig.json b/.vitepress/tsconfig.json
@@ -32,8 +32,5 @@
         "./config.ts",
         "./utils",
         "../docs"
-    ],
-    "ts-node": {
-        "esm": true
-    }
+    ]
 }
diff --git a/.vitepress/utils/getCommandHtmlDoc.ts b/.vitepress/utils/getCommandHtmlDoc.ts
@@ -1,9 +1,12 @@
 import {Argv, CommandModule, Options} from "yargs";
+import {createMarkdownRenderer} from "vitepress";
 import {htmlEscape} from "./htmlEscape.js";
-import {cliBinName, npxRunPrefix} from "../../src/config.js";
 import {buildHtmlTable} from "./buildHtmlTable.js";
 import {buildHtmlHeading} from "./buildHtmlHeading.js";
 import {htmlEscapeWithCodeMarkdown} from "./htmlEscapeWithCodeMarkdown.js";
+import {getInlineCodeBlockHtml} from "./getInlineCodeBlockHtml.js";
+import {cliBinName, npxRunPrefix} from "../../src/config.js";
+import {withoutCliCommandDescriptionDocsUrl} from "../../src/cli/utils/withCliCommandDescriptionDocsUrl.js";
 
 export async function getCommandHtmlDoc(command: CommandModule<any, any>, {
     cliName = cliBinName,
@@ -19,6 +22,7 @@ export async function getCommandHtmlDoc(command: CommandModule<any, any>, {
     const title = cliName + " " + (resolvedParentCommandCliCommand ?? "<command>").replace("<command>", currentCommandCliCommand ?? "");
     const description = command.describe ?? "";
     const {subCommands, optionGroups} = await parseCommandDefinition(command);
+    const markdownRenderer = await createMarkdownRenderer(process.cwd());
 
     let res = "";
 
@@ -45,8 +49,17 @@ export async function getCommandHtmlDoc(command: CommandModule<any, any>, {
                         cliCommand = (resolvedParentCommandCliCommand ?? "<command>").replace("<command>", cliCommand);
 
                     return [
-                        `<a href="${subCommandsParentPageLink != null ? (subCommandsParentPageLink + "/") : ""}${commandPageLink}"><code>` + htmlEscape(cliName + " " + cliCommand) + "</code></a>",
-                        htmlEscapeWithCodeMarkdown(String(subCommand.describe ?? ""))
+                        getInlineCodeBlockHtml(
+                            markdownRenderer,
+                            cliName + " " + cliCommand,
+                            "shell",
+                            (
+                                subCommandsParentPageLink != null
+                                    ? (subCommandsParentPageLink + "/")
+                                    : ""
+                            ) + commandPageLink
+                        ),
+                        htmlEscapeWithCodeMarkdown(withoutCliCommandDescriptionDocsUrl(String(subCommand.describe ?? "")))
                     ];
                 })
                 .filter((row): row is string[] => row != null)
@@ -72,8 +85,9 @@ export async function getCommandHtmlDoc(command: CommandModule<any, any>, {
 
     return {
         title,
-        description,
+        description: withoutCliCommandDescriptionDocsUrl(description),
         usage: npxRunPrefix + title,
+        usageHtml: markdownRenderer.render("```shell\n" + npxRunPrefix + title + "\n```"),
         options: res
     };
 }

diff --git a/.vitepress/utils/getInlineCodeBlockHtml.ts b/.vitepress/utils/getInlineCodeBlockHtml.ts
@@ -0,0 +1,20 @@
+import {createMarkdownRenderer} from "vitepress";
+import {htmlEscape} from "./htmlEscape.js";
+
+export function getInlineCodeBlockHtml(
+    markdownRenderer: Awaited<ReturnType<typeof createMarkdownRenderer>>, code: string, lang: string, link?: string
+) {
+    if (markdownRenderer.options.highlight != null) {
+        const codeBlock = markdownRenderer.options.highlight(code, lang, "");
+
+        if (link != null && link !== "")
+            return `<a class="inlineCodeLink" href="${link}">${codeBlock}</a>`;
+
+        return `<a class="inlineCodeLink">${codeBlock}</a>`;
+    }
+
+    if (link != null && link !== "")
+        return `<a href="${link}"><code>${htmlEscape(code)}</code></a>`;
+
+    return `<code>${htmlEscape(code)}</code>`;
+}
diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ const a1 = await session.prompt(q1);
 console.log("AI: " + a1);
 
 
-const q2 = "Summerize what you said";
+const q2 = "Summarize what you said";
 console.log("User: " + q2);
 
 const a2 = await session.prompt(q2);

diff --git a/docs/guide/chat-prompt-wrapper.md b/docs/guide/chat-prompt-wrapper.md
@@ -68,7 +68,7 @@ const a1 = await session.prompt(q1);
 console.log("AI: " + a1);
 
 
-const q2 = "Summerize what you said";
+const q2 = "Summarize what you said";
 console.log("User: " + q2);
 
 const a2 = await session.prompt(q2);
@@ -124,7 +124,7 @@ const a1 = await session.prompt(q1);
 console.log("AI: " + a1);
 
 
-const q2 = "Summerize what you said";
+const q2 = "Summarize what you said";
 console.log("User: " + q2);
 
 const a2 = await session.prompt(q2);

diff --git a/docs/guide/chat-session.md b/docs/guide/chat-session.md
@@ -26,7 +26,7 @@ const a1 = await session.prompt(q1);
 console.log("AI: " + a1);
 
 
-const q2 = "Summerize what you said";
+const q2 = "Summarize what you said";
 console.log("User: " + q2);
 
 const a2 = await session.prompt(q2);
@@ -59,7 +59,7 @@ const a1 = await session.prompt(q1);
 console.log("AI: " + a1);
 
 
-const q2 = "Summerize what you said";
+const q2 = "Summarize what you said";
 console.log("User: " + q2);
 
 const a2 = await session.prompt(q2);

diff --git a/docs/guide/cli/build.md b/docs/guide/cli/build.md
@@ -15,9 +15,7 @@ If the build fails on macOS with the error `"/usr/bin/cc" is not able to compile
 :::
 
 ## Usage
-```shell-vue
-{{commandDoc.usage}}
-```
+<div v-html="commandDoc.usageHtml"></div>
 <div v-html="commandDoc.options"></div>
 
 

diff --git a/docs/guide/cli/chat.md b/docs/guide/cli/chat.md
@@ -11,7 +11,5 @@ const commandDoc = docs.chat;
 {{commandDoc.description}}
 
 ## Usage
-```shell-vue
-{{commandDoc.usage}}
-```
+<div v-html="commandDoc.usageHtml"></div>
 <div v-html="commandDoc.options"></div>
diff --git a/docs/guide/cli/clear.md b/docs/guide/cli/clear.md
@@ -11,7 +11,5 @@ const commandDoc = docs.clear;
 {{commandDoc.description}}
 
 ## Usage
-```shell-vue
-{{commandDoc.usage}}
-```
+<div v-html="commandDoc.usageHtml"></div>
 <div v-html="commandDoc.options"></div>
diff --git a/docs/guide/cli/cli.data.ts b/docs/guide/cli/cli.data.ts
@@ -1,5 +1,5 @@
 import {CommandModule} from "yargs";
-import {getCommandHtmlDoc} from "../../../.vitepress/utils/getCommandHtmlDoc.js";
+import {createMarkdownRenderer} from "vitepress";
 import {PullCommand} from "../../../src/cli/commands/PullCommand.js";
 import {BuildCommand} from "../../../src/cli/commands/BuildCommand.js";
 import {ChatCommand} from "../../../src/cli/commands/ChatCommand.js";
@@ -10,22 +10,27 @@ import {InspectGpuCommand} from "../../../src/cli/commands/inspect/commands/Insp
 import {InspectGgufCommand} from "../../../src/cli/commands/inspect/commands/InspectGgufCommand.js";
 import {DownloadCommand} from "../../../src/cli/commands/DownloadCommand.js";
 import {ClearCommand} from "../../../src/cli/commands/ClearCommand.js";
-import {htmlEscape} from "../../../.vitepress/utils/htmlEscape.js";
+import {InspectMeasureCommand} from "../../../src/cli/commands/inspect/commands/InspectMeasureCommand.js";
+import {InitCommand} from "../../../src/cli/commands/InitCommand.js";
 import {cliBinName, npxRunPrefix} from "../../../src/config.js";
+import {htmlEscape} from "../../../.vitepress/utils/htmlEscape.js";
+import {getCommandHtmlDoc} from "../../../.vitepress/utils/getCommandHtmlDoc.js";
 import {buildHtmlHeading} from "../../../.vitepress/utils/buildHtmlHeading.js";
 import {buildHtmlTable} from "../../../.vitepress/utils/buildHtmlTable.js";
 import {setIsInDocumentationMode} from "../../../src/state.js";
-import {InspectMeasureCommand} from "../../../src/cli/commands/inspect/commands/InspectMeasureCommand.js";
 import {htmlEscapeWithCodeMarkdown} from "../../../.vitepress/utils/htmlEscapeWithCodeMarkdown.js";
+import {getInlineCodeBlockHtml} from "../../../.vitepress/utils/getInlineCodeBlockHtml.js";
+import {withoutCliCommandDescriptionDocsUrl} from "../../../src/cli/utils/withCliCommandDescriptionDocsUrl.js";
 
 export default {
     async load() {
         setIsInDocumentationMode(true);
 
         return {
-            index: buildIndexTable([
+            index: await buildIndexTable([
                 ["pull", PullCommand],
                 ["chat", ChatCommand],
+                ["init", InitCommand],
                 ["complete", CompleteCommand],
                 ["infill", InfillCommand],
                 ["inspect", InspectCommand],
@@ -36,6 +41,7 @@ export default {
 
             pull: await getCommandHtmlDoc(PullCommand),
             chat: await getCommandHtmlDoc(ChatCommand),
+            init: await getCommandHtmlDoc(InitCommand),
             complete: await getCommandHtmlDoc(CompleteCommand),
             infill: await getCommandHtmlDoc(InfillCommand),
             inspect: {
@@ -59,8 +65,9 @@ export default {
     }
 };
 
-function buildIndexTable(commands: [pageLink: string, command: CommandModule<any, any>][], cliName: string = cliBinName) {
+async function buildIndexTable(commands: [pageLink: string, command: CommandModule<any, any>][], cliName: string = cliBinName) {
     let res = "";
+    const markdownRenderer = await createMarkdownRenderer(process.cwd());
 
     res += buildHtmlHeading("h2", htmlEscape("Commands"), "commands");
     res += buildHtmlTable(
@@ -74,8 +81,8 @@ function buildIndexTable(commands: [pageLink: string, command: CommandModule<any
                     return null;
 
                 return [
-                    `<a href="${pageLink}"><code>` + htmlEscape(cliName + " " + command.command) + "</code></a>",
-                    htmlEscapeWithCodeMarkdown(String(command.describe ?? ""))
+                    getInlineCodeBlockHtml(markdownRenderer, cliName + " " + command.command, "shell", pageLink),
+                    htmlEscapeWithCodeMarkdown(withoutCliCommandDescriptionDocsUrl(String(command.describe ?? "")))
                 ];
             })
             .filter((row): row is string[] => row != null)
@@ -105,10 +112,13 @@ function buildIndexTable(commands: [pageLink: string, command: CommandModule<any
         ]
     );
 
+    const usage = npxRunPrefix + cliName + " <command> [options]";
+
     return {
         title: "CLI",
         description: null,
-        usage: npxRunPrefix + cliName + " <command> [options]",
+        usage,
+        usageHtml: markdownRenderer.render("```shell\n" + usage + "\n```"),
         options: res
     };
 }
diff --git a/docs/guide/cli/complete.md b/docs/guide/cli/complete.md
@@ -11,7 +11,5 @@ const commandDoc = docs.complete;
 {{commandDoc.description}}
 
 ## Usage
-```shell-vue
-{{commandDoc.usage}}
-```
+<div v-html="commandDoc.usageHtml"></div>
 <div v-html="commandDoc.options"></div>