feat: commands & context menu nuxt and nitro utils

adhamfarrag · web-flow · commit a8e0396354fc · 2023-09-09T17:31:10.000+08:00
feat: commands &amp; context menu nuxt and nitro utils
diff --git a/package.json b/package.json
@@ -180,6 +180,10 @@
                     "command": "nuxtr.createPlugin",
                     "when": "nuxtr.isNuxtProject"
                 },
+                {
+                    "command": "nuxtr.createUtil",
+                    "when": "nuxtr.isNuxtProject"
+                },
                 {
                     "command": "nuxtr.createMiddleware",
                     "when": "nuxtr.isNuxtProject"
@@ -403,6 +407,11 @@
                     "when": "( nuxtr.isNuxtProject && resourceFilename =~ /(plugins.*)/) || ( nuxtr.isNuxtProject && resourceDirname =~ /(plugins.*)/ && explorerResourceIsFolder)",
                     "group": "navigation"
                 },
+                {
+                    "command": "nuxtr.directCreateUtil",
+                    "when": "( nuxtr.isNuxtProject && resourceFilename =~ /(utils.*)/) || ( nuxtr.isNuxtProject && resourceDirname =~ /(utils.*)/ && explorerResourceIsFolder)",
+                    "group": "navigation"
+                },
                 {
                     "command": "nuxtr.directCreateComposable",
                     "when": "( nuxtr.isNuxtProject && resourceFilename =~ /(composables.*)/) || ( nuxtr.isNuxtProject && resourceDirname =~ /(composables.*)/ && explorerResourceIsFolder)",
@@ -599,18 +608,36 @@
                 "category": "Nuxtr",
                 "when": "nuxtr.isNuxtProject"
             },
+            {
+                "command": "nuxtr.createUtil",
+                "title": "Create new Utility",
+                "category": "Nuxtr",
+                "when": "nuxtr.isNuxtProject"
+            },
             {
                 "command": "nuxtr.createNitroPlugin",
                 "title": "Create new Nitro Plugin",
                 "category": "Nuxtr",
                 "when": "nuxtr.isNuxtProject"
             },
+            {
+                "command": "nuxtr.createNitroUtil",
+                "title": "Create new Nitro Utility",
+                "category": "Nuxtr",
+                "when": "nuxtr.isNuxtProject"
+            },
             {
                 "command": "nuxtr.directCreatePlugin",
                 "title": "New Plugin...",
                 "category": "Nuxtr",
                 "when": "nuxtr.isNuxtProject"
             },
+            {
+                "command": "nuxtr.directCreateUtil",
+                "title": "New Utility...",
+                "category": "Nuxtr",
+                "when": "nuxtr.isNuxtProject"
+            },
             {
                 "command": "nuxtr.createMiddleware",
                 "title": "Create new Middleware",
@@ -629,12 +656,6 @@
                 "category": "Nuxtr",
                 "when": "nuxtr.isNuxtProject"
             },
-            {
-                "command": "nuxtr.createNitroPlugin",
-                "title": "Create new Nitro Plugin",
-                "category": "Nuxtr",
-                "when": "nuxtr.isNuxtProject"
-            },
             {
                 "command": "nuxtr.createNitroMiddleware",
                 "title": "Create new Nitro Middleware",
diff --git a/src/commands/Nitro.ts b/src/commands/Nitro.ts
@@ -1,6 +1,6 @@
 import { window } from 'vscode'
 import { projectSrcDirectory, createSubFolders, showSubFolderQuickPick, createFile, hasServerDir, createDir } from '../utils'
-import { nitroDefaultTemplate, nitroPluginTemplate } from '../templates/typeScriptFiles'
+import { nitroDefaultTemplate, nitroPluginTemplate, nitroUtilTemplate } from '../templates/typeScriptFiles'
 
 let serverDir = `${projectSrcDirectory()}/${hasServerDir()}/`
 
@@ -83,6 +83,32 @@ const createNitroPlugin = () => {
         })
 }
 
+const createNitroUtil = () => {
+    const utilsDir = `${serverDir}/plugins`
+
+    window
+        .showInputBox({
+            prompt: 'What is your utility name?',
+            placeHolder: 'Utility name',
+        })
+        .then((name) => {
+            if (!name) { return }
+
+
+            createDir('server')
+            createDir('server/plugins')
+
+            let subFolders = createSubFolders(utilsDir, 'nitroUtil')
+
+            showSubFolderQuickPick({
+                name,
+                subFolders: subFolders,
+                commandType: 'nitroUtil',
+                content: nitroUtilTemplate
+            })
+        })
+}
+
 const createNitroMiddleware = () => {
     const middlewareDir = `${serverDir}/middleware`
 
@@ -159,5 +185,6 @@ export {
     createNitroRoute,
     directCreateNitroRoute,
     createNitroPlugin,
-    createNitroMiddleware
+    createNitroMiddleware,
+    createNitroUtil
 }
diff --git a/src/commands/Util.ts b/src/commands/Util.ts
@@ -0,0 +1,53 @@
+import { window } from 'vscode'
+import { projectSrcDirectory, createSubFolders, showSubFolderQuickPick, createFile, createDir, hasServerDir } from '../utils'
+import { nuxtUtilTemplate, nitroUtilTemplate } from '../templates/typeScriptFiles'
+
+const createUtil = () => {
+    window
+        .showInputBox({
+            prompt: 'What is your utility name?',
+            placeHolder: 'utility name',
+        })
+        .then((name) => {
+            if (!name) {return}
+
+            let utilsDir = `${projectSrcDirectory()}/utils`
+
+            createDir('utils')
+
+            let subFolders = createSubFolders(utilsDir, 'nuxtUtil')
+
+            showSubFolderQuickPick({
+                name,
+                subFolders: subFolders,
+                commandType: 'nuxtUtil',
+                content: nuxtUtilTemplate(name)
+            })
+
+        })
+}
+
+
+const directCreateUtil = (path: string) => {
+    const serverDir = hasServerDir()
+
+    window
+        .showInputBox({
+            prompt: 'What is your utility name?',
+            placeHolder: 'utility name',
+        })
+        .then((name) => {
+            if (!name) {return}
+
+            let filePath = `${path}/${name}.ts`
+
+
+            createFile({
+                fileName: `${name}.ts`,
+                content: filePath.includes(`${serverDir}`) ? nitroUtilTemplate : nuxtUtilTemplate(name),
+                fullPath: filePath,
+            })
+        })
+}
+
+export { createUtil, directCreateUtil }
diff --git a/src/commands/index.ts b/src/commands/index.ts
@@ -4,7 +4,7 @@ import { createComposable, directCreateComposable } from './Composable'
 import { createLayout, directCreateLayout } from './Layout'
 import { createPlugin, directCreatePlugin } from './Plugin'
 import { createMiddleware, directCreateMiddleware } from './Middleware'
-import { createNitroAPI, directCreateNitroAPI, createNitroRoute, directCreateNitroRoute, createNitroPlugin, createNitroMiddleware } from './Nitro'
+import { createNitroAPI, directCreateNitroAPI, createNitroRoute, directCreateNitroRoute, createNitroPlugin, createNitroMiddleware, createNitroUtil } from './Nitro'
 import { projectStructure, appConfig, nuxtIgnore, nuxtRC } from './Structure'
 import { openDocumentation, openModules } from './externalLinks'
 import { nuxtDev, nuxtBuild, nuxtGenerate, nuxtCleanUp, nuxtBuildModule, nuxtAnalyze, nuxtInfo, } from './TerminalCommands'
@@ -16,6 +16,7 @@ import { configureCSS } from './CSS'
 import { configureLinters } from './Linters'
 import { createPageTemplate, createLayoutTemplate, createFileFromTemplate, createEmptyFileTemplate } from './FileTemplates'
 import { nuxtConfigWatcher, directToggleDevTools } from './Devtools'
+import { createUtil, directCreateUtil } from './Util'
 
 
 const commands = {
@@ -37,6 +38,9 @@ const commands = {
     directCreateNitroRoute,
     createNitroPlugin,
     createNitroMiddleware,
+    createUtil,
+    createNitroUtil,
+    directCreateUtil,
     projectStructure,
     openDocumentation,
     openModules,
diff --git a/src/extension.ts b/src/extension.ts
@@ -16,9 +16,11 @@ const commandList = [
     { command: 'nuxtr.createMiddleware', function: nuxtrCommands.createMiddleware },
     { command: 'nuxtr.createNitroAPI', function: nuxtrCommands.createNitroAPI },
     { command: 'nuxtr.createNitroPlugin', function: nuxtrCommands.createNitroPlugin },
+    { command: 'nuxtr.createNitroUtil', function: nuxtrCommands.createNitroUtil },
     { command: 'nuxtr.createNitroMiddleware', function: nuxtrCommands.createNitroMiddleware },
     { command: 'nuxtr.createNitroRoute', function: nuxtrCommands.createNitroRoute },
     { command: 'nuxtr.createStore', function: nuxtrCommands.createStore },
+    { command: 'nuxtr.createUtil', function: nuxtrCommands.createUtil },
     { command: 'nuxtr.projectStructure', function: nuxtrCommands.projectStructure },
     { command: 'nuxtr.openDocumentation', function: nuxtrCommands.openDocumentation },
     { command: 'nuxtr.openModules', function: nuxtrCommands.openModules },
@@ -52,6 +54,7 @@ const commandList = [
     { command: 'nuxtr.directCreateNitroAPI', function: (filePath: Uri) => nuxtrCommands.directCreateNitroAPI(filePath.path) },
     { command: 'nuxtr.directCreateNitroRoute', function: (filePath: Uri) => nuxtrCommands.directCreateNitroRoute(filePath.path) },
     { command: 'nuxtr.directCreateStore', function: (filePath: Uri) => nuxtrCommands.directCreateStore(filePath.path) },
+    { command: 'nuxtr.directCreateUtil', function: (filePath: Uri) => nuxtrCommands.directCreateUtil(filePath.path) },
 ];
 
 // categorize commands and functions
diff --git a/src/templates/typeScriptFiles.ts b/src/templates/typeScriptFiles.ts
@@ -28,4 +28,24 @@ export const nuxtPluginTemplate = `export default defineNuxtPlugin((nuxtApp) =>
 export const nitroPluginTemplate = `export default defineNitroPlugin((nitroApp) => {
 
 })
-`
+`
+
+export const nuxtUtilTemplate = (name: string) => `export default () => {
+  return 'Hello Util'
+}
+`
+
+export const nitroUtilTemplate =`import type { EventHandler, EventHandlerRequest } from 'h3'
+
+export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
+  handler: EventHandler<T, D>
+): EventHandler<T, D> =>
+    defineEventHandler<T>(async (event) => {
+      try {
+        return { response }
+      } catch (err) {
+      // Error handling
+        return { err }
+      }
+    })
+`
diff --git a/src/utils/commands.ts b/src/utils/commands.ts
@@ -84,6 +84,20 @@ const getCommandType = (commandType: string) => {
                 extension: '.ts',
             };
             break;
+        case 'nuxtUtil':
+            type = {
+                name: 'Utilities',
+                path: `utils`,
+                extension: '.ts',
+            };
+            break;
+        case 'nitroUtil':
+            type = {
+                name: 'Utility',
+                path: `${hasServerDir()}/utils`,
+                extension: '.ts',
+            };
+            break;
         default:
             // show error message
             type = {
