feat(cli): add vscode config files

loopbackio · Jun 1, 2018 · 3738b9c · 3738b9c
1 parent 37aba50
commit 3738b9c
Show file tree

Hide file tree

Showing 42 changed files with 472 additions and 33 deletions.
diff --git a/docs/site/Application-generator.md b/docs/site/Application-generator.md
@@ -33,6 +33,8 @@ lb4 [app] [options] [<name>]
 `--loopbackBuild` : Add @loopback/build module's script set to LoopBack4
 application project.
 
+`--vscode`: Add VSCode config files to LoopBack4 application project
+
 {% include_relative includes/CLI-std-options.md %}
 
 ### Arguments
@@ -66,6 +68,7 @@ The tool will prompt you for:
   - [`prettier`](https://www.npmjs.com/package/prettier)
   - [`mocha`](https://www.npmjs.com/package/mocha)
   - [`@loopback/build`](https://www.npmjs.com/package/@loopback/build)
+  - [`vscode`](https://code.visualstudio.com/)
 
 ### Output
 

diff --git a/docs/site/Extension-generator.md b/docs/site/Extension-generator.md
@@ -31,6 +31,8 @@ lb4 extension [options] [<name>]
 `--loopbackBuild` : Add @loopback/build module's script set to LoopBack4
 extension project.
 
+`--vscode`: Add VSCode config files to LoopBack4 application project
+
 {% include_relative includes/CLI-std-options.md %}
 
 ### Arguments
@@ -60,3 +62,4 @@ The tool will prompt you for:
   - [`prettier`](https://www.npmjs.com/package/prettier)
   - [`mocha`](https://www.npmjs.com/package/mocha)
   - [`@loopback/build`](https://www.npmjs.com/package/@loopback/build)
+  - [`vscode`](https://code.visualstudio.com/)
diff --git a/docs/site/Getting-started.md b/docs/site/Getting-started.md
@@ -42,7 +42,7 @@ Answer the prompts as follows:
 ? Project description: Getting started tutorial
 ? Project root directory: (getting-started)
 ? Application class name: StarterApplication
-? Select project build settings: Enable tslint, Enable prettier, Enable mocha, Enable loopbackBuild
+? Select project build settings: Enable tslint, Enable prettier, Enable mocha, Enable loopbackBuild, Enable vscode
 ```
 
 ### Starting the project

diff --git a/docs/site/todo-tutorial-scaffolding.md b/docs/site/todo-tutorial-scaffolding.md
@@ -28,6 +28,7 @@ $ lb4 app
  ◉ Enable prettier
  ◉ Enable mocha
  ◉ Enable loopbackBuild
+ ◉ Enable vscode
  # npm will install dependencies now
  Application todo-list is now created in todo-list.
 ```
@@ -72,27 +73,27 @@ tslint.build.json
 tslint.json
 ```
 
-| File                               | Purpose                                                                                                                                                                                                                                               |
-| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| index.ts                           | Allows importing contents of the `src` folder (for use elsewhere)                                                                                                                                                                                     |
-| index.js                           | Top-level wireup for execution of the application.                                                                                                                                                                                                    |
-| package.json                       | Your application's package manifest. See [package.json](https://docs.npmjs.com/files/package.json) for details.                                                                                                                                       |
-| tsconfig.json                      | The TypeScript project configuration. See [tsconfig.json](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for details.                                                                                                                |
-| tslint.json                        | [TSLint configuration](https://palantir.github.io/tslint/usage/tslint-json/)                                                                                                                                                                          |
-| tslint.build.json                  | [TSLint configuration (build only)](https://palantir.github.io/tslint/usage/tslint-json/)                                                                                                                                                             |
-| README.md                          | The Markdown-based README generated for your application.                                                                                                                                                                                             |
-| LICENSE                            | A copy of the MIT license. If you do not wish to use this license, please delete this file.                                                                                                                                                           |
-| src/application.ts                 | The application class, which extends [`RestApplication`](http://apidocs.strongloop.com/@loopback%2frest/#RestApplication) by default. This is the root of your application, and is where your application will be configured.                         |
-| src/index.ts                       | The starting point of your microservice. This file creates an instance of your application, runs the booter, then attempts to start the [`RestServer`](http://apidocs.strongloop.com/@loopback%2frest/#RestServer) instance bound to the application. |
-| src/sequence.ts                    | An extension of the [Sequence](Sequence.md) class used to define the set of actions to take during a REST request/response.                                                                                           |
-| src/controllers/README.md          | Provides information about the controller directory, how to generate new controllers, and where to find more information.                                                                                                                             |
-| src/controllers/ping.controller.ts | A basic controller that responds to GET requests at `/ping`.                                                                                                                                                                                          |
-| src/datasources/README.md          | Provides information about the datasources directory, how to generate new datasources, and where to find more information.                                                                                                                            |
-| src/models/README.md               | Provides information about the datasources directory, how to generate new datasources, and where to find more information.                                                                                                                            |
-| src/repositories/README.md         | Provides information about the repositories directory, how to generate new repositories, and where to find more information.                                                                                                                          |
-| test/README.md                     | Please place your tests in this folder.                                                                                                                                                                                                               |
-| test/mocha.opts                    | [Mocha](https://mochajs.org/) configuration for running your application's tests.                                                                                                                                                                     |
-| test/acceptance/ping.controller.acceptance.ts       | An example test to go with the ping controller in `src/controllers`.                                                                                                                                                                                  |
+| File                                          | Purpose                                                                                                                                                                                                                                               |
+| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| index.ts                                      | Allows importing contents of the `src` folder (for use elsewhere)                                                                                                                                                                                     |
+| index.js                                      | Top-level wireup for execution of the application.                                                                                                                                                                                                    |
+| package.json                                  | Your application's package manifest. See [package.json](https://docs.npmjs.com/files/package.json) for details.                                                                                                                                       |
+| tsconfig.json                                 | The TypeScript project configuration. See [tsconfig.json](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for details.                                                                                                                |
+| tslint.json                                   | [TSLint configuration](https://palantir.github.io/tslint/usage/tslint-json/)                                                                                                                                                                          |
+| tslint.build.json                             | [TSLint configuration (build only)](https://palantir.github.io/tslint/usage/tslint-json/)                                                                                                                                                             |
+| README.md                                     | The Markdown-based README generated for your application.                                                                                                                                                                                             |
+| LICENSE                                       | A copy of the MIT license. If you do not wish to use this license, please delete this file.                                                                                                                                                           |
+| src/application.ts                            | The application class, which extends [`RestApplication`](http://apidocs.strongloop.com/@loopback%2frest/#RestApplication) by default. This is the root of your application, and is where your application will be configured.                         |
+| src/index.ts                                  | The starting point of your microservice. This file creates an instance of your application, runs the booter, then attempts to start the [`RestServer`](http://apidocs.strongloop.com/@loopback%2frest/#RestServer) instance bound to the application. |
+| src/sequence.ts                               | An extension of the [Sequence](Sequence.md) class used to define the set of actions to take during a REST request/response.                                                                                                                           |
+| src/controllers/README.md                     | Provides information about the controller directory, how to generate new controllers, and where to find more information.                                                                                                                             |
+| src/controllers/ping.controller.ts            | A basic controller that responds to GET requests at `/ping`.                                                                                                                                                                                          |
+| src/datasources/README.md                     | Provides information about the datasources directory, how to generate new datasources, and where to find more information.                                                                                                                            |
+| src/models/README.md                          | Provides information about the datasources directory, how to generate new datasources, and where to find more information.                                                                                                                            |
+| src/repositories/README.md                    | Provides information about the repositories directory, how to generate new repositories, and where to find more information.                                                                                                                          |
+| test/README.md                                | Please place your tests in this folder.                                                                                                                                                                                                               |
+| test/mocha.opts                               | [Mocha](https://mochajs.org/) configuration for running your application's tests.                                                                                                                                                                     |
+| test/acceptance/ping.controller.acceptance.ts | An example test to go with the ping controller in `src/controllers`.                                                                                                                                                                                  |
 
 ### Navigation
 

diff --git a/examples/hello-world/.prettierignore b/examples/hello-world/.prettierignore
@@ -0,0 +1,2 @@
+dist*
+*.json
diff --git a/examples/hello-world/.prettierrc b/examples/hello-world/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all"
+}
diff --git a/examples/hello-world/.vscode/settings.json b/examples/hello-world/.vscode/settings.json
@@ -0,0 +1,21 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": true,
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist*": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "tslint.ignoreDefinitionFiles": true,
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}
diff --git a/examples/hello-world/.vscode/tasks.json b/examples/hello-world/.vscode/tasks.json
@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Watch and Compile Project",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "build:watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "Build, Test and Lint",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "test:dev"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": ["$tsc", "$tslint5"]
+    }
+  ]
+}
diff --git a/examples/hello-world/package.json b/examples/hello-world/package.json
@@ -13,10 +13,23 @@
     "build:current": "lb-tsc",
     "build:dist8": "lb-tsc es2017",
     "build:dist10": "lb-tsc es2018",
+    "build:watch": "lb-tsc --watch",
     "clean": "lb-clean *example-hello-world*.tgz dist* package api-docs",
     "verify": "npm pack && tar xf *example-hello-world*.tgz && tree package && npm run clean",
+    "lint": "npm run prettier:check && npm run tslint",
+    "lint:fix": "npm run prettier:fix && npm run tslint:fix",
+    "prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",
+    "prettier:check": "npm run prettier:cli -- -l",
+    "prettier:fix": "npm run prettier:cli -- --write",
+    "tslint": "lb-tslint",
+    "tslint:fix": "npm run tslint -- --fix",
+    "pretest": "npm run clean && npm run build:current",
+    "test": "lb-mocha --allow-console-logs \"DIST/test\"",
+    "posttest": "npm run lint",
+    "test:dev": "lb-mocha --allow-console-logs DIST/test/**/*.js && npm run posttest",
     "prestart": "npm run build:current",
-    "start": "node ."
+    "start": "node .",
+    "prepublishOnly": "npm run test"
   },
   "repository": {
     "type": "git",

diff --git a/examples/hello-world/tslint.build.json b/examples/hello-world/tslint.build.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json.schemastore.org/tslint",
+  "extends": ["./node_modules/@loopback/build/config/tslint.build.json"]
+}
diff --git a/examples/hello-world/tslint.json b/examples/hello-world/tslint.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json.schemastore.org/tslint",
+  "extends": ["./node_modules/@loopback/build/config/tslint.common.json"]
+}
diff --git a/examples/log-extension/.prettierignore b/examples/log-extension/.prettierignore
@@ -1,2 +1,2 @@
-dist
-dist6
+dist*
+*.json
diff --git a/examples/log-extension/.prettierrc b/examples/log-extension/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all"
+}
diff --git a/examples/log-extension/.vscode/settings.json b/examples/log-extension/.vscode/settings.json
@@ -0,0 +1,21 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": true,
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist*": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "tslint.ignoreDefinitionFiles": true,
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}
diff --git a/examples/log-extension/.vscode/tasks.json b/examples/log-extension/.vscode/tasks.json
@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Watch and Compile Project",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "build:watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "Build, Test and Lint",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "test:dev"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": ["$tsc", "$tslint5"]
+    }
+  ]
+}
diff --git a/examples/log-extension/package.json b/examples/log-extension/package.json
@@ -24,6 +24,7 @@
     "pretest": "npm run clean && npm run build:current",
     "test": "lb-mocha \"DIST/test/unit/**/*.js\" \"DIST/test/acceptance/**/*.js\"",
     "posttest": "npm run lint",
+    "test:dev": "lb-mocha --allow-console-logs DIST/test/**/*.js && npm run posttest",
     "verify": "npm pack && tar xf *example-log-extension*.tgz && tree package && npm run clean"
   },
   "repository": {

diff --git a/examples/log-extension/tslint.build.json b/examples/log-extension/tslint.build.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json.schemastore.org/tslint",
+  "extends": ["./node_modules/@loopback/build/config/tslint.build.json"]
+}
diff --git a/examples/log-extension/tslint.json b/examples/log-extension/tslint.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json.schemastore.org/tslint",
+  "extends": ["./node_modules/@loopback/build/config/tslint.common.json"]
+}
diff --git a/examples/rpc-server/.prettierignore b/examples/rpc-server/.prettierignore
@@ -1,2 +1,2 @@
-*.js
-*.d.ts
+dist*
+*.json
diff --git a/examples/rpc-server/.prettierrc b/examples/rpc-server/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all"
+}
diff --git a/examples/rpc-server/.vscode/settings.json b/examples/rpc-server/.vscode/settings.json
@@ -0,0 +1,21 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": true,
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist*": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "tslint.ignoreDefinitionFiles": true,
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}
-Original file line number
+Diff line change
@@ -1,2 +1,2 @@
-    dist
-    dist6
+    dist*
+    *.json