chore: support vscode

Author: brandonxiang

packages/core/CHANGELOG.md

@@ -1,5 +1,11 @@
 # pbts
 
+## 4.0.6
+
+### Patch Changes
+
+- support vscode for new feature
+
 ## 4.0.5
 
 ### Patch Changes

packages/core/README.md

@@ -8,7 +8,7 @@
 [download-image]: https://img.shields.io/npm/dm/pbts.svg?style=flat-square
 [download-url]: https://www.npmjs.com/package/pbts
 
-It is the cli for pbts. You can convert pb to ts file by command line
+It is the cli for pbts. You can convert protobuf to typescript file by command line
 
 ## CLI Usage
 
@@ -20,12 +20,32 @@ step 1 Install pbts
 npm i pbts -g
 ```
 
-step 2 Convert your protobuffer to Typescript Definition File
+step 2 Convert your protobuf to Typescript Definition File
 
 ```shell
 pbts -i input/app/order.proto -o output/order.ts
 ```
 
+```shell
+
+  Description
+    convert based on local protobuf
+
+  Usage
+    $ pbts [options]
+
+  Options
+    -i, --input                    input file path
+    -o, --output                   output file path
+    -outputType, --<outputType>    output file type, including typescript,definition,jsdoc, default typescript
+    -mode, --<mode>                edge case for int64(long type), including normal,strict, default strict
+    -v, --version                  Displays current version
+    -h, --help                     Displays this message
+
+  Examples
+    $ pbts -i test.proto -o test.ts
+```
+
 ### No Installation
 
 Please use npx for short.
@@ -48,9 +68,16 @@ message MyRequest {
 }
 `;
 
-const ts = parseProto(source);
+const ts = parseProto(source, {
+  // Options
+});
 ```
 
+parameter | type | description
+---------|----------|---------
+ outputType | string | output file type, including typescript,definition,jsdoc, default typescript
+ mode | string | edge case for int64(long type), including normal,strict, default strict
+
 The result is as follow.
 
 ```typescript
@@ -61,6 +88,8 @@ interface MyRequest {
 
 ## Node Library Usage
 
+More file operation is supported.
+
 ```javascript
 import { parseProto } from 'pbts';
 

packages/core/bin.js

@@ -22,7 +22,7 @@ updater({
     .option('-i, --input <input>', 'input file path')
     .option('-o, --output <output>', 'output file path')
     .option('--outputType <outputType>', 'output file type, including typescript,definition,jsdoc, default typescript')
-    .option('--mode <mode>', 'edge case for int64(long type), including normal,strict, default normal')
+    .option('--mode <mode>', 'edge case for int64(long type), including normal,strict, default strict')
     .action(convertCommand);
 
   prog.parse(process.argv);

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pbts",
-  "version": "4.0.5",
+  "version": "4.0.6",
   "description": "protobuf-to-typescript",
   "author": "weiping.xiang <[email protected]>",
   "homepage": "https://github.com/brandonxiang/protobuf-to-typescript#readme",

packages/core/src/core.js

@@ -14,7 +14,7 @@ const { Root, Enum, Service, Type } = protobuf;
  */
 const defaultOptions = {
   outputType: 'typescript',
-  mode: 'normal',
+  mode: 'strict',
 };
 
 /**

packages/core/tests/mock/int64.spec.js

@@ -24,7 +24,7 @@ test('Method type should be converted to number', () => {
       Teacher teacher = 3;
   }
   `;
-  const ts = mockResponse(source, 'SayHello');
+  const ts = mockResponse(source, 'SayHello', { mode: 'normal' });
   assert.equal(ts, {
     message: 'Hello',
     test: 20,

packages/core/tests/print/int64.spec.js

@@ -9,7 +9,7 @@ test('Field type with uint64 should be converted to number', () => {
     uint64 path = 1;
   }
   `;
-  const ts = parseProto(source);
+  const ts = parseProto(source,  { mode: 'normal' });
   assert.match(ts, 'interface MyRequest');
   assert.match(ts, 'path?: number');
 });
@@ -33,7 +33,7 @@ test('Field type with sint64 should be converted to number', () => {
     sint64 path = 1;
   }
   `;
-  const ts = parseProto(source);
+  const ts = parseProto(source,   { mode: 'normal' });
   assert.match(ts, 'interface MyRequest');
   assert.match(ts, 'path?: number');
 });
@@ -57,7 +57,7 @@ test('Field type with fixed64 should be converted to number', () => {
     fixed64 path = 1;
   }
   `;
-  const ts = parseProto(source);
+  const ts = parseProto(source,   { mode: 'normal' });
   assert.match(ts, 'interface MyRequest');
   assert.match(ts, 'path?: number');
 });
@@ -82,7 +82,7 @@ test('Field type with sfixed64 should be converted to number', () => {
     sfixed64 path = 1;
   }
   `;
-  const ts = parseProto(source);
+  const ts = parseProto(source,   { mode: 'normal' });
   assert.match(ts, 'interface MyRequest');
   assert.match(ts, 'path?: number');
 });

packages/vscode/README.md

@@ -28,6 +28,19 @@ We provide two ways to **convert protobuf to typescript**.
 
 - STEP 3: Search **"pbts:from clipboard"**, execute，the converted typescript will be filled at the cursor of the currently active window
 
+### Settings
+
+Users can then control this setting by creating a .vscode/settings.json file in their project root
+
+```json
+{
+  //Specify the output type for the converted files
+  "protobufToTypescript.outputType": "jsdoc",
+  //Specify the edge case for int64(long type)
+  "protobufToTypescript.mode": "strict"
+}
+```
+
 ## Problem
 
-If you have any questions, you can contact me by email **@kukudeshiyi1999@gmail.com**
+If you have any questions, you can contact me by email **@brandon.xiang@gmail.com**

packages/vscode/package.json

@@ -13,62 +13,81 @@
 	"categories": [
 		"Other"
 	],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/brandonxiang/protobuf-to-typescript.git"
-  },
-	"activationEvents": [
-		"onCommand:pbToTypescript.fromSelection",
-		"onCommand:pbToTypescript.fromClipboard",
-		"onCommand:pbToTypescript.convertOnAir"
-	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/brandonxiang/protobuf-to-typescript.git"
+	},
 	"main": "./out/extension.js",
 	"contributes": {
+		"configuration": {
+			"title": "Protobuf to TypeScript",
+			"properties": {
+				"protobufToTypescript.outputType": {
+					"type": "string",
+					"enum": [
+						"jsdoc",
+						"typescript",
+						"definition"
+					],
+					"default": "typescript",
+					"description": "Specify the output type for the converted files"
+				},
+				"protobufToTypescript.mode": {
+					"type": "string",
+					"enum": [
+						"normal",
+						"strict"
+					],
+					"default": "strict",
+					"description": "Specify the edge case for int64(long type)"
+				}
+			}
+		},
 		"commands": [
 			{
-				"command": "pbToTypescript.fromSelection",
+				"command": "protobufToTypescript.fromSelection",
 				"title": "from selection",
 				"category": "pbts"
 			},
 			{
-				"command": "pbToTypescript.fromClipboard",
+				"command": "protobufToTypescript.fromClipboard",
 				"title": "from clipboard",
 				"category": "pbts"
 			},
 			{
-        "command": "pbToTypescript.transformOnPanel",
-        "title": "Open Convert Panel",
-        "category": "pbts"
-      }
+				"command": "protobufToTypescript.transformOnPanel",
+				"title": "Open Convert Panel",
+				"category": "pbts"
+			}
 		],
-    "viewsContainers": {
-      "activitybar": [
-        {
-          "id": "pbts",
-          "title": "protobuf to typescript",
-          "icon": "media/cat2.svg"
-        }
-      ]
-    },
-    "views": {
-      "pbts": [
-        {
-          "id": "introduction",
-          "name": "welcome to pbts"
-        }
-      ]
-    },
+		"viewsContainers": {
+			"activitybar": [
+				{
+					"id": "pbts",
+					"title": "protobuf to typescript",
+					"icon": "media/cat2.svg"
+				}
+			]
+		},
+		"views": {
+			"pbts": [
+				{
+					"id": "introduction",
+					"name": "welcome to pbts"
+				}
+			]
+		},
 		"viewsWelcome": [
-      {
-        "view": "introduction",
-        "contents": "This tool is able to help you convert protobuf file to typescript definition file. \n[Open Convert Panel](command:pbToTypescript.transformOnPanel)\n You can transform it from selection \n[from selection](command:pbToTypescript.fromSelection)\n You can transform it from clipboard \n[from clipboard](command:pbToTypescript.fromClipboard)\n"
-      }
-    ]
+			{
+				"view": "introduction",
+				"contents": "This tool is able to help you convert protobuf file to typescript definition file. \n[Open Convert Panel](command:protobufToTypescript.transformOnPanel)\n You can transform it from clipboard \n[from clipboard](command:protobufToTypescript.fromClipboard)\n You can transform it from selection \n[from selection](command:protobufToTypescript.fromSelection)\n"
+			}
+		]
 	},
 	"scripts": {
 		"vscode:prepublish": "npm run -S esbuild-base -- --minify",
 		"postinstall": "patch-package",
-		"esbuild-base": "rimraf out && esbuild ./src/extension.ts --bundle --outfile=out/extension.js --external:vscode --format=cjs --platform=node",
+		"esbuild-base": "rimraf out && esbuild ./src/extension.ts --bundle --outdir=out --external:vscode --format=cjs --platform=node",
 		"build": "npm run -S esbuild-base -- --sourcemap",
 		"watch": "npm run -S esbuild-base -- --sourcemap --watch",
 		"pretest": "npm run build && npm run lint",
@@ -93,7 +112,7 @@
 		"rimraf": "^3.0.2"
 	},
 	"dependencies": {
-		"pbts": "^4.0.3",
+		"pbts": "^4.0.5",
 		"copy-paste": "1.3.0"
 	}
-}
+}

packages/vscode/src/extension.ts

@@ -1,36 +1,41 @@
-import { ExtensionContext, ViewColumn, commands, window } from "vscode";
+import { ExtensionContext, ViewColumn, commands, window, workspace } from "vscode";
 import {
   handleError,
   getClipboardText,
   pasteToMarker,
   getSelectedText,
   validateLength,
-} from "./lib";
+} from "./utils/lib";
 import { parseProto } from 'pbts/core';
 import fs from 'fs';
 import path from 'path';
-import { cwd } from "process";
+// import { FileExplorer } from './fileExplorer';
 
 const PB3_HEADER = `syntax = "proto3";`;
 
 export function activate(context: ExtensionContext) {
   context.subscriptions.push(
-    commands.registerCommand("pbToTypescript.fromSelection", transformFromSelection)
+    commands.registerCommand("protobufToTypescript.fromSelection", transformFromSelection)
   );
   context.subscriptions.push(
-    commands.registerCommand("pbToTypescript.fromClipboard", transformFromClipboard)
+    commands.registerCommand("protobufToTypescript.fromClipboard", transformFromClipboard)
   );
   context.subscriptions.push(
-    commands.registerCommand("pbToTypescript.transformOnPanel", () => transformOnPanel(context))
+    commands.registerCommand("protobufToTypescript.transformOnPanel", () => transformOnPanel(context))
   );
+
+  // new FileExplorer(context);
 }
 
 function transformFromSelection() {
+  const config = workspace.getConfiguration('protobufToTypescript');
+  const outputType = config.get('outputType') as string;
+  const mode = config.get('mode') as string;
 
   getSelectedText()
     .then(validateLength)
     .then(str => {
-      return parseProto(PB3_HEADER + str);
+      return parseProto(PB3_HEADER + str, { outputType, mode });
     })
 		.then(interfaces => {
       pasteToMarker(interfaces);
@@ -41,10 +46,14 @@ function transformFromSelection() {
 }
 
 function transformFromClipboard() {
+  const config = workspace.getConfiguration('protobufToTypescript');
+  const outputType = config.get('outputType') as string;
+  const mode = config.get('mode') as string;
+
   getClipboardText()
     .then(validateLength)
     .then(str => {
-      return parseProto(PB3_HEADER + str);
+      return parseProto(PB3_HEADER + str, { outputType, mode });
     })
     .then(interfaces => {
       pasteToMarker(interfaces);
@@ -71,4 +80,4 @@ function getWebviewContent(ctx: ExtensionContext) {
     fileEntry,
     'utf-8',
   );
-}
+}