Feat/split extension package

.eslintrc.cjs

@@ -27,7 +27,7 @@ module.exports = {
     'no-multi-assign': 'off',
     'consistent-return': 'off',
     'no-restricted-exports': 'off',
-    'linebreak-style': ['error', 'unix'],
+    'linebreak-style': 'off',
     'no-unused-vars': 'off',
     'import/order': 'off',
     'import/no-relative-packages': 'off',

.npmrc

@@ -1 +1,6 @@
-enable-pre-post-scripts = true
+enable-pre-post-scripts = true
+link-workspace-packages = true
+prefer-workspace-packages = true
+recursive-install = true
+# 使用淘宝镜像源
+registry = https://registry.npmmirror.com

package.json

@@ -1,65 +1,21 @@
 {
-  "name": "alova-vscode-extension",
+  "name": "@alova/devtools",
   "displayName": "Alova",
-  "description": "Generate and search APIs without API documentation any more",
-  "version": "0.0.10",
+  "description": "The devtools for alova.js",
+  "version": "0.0.9",
   "engines": {
-    "vscode": "^1.89.0",
     "node": ">=18.19.0",
     "pnpm": ">=8.6.12"
   },
-  "categories": [
-    "Other"
-  ],
-  "activationEvents": [
-    "workspaceContains:**/*.ts",
-    "workspaceContains:**/*.js"
-  ],
-  "main": "./out/extension.js",
-  "icon": "resources/icon.png",
-  "contributes": {
-    "commands": [
-      {
-        "command": "Generate APIs",
-        "category": "Alova",
-        "title": "alova refresh"
-      }
-    ],
-    "icons": {
-      "alova-icon-id": {
-        "description": "alova icon",
-        "default": {
-          "fontPath": "./resources/logo.ttf",
-          "fontCharacter": "\\E900"
-        }
-      }
-    }
-  },
   "scripts": {
-    "vscode:prepublish": "pnpm run package",
-    "compile": "pnpm run check-types && pnpm run lint:fix && tsx esbuild.ts",
-    "watch": "npm-run-all -p watch:*",
-    "watch:esbuild": "tsx esbuild.ts --watch",
-    "watch:tsc": "tsc --noEmit --watch --project tsconfig.json",
-    "package": "pnpm run check-types && pnpm run lint:fix && tsx esbuild.ts --production",
-    "compile-tests": "tsc -p . --outDir out",
-    "watch-tests": "tsc -p . -w --outDir out",
-    "pretest": "pnpm run compile-tests && pnpm run compile && pnpm run lint",
-    "check-types": "tsc --noEmit",
     "lint": "eslint . --ext .js,.ts",
     "lint:fix": "npm run lint -- --fix",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "test": "vscode-test",
     "api-test": "tsx scripts/api-test.ts",
     "commit": "git-cz && git push",
-    "prepare": "husky && pnpm api-test",
-    "pack:pre": "vsce package --no-dependencies --pre-release",
-    "release:pre": "vsce publish --no-dependencies --pre-release",
-    "pack": "vsce package --no-dependencies",
-    "release": "vsce publish --no-dependencies"
+    "prepare": "husky && pnpm api-test"
   },
-  "publisher": "Alova",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -73,26 +29,20 @@
     "*.js,*.ts": "npm run lint:fix"
   },
   "devDependencies": {
+    "@alova/wormhole": "workspace:^",
     "@commitlint/cli": "^19.3.0",
     "@commitlint/config-conventional": "^19.2.2",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.5",
     "@types/mocha": "^10.0.6",
-    "@types/mustache": "^4.2.5",
     "@types/node": "18.x",
     "@types/node-fetch": "^2.6.11",
     "@types/serialize-javascript": "^5.0.4",
     "@types/swagger2openapi": "^7.0.4",
-    "@types/vscode": "^1.89.0",
     "@typescript-eslint/eslint-plugin": "^7.13.0",
     "@typescript-eslint/parser": "^7.13.0",
-    "@vscode/test-cli": "^0.0.9",
-    "@vscode/test-electron": "^2.3.9",
-    "@vscode/vsce": "^2.29.0",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "esbuild": "^0.23.0",
-    "esbuild-plugin-alias": "^0.2.1",
     "eslint": "^8.57.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^18.0.0",
@@ -121,7 +71,6 @@
     "lodash": "^4.17.21",
     "node-fetch": "^2.7.0",
     "openapi-types": "^12.1.3",
-    "serialize-javascript": "^6.0.2",
     "swagger2openapi": "^7.0.8"
   }
 }

packages/templates/alova.config.handlebars

@@ -0,0 +1,71 @@
+{{#if (eq type "typescript")}}import type { Config } from '@alova/wormhole';
+
+
+{{/if}}// For more config detailed visit:
+// https://alova.js.org/tutorial/getting-started/extension-integration
+{{#if (not type "typescript")}}/** 
+ * @type {{#raw "{ " }}{{/raw}}import('@alova/wormhole').Config{{#raw " }" }}{{/raw}} 
+ */{{/if}}
+ {{#if (eq moduleType "ESModule")}}export default {{#if (eq type "typescript")}}<Config>{{/if}}{{else if (eq moduleType "commonJs")}}module.exports ={{/if}}{{#raw "{ " }}{{/raw}}
+  generator: [
+    {
+      /** 
+       * file input. support:
+       * 1. openapi json file url
+       * 2. local file
+       */
+      input: 'http://localhost:3000',
+
+      /** 
+       * input file platform. Currently only swagger is supported.
+       * When this parameter is specified, the input field only needs to specify the document address without specifying the openapi file
+       */
+      platform: 'swagger',
+
+      /** 
+       * output path of interface file and type file.
+       * Multiple generators cannot have the same address, otherwise the generated code will overwrite each other.
+       */
+      output: 'src/api',
+
+      /**
+       * the mediaType of the generated response data. default is `application/json`
+       */
+      // responseMediaType: 'application/json',
+
+      /**
+       * the bodyMediaType of the generated request body data. default is `application/json`
+       */
+      // bodyMediaType: 'application/json',
+
+      /**
+       * the generated api version. options are `2` or `3`, default is `auto`.
+       */
+      // version: 'auto',
+
+      /**
+       * type of generated code. The options ​​are `auto/ts/typescript/module/commonjs`.
+       */
+      // type: 'auto',
+
+      /**
+       * exported global api name, you can access the generated api globally through this name, default is `Apis`.
+       * it is required when multiple generators are configured, and it cannot be repeated
+       */
+      // global: 'Apis',
+
+      /**
+       * filter or convert the generated api information, return an apiDescriptor, if this function is not specified, the apiDescripor object is not converted
+       */
+      // handleApi: apiDescriptor => {
+      //  return apiDescriptor;
+      // }
+    }
+  ],
+
+  /** 
+   * extension only
+   * whether to automatically update the interface, enabled by default, check every 5 minutes, closed when set to `false`
+   */
+  // autoUpdate: true
+{{#raw "};" }}{{/raw}}

templates/commonjs/createApis.handlebars → packages/templates/commonjs/createApis.handlebars

@@ -21,7 +21,7 @@ const createFunctionalProxy = (array, alovaInstance, configMap) => {
       const apiPathKey = array.join('.');
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

templates/commonjs/v3-createApis.handlebars → packages/templates/commonjs/v3-createApis.handlebars

@@ -24,7 +24,7 @@ const createFunctionalProxy = (array, alovaInstance, configMap) => {
       const apiPathKey = array.join('.');
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

packages/templates/index.ts

@@ -0,0 +1 @@
+export default (filePath: string) => import(`./${filePath}.handlebars`);

templates/module/createApis.handlebars → packages/templates/module/createApis.handlebars

@@ -21,7 +21,7 @@ const createFunctionalProxy = (array, alovaInstance, configMap) => {
       const apiPathKey = array.join('.');
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

templates/module/v3-createApis.handlebars → packages/templates/module/v3-createApis.handlebars

@@ -24,7 +24,7 @@ const createFunctionalProxy = (array, alovaInstance, configMap) => {
       const apiPathKey = array.join('.');
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

packages/templates/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@alova/templates",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.ts",
+  "module": "index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

templates/typescript/createApis.handlebars → packages/templates/typescript/createApis.handlebars

@@ -20,7 +20,7 @@ const createFunctionalProxy = (
       const apiPathKey = array.join('.') as keyof typeof apiDefinitions;
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

templates/typescript/v3-createApis.handlebars → packages/templates/typescript/v3-createApis.handlebars

@@ -25,7 +25,7 @@ const createFunctionalProxy = (
       const apiPathKey = array.join('.') as keyof typeof apiDefinitions;
       const apiItem = apiDefinitions[apiPathKey];
       if (!apiItem) {
-        throw new Error(`the api path of \`${apiItem}\` is not found`);
+        throw new Error(`the api path of \`${apiPathKey}\` is not found`);
       }
       const mergedConfig = {
         ...configMap[apiPathKey],

.vscodeignore → packages/vscode-extension/.vscodeignore

@@ -14,5 +14,7 @@ vsc-extension-quickstart.md
 pnpm-lock.yaml
 pnpm-workspace.yaml
 design/**
+templates/**
+packages/**
 test/**
 .husky/**

packages/vscode-extension/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "helloworld" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release

packages/vscode-extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 alovajs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/vscode-extension/README.md

@@ -0,0 +1,27 @@
+# VSCode extension for alova
+
+## features
+
+1. Automatically generate request code and response data types, and experience IntelliSense for response in js projects.
+2. Embed API documents in the code to experience the effect of checking and using APIs.
+3. Update APIs regularly and actively notify front-end developers, no longer relying on server-side developers to notify.
+
+> [Detailed documentation](https://alova.js.org/tutorial/getting-started/extension-integration).
+
+## View API completed information
+
+You can view the complted API information in the Editor with the IntelliSense feature.
+
+![](https://alova.js.org/img/vscode-api-doc.png)
+
+## Quick access to API
+
+Using the trigger word `a->` to trigger apis quick positioning.
+
+### Search by url
+
+![](https://alova.js.org/img/vscode-query-with-url.png)
+
+### Search by description
+
+![](https://alova.js.org/img/vscode-query-with-description.png)

esbuild.ts → packages/vscode-extension/esbuild.ts

@@ -25,6 +25,9 @@ const esbuildProblemMatcherPlugin: Plugin = {
 async function main() {
   const ctx = await esbuild.context({
     entryPoints: ['src/extension.ts', 'src/work.ts'],
+    loader: {
+      '.handlebars': 'text'
+    },
     bundle: true,
     format: 'cjs',
     minify: production,