feat: change name of pact-body annotation into pact-request-body (#21)

HLTech · Apr 13, 2021 · 137fdbe · 137fdbe
1 parent 364d32c
commit 137fdbe
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -257,7 +257,7 @@ interface Query {
 ## [X] Create the concept how to get information about request body of interaction
 
 ```ts
-function addComment(/** @pact-body */ newComment: NewComment) {
+function addComment(/** @pact-request-body */ newComment: NewComment) {
     // ...
 }
 
@@ -271,7 +271,7 @@ or
 
 ```ts
 function addComment(postId: string, commentContent: string) {
-    /** @pact-body */
+    /** @pact-request-body */
     const newComment = {
         postId,
         commentContent,

diff --git a/example/src/api/secondProvider/posts.ts b/example/src/api/secondProvider/posts.ts
@@ -23,9 +23,9 @@ export const postsApi = {
      * @pact-path /api/clients/10/posts
      * @pact-method POST
      */
-    addNewPost: async function (clientNumber: string, /** @pact-body */ newPost: NewPost) {
+    addNewPost: async function (clientNumber: string, /** @pact-request-body */ newPost: NewPost) {
         const url = endpoint(clientNumber);
-        /** @pact-body */
+        /** @pact-request-body */
         const body = {newPost};
         return axios.post(url, newPost);
     },
@@ -37,7 +37,7 @@ export const postsApi = {
      */
     addNewPersonalPost: async function (clientNumber: string, newPost: NewPost) {
         const url = endpoint(clientNumber);
-        /** @pact-body */
+        /** @pact-request-body */
         const body = {personalPost: newPost};
         return axios.post(url, body);
     },

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "pact-gen-ts",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "Generating pact files from typescript definitions",
     "keywords": [
         "pacts",

diff --git a/src/core/interactions.ts b/src/core/interactions.ts
@@ -149,7 +149,7 @@ const getParameterOfRequestBody = (parameters: tsMorph.ParameterDeclaration[]) =
             .getFirstChildByKind(ts.SyntaxKind.JSDocComment)
             ?.getFirstChildByKind(ts.SyntaxKind.JSDocTag)
             ?.getFirstChildByKind(ts.SyntaxKind.Identifier);
-        if (jsDocIdentifierNode?.getText() === 'pact-body') {
+        if (jsDocIdentifierNode?.getText() === 'pact-request-body') {
             return parameter;
         }
     }
@@ -171,7 +171,7 @@ const getRequestBodyVariable = (bodyOfFunction: tsMorph.Block) => {
     const pactBodyJsDoc = bodyOfFunction.getDescendantsOfKind(ts.SyntaxKind.JSDocComment).find((jsDocComment) => {
         return (
             jsDocComment.getFirstChildByKind(ts.SyntaxKind.JSDocTag)?.getFirstChildByKind(ts.SyntaxKind.Identifier)?.getText() ===
-            'pact-body'
+            'pact-request-body'
         );
     });
     if (pactBodyJsDoc) {