feat(search): directly search processing reference

Author: Luke-zhang-04

scripts/fetchDocs.mjs

@@ -115,7 +115,7 @@ const escapeHTML = (html) =>
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("./src/documentation").DocumentationVariable>}
+ * @returns {Promise<import("../src/types").DocumentationVariable>}
  */
 const documentVariable = async (link) => {
     const documentation = {
@@ -177,7 +177,7 @@ const documentVariable = async (link) => {
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("./src/documentation").DocumentationFunction>}
+ * @returns {Promise<import("../src/types").DocumentationFunction>}
  */
 const documentFunction = async (link) => {
     const documentation = {
@@ -246,7 +246,7 @@ const documentFunction = async (link) => {
  * Gets the documentation for a single link
  *
  * @param {string} link - Link to get doc from
- * @returns {Promise<import("./src/documentation").DocumentationClass>}
+ * @returns {Promise<import("../src/types").DocumentationClass>}
  */
 const documentClass = async (link) => {
     const documentation = {
@@ -328,7 +328,7 @@ const documentLinks = async ({classLinks, functionLinks, variableLinks}) => {
     /**
      * All documentation (final object dumped to JSON)
      *
-     * @type {import("./src/documentation").Documentation}
+     * @type {import("../src/types").Documentation}
      */
     const documentation = {}
 

src/commands/search.ts

@@ -4,7 +4,7 @@
  * @copyright (C) 2016 - 2020 Tobiah Zarlez, 2021 Luke Zhang
  */
 
-import * as search from "../search"
+import {search} from "../utils"
 import vscode from "vscode"
 
 const openDocErrorMessage = async (str: string) => {

src/documentation.ts

@@ -4,6 +4,12 @@
  * @copyright (C) 2021 Luke Zhang
  */
 
+import type {
+    Documentation,
+    DocumentationClass,
+    DocumentationFunction,
+    DocumentationVariable,
+} from "./types"
 import documentation from "./documentation-data.yml"
 import vscode from "vscode"
 
@@ -22,7 +28,7 @@ const getHoveredItem = (line: string, position: number): string | undefined => {
         let index = position
 
         for (; index >= 0 && index < line.length; index--) {
-            if (!/[a-z]|[0-9]|_/iu.test(line[index])) {
+            if (!/[a-z]|[0-9]|_/iu.test(line[index]!)) {
                 break
             }
         }
@@ -34,7 +40,7 @@ const getHoveredItem = (line: string, position: number): string | undefined => {
         let index = position
 
         for (; index >= 0 && index < line.length; index++) {
-            if (!/[a-z]|[0-9]|_/iu.test(line[index])) {
+            if (!/[a-z]|[0-9]|_/iu.test(line[index]!)) {
                 break
             }
         }
@@ -45,35 +51,6 @@ const getHoveredItem = (line: string, position: number): string | undefined => {
     return line.slice(itemStart, itemEnd)
 }
 
-interface DocumentationVariable {
-    description: string
-    examples?: string
-    docUrl: string
-    type: "var" | "const"
-}
-
-interface DocumentationClass {
-    description: string
-    syntax: string
-    parameters: {[key: string]: string}
-    docUrl: string
-    type: "class"
-}
-
-interface DocumentationFunction {
-    description: string
-    syntax: string
-    parameters: {[key: string]: string}
-    returns: string
-    docUrl: string
-    type: "function"
-}
-
-/* prettier-ignore */
-export type Documentation = {
-    [key: string]: DocumentationFunction | DocumentationVariable | DocumentationClass
-};
-
 const documentVariable = (
     info: DocumentationVariable,
     item: keyof typeof documentation,

src/env.d.ts

@@ -1,5 +1,5 @@
 declare module "*.yml" {
-    declare const content: {[key: string]: unknown}
+    const content: {[key: string]: unknown}
 
     export default content
 }

src/types.d.ts

@@ -0,0 +1,27 @@
+export interface DocumentationClass {
+    description: string
+    syntax: string
+    parameters: {[key: string]: string}
+    docUrl: string
+    type: "class"
+}
+
+export interface DocumentationFunction {
+    description: string
+    syntax: string
+    parameters: {[key: string]: string}
+    returns: string
+    docUrl: string
+    type: "function"
+}
+
+export interface DocumentationVariable {
+    description: string
+    examples?: string
+    docUrl: string
+    type: "var" | "const"
+}
+
+export type Documentation = {
+    [key: string]: DocumentationFunction | DocumentationVariable | DocumentationClass
+}

src/utils.ts src/utils/index.tssrc/utils.ts renamed to src/utils/index.ts

@@ -4,5 +4,7 @@
  * @copyright (C) 2021 Luke Zhang
  */
 
+export * as search from "./search"
+
 export const isValidProcessingProject = (path?: string): boolean =>
     path !== undefined && /^[/_$a-z][/\w$]*$/iu.test(path)

src/search.ts src/utils/search.tssrc/search.ts renamed to src/utils/search.ts

@@ -4,7 +4,9 @@
  * @copyright (C) 2016 - 2020 Tobiah Zarlez, 2021 Luke Zhang
  */
 
-import {searchConfig} from "./config"
+import type {Documentation} from "../types"
+import documentation from "../documentation-data.yml"
+import {searchConfig} from "../config"
 import vscode from "vscode"
 
 const enum Urls {
@@ -16,15 +18,21 @@ const enum Urls {
     P5jsSearchDuckDuckGo = "https://duckduckgo.com/?q=!p5+",
 }
 
-export const openURL = async (searchBase?: string, url?: string) => {
+export const openURL = async (searchBase?: string, url?: string): Promise<void> => {
     if (searchBase === "open") {
         await vscode.env.openExternal(vscode.Uri.parse(url as string))
     } else {
         const {processingDocs, searchEngine} = searchConfig
         const searchUrl = ((): string => {
+            let docUrl: string | undefined
+
             if (searchBase === "docs") {
                 if (!url) {
                     return processingDocs === "p5js.org" ? Urls.P5jsDocs : Urls.ProcessingorgDocs
+                } else if (
+                    (docUrl = (documentation as Documentation)[url]?.docUrl) !== undefined
+                ) {
+                    return docUrl
                 } else if (searchEngine === "DuckDuckGo") {
                     return processingDocs === "p5js.org"
                         ? `${Urls.P5jsSearchDuckDuckGo}${url}`
@@ -42,7 +50,7 @@ export const openURL = async (searchBase?: string, url?: string) => {
         await vscode.env.openExternal(vscode.Uri.parse(searchUrl))
     }
 
-    return true
+    return
 }
 
 // Slice and Trim
@@ -53,17 +61,8 @@ export const prepareInput = (input: string, start: number, end: number) => {
         return ""
     }
 
-    // Slice to the selection
-    input = input.slice(start, end)
-
-    // Trim white space
-    input = input.trim()
-
-    // Possible future addition:
-    // Check right here if valid variable/function name to search?
-
     // Everything looks good by this point, so time to open a web browser!
-    return input
+    return input.slice(start, end).trim()
 }
 
 export const openProcessingDocs = (input: string, start: number, end: number) => {