feat: add greeter-extension example

The example illustrates how to implement extension point/extenion pattern in LoopBack 4 to provide great extensibility.
loopbackio · Mar 25, 2019 · 242407c · 242407c
1 parent 73939c7
commit 242407c
Show file tree

Hide file tree

Showing 30 changed files with 1,299 additions and 2 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -25,6 +25,7 @@ packages/service-proxy/* @raymondfeng
 packages/testlab/* @bajtos
 examples/todo/* @bajtos @hacksparrow
 examples/express-composition/* @nabdelgadir
+examples/greeter-extension/* @raymondfeng
 examples/hello-world/* @b-admike
 examples/log-extension/* @hacksparrow
 examples/rpc-server/* @hacksparrow

diff --git a/docs/site/Examples.md b/docs/site/Examples.md
@@ -14,6 +14,9 @@ LoopBack 4 comes with the following example projects:
 - **[rpc-server](https://github.com/strongloop/loopback-next/tree/master/examples/rpc-server)**:
   An example showing how to implement a made-up RPC protocol.
 
+- **[greeter-extension](https://github.com/strongloop/loopback-next/tree/master/examples/greeter-extension)**:
+  An example showing how to implement the extension point/extension pattern.
+
 You can download the example projects using our CLI tool `lb4`:
 
 ```sh
@@ -26,6 +29,7 @@ $ lb4 example
   rpc-server: A basic RPC server using a made-up protocol.
   soap-calculator: An example on how to integrate SOAP web services.
   express-composition: A simple Express application that uses LoopBack 4 REST API.
+  greeter-extension: An example showing how to implement the extension point/extension pattern.
 ```
 
 Please follow the instructions in

diff --git a/docs/site/MONOREPO.md b/docs/site/MONOREPO.md
@@ -15,6 +15,7 @@ The [loopback-next](https://github.com/strongloop/loopback-next) repository uses
 | [core](https://github.com/strongloop/loopback-next/tree/master/packages/core)                                       | @loopback/core                        | Define and implement core constructs such as Application and Component                                                                                                                                                                                                                           |
 | [docs](https://github.com/strongloop/loopback-next/tree/master/docs)                                                | @loopback/docs                        | Documentation files rendered at [https://loopback.io](https://loopback.io)                                                                                                                                                                                                                       |
 | [example-express-composition](https://github.com/strongloop/loopback-next/tree/master/examples/express-composition) | @loopback/example-express-composition | A simple Express application that uses LoopBack 4 REST API                                                                                                                                                                                                                                       |
+| [example-greeter-extension](https://github.com/strongloop/loopback-next/tree/master/examples/greeter-extension)     | @loopback/example-greeter-extension   | An example showing how to implement the extension point/extension pattern using LoopBack 4                                                                                                                                                                                                       |
 | [example-hello-world](https://github.com/strongloop/loopback-next/tree/master/examples/hello-world)                 | @loopback/example-hello-world         | A simple hello-world application using LoopBack 4                                                                                                                                                                                                                                                |
 | [example-log-extension](https://github.com/strongloop/loopback-next/tree/master/examples/log-extension)             | @loopback/example-log-extension       | An example showing how to write a complex log extension for LoopBack 4                                                                                                                                                                                                                           |
 | [example-rpc-server](https://github.com/strongloop/loopback-next/tree/master/examples/rpc-server)                   | @loopback/example-rpc-server          | An example RPC server and application to demonstrate the creation of your own custom server                                                                                                                                                                                                      |

diff --git a/examples/greeter-extension/.npmrc b/examples/greeter-extension/.npmrc
@@ -0,0 +1 @@
+package-lock=true
diff --git a/examples/greeter-extension/.prettierignore b/examples/greeter-extension/.prettierignore
@@ -0,0 +1,2 @@
+dist
+*.json
diff --git a/examples/greeter-extension/.prettierrc b/examples/greeter-extension/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all"
+}
diff --git a/examples/greeter-extension/.vscode/settings.json b/examples/greeter-extension/.vscode/settings.json
@@ -0,0 +1,21 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": "on",
+  "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/greeter-extension/.vscode/tasks.json b/examples/greeter-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/greeter-extension/LICENSE b/examples/greeter-extension/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019. All Rights Reserved.
+Node module: @loopback/example-greeter-extension
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+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.