add an option to use type keyword instead of an interface

rikukissa · Jul 8, 2021 · c4490f2 · c4490f2
1 parent b5048a4
commit c4490f2
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -84,12 +84,13 @@ From 1.4.0 forward also Promises are supported. All other values (functions etc.
 
 ## Extension Settings
 
-| Setting                         | Type        | Default | Description                                                                     |
-| ------------------------------- | ----------- | ------- | ------------------------------------------------------------------------------- |
-| typehole.runtime.autoInstall    | boolean     | true    | Install Typehole runtime package automatically when the first typehole is added |
-| typehole.runtime.projectPath    | string      |         | Project directory where Typehole runtime should be installed                    |
-| typehole.runtime.packageManager | npm \| yarn | npm     | Package manager to be used when installing the runtime                          |
-| typehole.runtime.extensionPort  | number      | 17341   | HTTP port for HTTP extension to listen for incoming samples                     |
+| Setting                         | Type              | Default   | Description                                                                     |
+| ------------------------------- | ----------------- | --------- | ------------------------------------------------------------------------------- |
+| typehole.runtime.autoInstall    | boolean           | true      | Install Typehole runtime package automatically when the first typehole is added |
+| typehole.runtime.projectPath    | string            |           | Project directory where Typehole runtime should be installed                    |
+| typehole.runtime.packageManager | npm \| yarn       | npm       | Package manager to be used when installing the runtime                          |
+| typehole.runtime.extensionPort  | number            | 17341     | HTTP port for HTTP extension to listen for incoming samples                     |
+| typehole.typeOrInterface        | interface \| type | interface | Keyword to be used for generated types                                          |
 
 ## Runtime
 
@@ -134,6 +135,12 @@ configure({
 
 ## Release Notes
 
+## [1.7.0] - 2021-07-08
+
+### Added
+
+- New option "typehole.typeOrInterface" added for using `type` keyword instead of `interface`. All thanks to @akafaneh 🎉
+
 ## [1.6.3] - 2021-06-20
 
 ### Fixed

diff --git a/packages/extension/package-lock.json b/packages/extension/package-lock.json
diff --git a/packages/extension/package.json b/packages/extension/package.json
@@ -4,7 +4,7 @@
   "publisher": "rikurouvila",
   "description": "🧪  Take samples of runtime values and turn them into type definitions automatically",
   "repository": "https://github.com/rikukissa/typehole",
-  "version": "1.6.3",
+  "version": "1.8.0",
   "private": true,
   "icon": "images/logo.png",
   "galleryBanner": {
@@ -32,6 +32,16 @@
             "description": "Installs Typehole runtime package automatically when the first typehole is added",
             "scope": "window"
           },
+          "typehole.typeOrInterface": {
+            "type": "string",
+            "enum": [
+              "type",
+              "interface"
+            ],
+            "default": "interface",
+            "description": "Keyword to be used for generated types",
+            "scope": "window"
+          },
           "typehole.runtime.extensionPort": {
             "type": "number",
             "default": 17341,
@@ -99,7 +109,7 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "^4.1.1",
-    "@riku/json-to-ts": "^2.0.0",
+    "@riku/json-to-ts": "^2.1.0",
     "@types/esquery": "^1.0.1",
     "@types/npm": "^2.0.31",
     "esquery": "^1.4.0",

diff --git a/packages/extension/src/config.ts b/packages/extension/src/config.ts
@@ -11,6 +11,9 @@ export function getConfiguration(
     extensionPort: configuration.get(
       "typehole.runtime.extensionPort"
     ) as number,
+    typeOrInterface: configuration.get("typehole.typeOrInterface") as
+      | "interface"
+      | "type",
     autoInstall: configuration.get("typehole.runtime.autoInstall") as boolean,
     projectPath: configuration.get("typehole.runtime.projectPath") as string,
     packageManager: configuration.get(

diff --git a/packages/extension/src/listener.ts b/packages/extension/src/listener.ts
@@ -3,6 +3,7 @@ import f from "fastify";
 
 import * as ts from "typescript";
 import * as vscode from "vscode";
+import { getConfiguration } from "./config";
 
 import { getEditorRange, getProjectRoot } from "./editor/utils";
 import { error, log } from "./logger";
@@ -37,8 +38,14 @@ function createServer() {
     const body = request.body as any;
     log(body.id, "-", "New sample", JSON.stringify(request.body), "received");
 
+    const editor = vscode.window.activeTextEditor;
+    const document = editor?.document;
+    const config = getConfiguration("", document);
+
     const samples = addSample(body.id, body.sample);
-    const typeString = samplesToType(samples);
+    const typeString = samplesToType(samples, {
+      useTypeAlias: config.typeOrInterface === "type",
+    });
 
     try {
       await onTypeExtracted(body.id, typeString);

diff --git a/packages/extension/src/transforms/samplesToType/index.test.ts b/packages/extension/src/transforms/samplesToType/index.test.ts
@@ -5,6 +5,12 @@ test("generates types and interfaces from samples", () => {
     `type TypeholeRoot = (boolean | TypeholeRootWrapper2 | null | number);
 interface TypeholeRootWrapper2 {
   a: number;
+}`
+  );
+  expect(samplesToType([1, { a: 2 }, true, null], { useTypeAlias: true })).toBe(
+    `type TypeholeRoot = (boolean | TypeholeRootWrapper2 | null | number);
+type TypeholeRootWrapper2 = {
+  a: number;
 }`
   );
   expect(samplesToType([{ a: 2 }])).toBe(

diff --git a/packages/extension/src/transforms/samplesToType/index.ts b/packages/extension/src/transforms/samplesToType/index.ts
@@ -1,6 +1,10 @@
 import json2ts from "@riku/json-to-ts";
+import { Options } from "@riku/json-to-ts/build/src/model";
 
-export function samplesToType(samples: any[]): string {
+export function samplesToType(
+  samples: any[],
+  jsonToTSOptions?: Options
+): string {
   let wrapperType = null;
   let samplesWithoutWrapperTypes = [];
   for (const sample of samples) {
@@ -13,9 +17,12 @@ export function samplesToType(samples: any[]): string {
   }
 
   // eslint-disable-next-line @typescript-eslint/naming-convention
-  const types = json2ts({
-    __typeholeRootWrapper__: samplesWithoutWrapperTypes,
-  }).join("\n");
+  const types = json2ts(
+    {
+      __typeholeRootWrapper__: samplesWithoutWrapperTypes,
+    },
+    jsonToTSOptions
+  ).join("\n");
 
   let root = types
     .match(/__typeholeRootWrapper__:\s(.+)/)![1]

diff --git a/packages/runtime/package-lock.json b/packages/runtime/package-lock.json
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "1.6.3",
+  "version": "1.7.0",
   "name": "typehole",
   "repository": "rikukissa/typehole",
   "description": "Turn runtime types into static typescript types automatically",