Skip to content

Commit

Permalink
Add demo instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Laura Chan committed Jun 3, 2023
1 parent a066003 commit 3c8c2a0
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# make-a-type README
# make-a-type

https://marketplace.visualstudio.com/items?itemName=lwkchan.make-a-type
This extension is available on the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=lwkchan.make-a-type).

I made this because the other available extensions which convert JS to TS either required you to use a JSON object or they created a separate TS file. This extension does not require you to use JSON and captures the TS type in your clipboard so that you can paste it anywhere you want.

## Features

- Highlight a JS Object, and get a TypeScript interface in your clipboard

![make-a-type demo](./demo-make-a-type.gif)

## Requirements

- VS Code 1.44 or higher

## Usage

1. Highlight your JS object
2. Open command pallette (`Ctrl/Cmd-Shift-P`)
3. Search for "Make JS Object into TS Type: clipboard"
4. Select option
5. TS type is now in your clipboard, now paste it wherever you want to
Binary file added demo-make-a-type.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"name": "make-a-type",
"displayName": "make a type",
"repository": "https://github.com/lwkchan/make-a-type",
"repository": {
"type": "git",
"url": "https://github.com/lwkchan/make-a-type"
},
"publisher": "lwkchan",
"description": "",
"version": "0.0.3",
"version": "0.0.4",
"engines": {
"vscode": "^1.44.0"
},
Expand Down

0 comments on commit 3c8c2a0

Please sign in to comment.