Merge branch 'master' into beta

Author: ggurkal

.github/workflows/test.yaml

@@ -1,19 +1,49 @@
 name: CI
-on: [pull_request]
+
+on: 
+  push:
+    branches:
+      - master
+  
+  pull_request:
+
 jobs:
-  test:
-    name: 'Test'
+  run-tests:
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
+
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
           node-version: 12
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Cache yarn dependencies
+        uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: |
+            ${{ steps.yarn-cache-dir-path.outputs.dir }}
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
       - name: Install modules
         run: yarn
+
       - name: Run tests
-        run: yarn test --silent
-      - name: Upload coverage
-        uses: codecov/[email protected]
+        run: yarn test --silent --coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          # project specific codecov token
+          token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,14 +1,28 @@
-<p align="center">
+<div align="center">
   <a aria-label="Story of AMS logo" href="https://storyofams.com/" target="_blank" align="center">
     <img src="https://storyofams.com/public/[email protected]" alt="Story of AMS" width="120">
   </a>
   <h1 align="center">@storyofams/next-api-decorators</h1>
-</p>
-
-<p align="center">Collection of decorators to create typed Next.js API routes, with easy request validation and transformation.</p>
+  <p align="center">
+    <a aria-label="releases" href="https://GitHub.com/storyofams/next-api-decorators/releases/" target="_blank">
+      <img src="https://github.com/storyofams/next-api-decorators/workflows/Release/badge.svg">
+    </a>
+    <a aria-label="npm" href="https://www.npmjs.com/package/@storyofams/next-api-decorators" target="_blank">
+      <img src="https://img.shields.io/npm/v/@storyofams/next-api-decorators">
+    </a>
+    <a aria-label="codecov" href="https://codecov.io/gh/storyofams/nextjs-api-decorators" target="_blank">
+      <img src="https://codecov.io/gh/storyofams/next-api-decorators/branch/master/graph/badge.svg?token=ZV0YT4HU5H">
+    </a>
+    <a aria-label="stars" href="https://github.com/storyofams/next-api-decorators/stargazers/" target="_blank">
+      <img src="https://img.shields.io/github/stars/storyofams/next-api-decorators.svg?style=social&label=Star&maxAge=86400" />
+    </a>
+  </p>
+</div>
 
 ---
 
+Collection of decorators to create typed Next.js API routes, with easy request validation and transformation.
+
 ## Installation
 
 Add the package to your project:
@@ -23,11 +37,17 @@ Since decorators are still in proposal state, you need to add the following plug
 $ yarn add -D babel-plugin-transform-typescript-metadata @babel/plugin-proposal-decorators babel-plugin-parameter-decorator
 ```
 
+Make sure to add the following lines to the `plugins` section in your babel configuration file:
+```json
+"babel-plugin-transform-typescript-metadata",
+["@babel/plugin-proposal-decorators", { "legacy": true }],
+"babel-plugin-parameter-decorator",
+```
+
 Your `tsconfig.json` needs the following flags:
 
 ```json
-"experimentalDecorators": true,
-"emitDecoratorMetadata": true
+"experimentalDecorators": true
 ```
 
 ## Usage
@@ -103,14 +123,14 @@ export default createHandler(User);
 
 ### Method decorators
 
-|                                           | Description                                        |
-| ----------------------------------------- | -------------------------------------------------- |
-| `@Get()`                                  | Marks the method as `GET` handler.                 |
-| `@Post()`                                 | Marks the method as `POST` handler.                |
-| `@Put()`                                  | Marks the method as `PUT` handler.                 |
-| `@Delete()`                               | Marks the method as `DELETE` handler.              |
-| `@SetHeader(name: string, value: string)` | Sets a header name/value into the route response.  |
-| `@HttpCode(code: number)`                 | Sets the http code in the route response.          |
+|                                           | Description                                       |
+| ----------------------------------------- | ------------------------------------------------- |
+| `@Get()`                                  | Marks the method as `GET` handler.                |
+| `@Post()`                                 | Marks the method as `POST` handler.               |
+| `@Put()`                                  | Marks the method as `PUT` handler.                |
+| `@Delete()`                               | Marks the method as `DELETE` handler.             |
+| `@SetHeader(name: string, value: string)` | Sets a header name/value into the route response. |
+| `@HttpCode(code: number)`                 | Sets the http code in the route response.         |
 
 ### Parameter decorators
 
@@ -133,8 +153,8 @@ Pipes are being used to validate and transform incoming values. The pipes can be
 
 ⚠️ Beware that they throw when the value is invalid.
 
-|                    | Description                                  | Remarks                                       |
-| ------------------ | -------------------------------------------- | --------------------------------------------- |
+|                    | Description                                 | Remarks                                       |
+| ------------------ | ------------------------------------------- | --------------------------------------------- |
 | `ParseNumberPipe`  | Validates and transforms `Number` strings.  | Uses `parseFloat` under the hood              |
 | `ParseBooleanPipe` | Validates and transforms `Boolean` strings. | Allows `'true'` and `'false'` as valid values |