feat: ai assisted renaming

Author: coder-hxl

packages/ai/index.ts

@@ -1,11 +1,12 @@
 import OpenAI, { ClientOptions } from 'openai'
+import ora from 'ora'
 
 import {
   PARSE_ELEMENTS_CONTEXT,
   GET_ELEMENT_SELECTORS_CONTEXT,
   HELP_CONTEXT
 } from './context'
-import { isObject, log, logStart, logSuccess } from '../shared'
+import { isObject } from '../shared'
 
 type OpenAIChatModel =
   | 'gpt-4-0125-preview'
@@ -26,75 +27,75 @@ type OpenAIChatModel =
   | 'gpt-3.5-turbo-0125'
   | 'gpt-3.5-turbo-16k-0613'
 
-interface CreateXCrawlOpenAIConfig {
+interface CreateCrawlOpenAIConfig {
   defaultModel?: {
     chatModel: OpenAIChatModel
   }
   clientOptions?: ClientOptions
 }
 
-interface XCrawlOpenAICommonAPIOtherOption {
+interface CrawlOpenAICommonAPIOtherOption {
   model?: OpenAIChatModel
 }
 
-interface XCrawlOpenAIRunChatOption {
+interface CrawlOpenAIRunChatOption {
   model: OpenAIChatModel | undefined
   context: string
   HTMLContent: string
   userContent: string
   responseFormatType: 'text' | 'json_object'
 }
 
-interface XCrawlOpenAIParseElementsContentOptions {
+interface CrawlOpenAIParseElementsContentOptions {
   message: string
 }
 
-interface XCrawlOpenAIGetElementSelectorsContentOptions {
+interface CrawlOpenAIGetElementSelectorsContentOptions {
   message: string
   pathMode: 'default' | 'strict'
 }
 
-interface XCrawlOpenAIGetElementSelectorsResult {
+interface CrawlOpenAIGetElementSelectorsResult {
   selectors: string
   type: 'single' | 'multiple' | 'none'
 }
 
-interface XCrawlOpenAIParseElementsResult<T extends Record<string, string>> {
+interface CrawlOpenAIParseElementsResult<T extends Record<string, string>> {
   elements: T[]
   type: 'single' | 'multiple' | 'none'
 }
 
-interface XCrawlOpenAIApp {
+interface CrawlOpenAIApp {
   parseElements<T extends Record<string, string>>(
     HTML: string,
-    content: string | XCrawlOpenAIParseElementsContentOptions,
-    option?: XCrawlOpenAICommonAPIOtherOption
-  ): Promise<XCrawlOpenAIParseElementsResult<T>>
+    content: string | CrawlOpenAIParseElementsContentOptions,
+    option?: CrawlOpenAICommonAPIOtherOption
+  ): Promise<CrawlOpenAIParseElementsResult<T>>
 
   getElementSelectors(
     HTML: string,
-    content: string | XCrawlOpenAIGetElementSelectorsContentOptions,
-    option?: XCrawlOpenAICommonAPIOtherOption
-  ): Promise<XCrawlOpenAIGetElementSelectorsResult>
+    content: string | CrawlOpenAIGetElementSelectorsContentOptions,
+    option?: CrawlOpenAICommonAPIOtherOption
+  ): Promise<CrawlOpenAIGetElementSelectorsResult>
 
   help(
     content: string,
-    option?: XCrawlOpenAICommonAPIOtherOption
+    option?: CrawlOpenAICommonAPIOtherOption
   ): Promise<string>
 
   custom(): OpenAI
 }
 
-export function createXCrawlOpenAI(
-  config: CreateXCrawlOpenAIConfig = {}
-): XCrawlOpenAIApp {
+export function createCrawlOpenAI(
+  config: CreateCrawlOpenAIConfig = {}
+): CrawlOpenAIApp {
   const { defaultModel, clientOptions } = config
 
   const openai = new OpenAI(clientOptions)
   const chatDefaultModel: OpenAIChatModel =
     defaultModel?.chatModel ?? 'gpt-3.5-turbo'
 
-  async function runChat<T>(option: XCrawlOpenAIRunChatOption): Promise<T> {
+  async function runChat<T>(option: CrawlOpenAIRunChatOption): Promise<T> {
     const {
       model = chatDefaultModel,
       context,
@@ -103,7 +104,9 @@ export function createXCrawlOpenAI(
       responseFormatType
     } = option
 
-    log(logStart(`AI is answering your question, please wait a moment`))
+    const spinner = ora(
+      `AI is answering your question, please wait a moment`
+    ).start()
     const completion = await openai.chat.completions.create({
       model,
       messages: [
@@ -114,7 +117,7 @@ export function createXCrawlOpenAI(
       response_format: { type: responseFormatType },
       temperature: 0.1
     })
-    log(logSuccess(`AI has completed your question`))
+    spinner.succeed(`AI has completed your question`)
 
     const content = completion.choices[0].message.content
     const result =
@@ -123,25 +126,25 @@ export function createXCrawlOpenAI(
     return result
   }
 
-  const app: XCrawlOpenAIApp = {
+  const app: CrawlOpenAIApp = {
     async parseElements<T extends Record<string, string>>(
       HTML: string,
-      content: string | XCrawlOpenAIParseElementsContentOptions,
-      option: XCrawlOpenAICommonAPIOtherOption = {}
-    ): Promise<XCrawlOpenAIParseElementsResult<T>> {
+      content: string | CrawlOpenAIParseElementsContentOptions,
+      option: CrawlOpenAICommonAPIOtherOption = {}
+    ): Promise<CrawlOpenAIParseElementsResult<T>> {
       const { model } = option
 
       let coderContent: string = ''
       if (isObject(content)) {
         coderContent = JSON.stringify(content)
       } else {
-        const obj: XCrawlOpenAIParseElementsContentOptions = {
+        const obj: CrawlOpenAIParseElementsContentOptions = {
           message: content
         }
         coderContent = JSON.stringify(obj)
       }
 
-      const result = await runChat<XCrawlOpenAIParseElementsResult<T>>({
+      const result = await runChat<CrawlOpenAIParseElementsResult<T>>({
         model,
         context: PARSE_ELEMENTS_CONTEXT,
         HTMLContent: HTML,
@@ -154,23 +157,23 @@ export function createXCrawlOpenAI(
 
     async getElementSelectors(
       HTML: string,
-      content: string | XCrawlOpenAIGetElementSelectorsContentOptions,
-      option: XCrawlOpenAICommonAPIOtherOption = {}
-    ): Promise<XCrawlOpenAIGetElementSelectorsResult> {
+      content: string | CrawlOpenAIGetElementSelectorsContentOptions,
+      option: CrawlOpenAICommonAPIOtherOption = {}
+    ): Promise<CrawlOpenAIGetElementSelectorsResult> {
       const { model } = option
 
       let coderContent: string = ''
       if (isObject(content)) {
         coderContent = JSON.stringify(content)
       } else {
-        const obj: XCrawlOpenAIGetElementSelectorsContentOptions = {
+        const obj: CrawlOpenAIGetElementSelectorsContentOptions = {
           message: content,
           pathMode: 'default'
         }
         coderContent = JSON.stringify(obj)
       }
 
-      const result = await runChat<XCrawlOpenAIGetElementSelectorsResult>({
+      const result = await runChat<CrawlOpenAIGetElementSelectorsResult>({
         model,
         context: GET_ELEMENT_SELECTORS_CONTEXT,
         HTMLContent: HTML,
@@ -183,7 +186,7 @@ export function createXCrawlOpenAI(
 
     async help(
       content: string,
-      option: XCrawlOpenAICommonAPIOtherOption = {}
+      option: CrawlOpenAICommonAPIOtherOption = {}
     ): Promise<string> {
       const { model } = option
 

packages/index.ts

@@ -1,2 +1,2 @@
 export { createCrawl } from './crawl'
-export { createXCrawlOpenAI } from './ai'
+export { createCrawlOpenAI } from './ai'