Merge pull request #10 from ccontrols/vscode-extension

Vscode extension

Author: atanasster

.vscode/launch.json

@@ -10,7 +10,7 @@
  "name": "api",
  "program": "${workspaceFolder}/node_modules/.bin/jest",
  "cwd": "${workspaceFolder}/packages/api",
- "args": ["union-prop"],
+ "args": ["type-prop"],
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen",
  "disableOptimisticBPs": true,
@@ -59,6 +59,32 @@
  "windows": {
  "program": "${workspaceFolder}/node_modules/jest/bin/jest"
  }
+ },
+ {
+ "type": "node",
+ "request": "launch",
+ "name": "api-docs",
+ "program": "${workspaceFolder}/node_modules/.bin/jest",
+ "cwd": "${workspaceFolder}/packages/api-docs",
+ "args": ["collapse"],
+ "console": "integratedTerminal",
+ "internalConsoleOptions": "neverOpen",
+ "disableOptimisticBPs": true,
+ "windows": {
+ "program": "${workspaceFolder}/node_modules/jest/bin/jest"
+ }
+ },
+ {
+ "name": "VSCode Extension",
+ "type": "extensionHost",
+ "request": "launch",
+ "runtimeExecutable": "${execPath}",
+ "args": [
+ "--extensionDevelopmentPath=${workspaceRoot}/packages/vscode-plugin"
+ ],
+ "stopOnEntry": false,
+ "sourceMaps": true,
+ "outFiles": ["${workspaceFolder}/packages/vscode-plugin/dist/**/*.js"]
  }
  ]
 }

README.md

@@ -1,18 +1,18 @@
 # Table of contents
 
-- [About](#about)
-- [Live example](#live-example)
-- [Using the API](#using-the-api)
- - [1. Installation](#1-installation)
- - [2. Your API source file (sum.js):](#2-your-api-source-file-sumjs)
- - [3. Your documentation extraction](#3-your-documentation-extraction)
- - [4. The result](#4-the-result)
-- [Using the CLI](#using-the-cli)
- - [1. Installation](#1-installation-1)
- - [2. Configure](#2-configure)
- - [3. Launch](#3-launch)
-- [Typescript playground plugin](#typescript-playground-plugin)
-- [Roadmap](#roadmap)
+-  [About](#about)
+-  [Live example](#live-example)
+-  [Using the API](#using-the-api)
+  -  [1. Installation](#1-installation)
+  -  [2. Your API source file (sum.js):](#2-your-api-source-file-sumjs)
+  -  [3. Your documentation extraction](#3-your-documentation-extraction)
+  -  [4. The result](#4-the-result)
+-  [Using the CLI](#using-the-cli)
+  -  [1. Installation](#1-installation-1)
+  -  [2. Configure](#2-configure)
+  -  [3. Launch](#3-launch)
+-  [Typescript playground plugin](#typescript-playground-plugin)
+-  [Roadmap](#roadmap)
 
 # About
 
@@ -151,12 +151,12 @@ More information about the [@structured-types/playground-plugin](https://github.
 
 # Roadmap
 
-- [x] JSDoc types
-- [x] Typescript types
-- [x] React plugin
-- [x] React "prop-types" plugin
-- [x] Typescript playground plugin
-- [ ] [component-controls](https://github.com/ccontrols/component-controls) integration
-- [x] Automatically generate README.md files (api-readme)
-- [ ] Vue plugin
-- [ ] Angular plugin
+-  [x] JSDoc types
+-  [x] Typescript types
+-  [x] React plugin
+-  [x] React "prop-types" plugin
+-  [x] Typescript playground plugin
+-  [ ] [component-controls](https://github.com/ccontrols/component-controls) integration
+-  [x] Automatically generate README.md files (api-readme)
+-  [ ] Vue plugin
+-  [ ] Angular plugin

packages/api-docs/.eslintignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+test

packages/api-docs/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Atanas Stoyanov
+
+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.