Run Prettier for the whole project

Author: jnv

.github/workflows/ci-cd-pipeline.yml

@@ -96,4 +96,4 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           status: ${{ job.status }}
           deployment_id: ${{ steps.production_deployment.outputs.deployment_id }}
-          env_url: ${{ steps.vercel_production.outputs.preview-url }}
+          env_url: ${{ steps.vercel_production.outputs.preview-url }}

.github/workflows/prune-closed-pr-deployments.yml

@@ -16,4 +16,4 @@ jobs:
         uses: strumwolf/delete-deployment-environment@v2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          environment: ${{ env.GITHUB_HEAD_REF_SLUG_URL }}
+          environment: ${{ env.GITHUB_HEAD_REF_SLUG_URL }}

.prettierrc.js

@@ -4,9 +4,9 @@ module.exports = {
   useTabs: false,
   semi: true,
   singleQuote: true,
-  quoteProps: "as-needed",
-  trailingComma: "es5",
+  quoteProps: 'as-needed',
+  trailingComma: 'es5',
   bracketSpacing: true,
-  arrowParens: "avoid",
-  endOfLine: "lf",
-}
+  arrowParens: 'avoid',
+  endOfLine: 'lf',
+};

README.md

@@ -5,17 +5,19 @@ The official home of Superface docs.
 ## Updating the docs
 
 1. ### Run the docs locally
+
 - Clone the repo, then `yarn install` and `yarn start`
 
 2. ### Update the content
-- Make your desired changes to the documents inside 
-[`/docs`](https://github.com/superfaceai/docs/tree/main/docs) directory<br />
+
+- Make your desired changes to the documents inside
+  [`/docs`](https://github.com/superfaceai/docs/tree/main/docs) directory<br />
   It uses a standard Markdown syntax, but can be extended with custom React components via MDX.
 
   <sup>[Help for Markdown features ➚](https://docusaurus.io/docs/markdown-features)</sup>
 
-- Put your static content (e.g. images) to 
-[`/static`](https://github.com/superfaceai/docs/tree/main/static) directory<br />
+- Put your static content (e.g. images) to
+  [`/static`](https://github.com/superfaceai/docs/tree/main/static) directory<br />
   When linking to it from the docs, just drop `/static` from path, e.g. rendering `/img/diagram.png`
   will render an image saved at `/static/img/diagram.png`.
 
@@ -44,16 +46,16 @@ The official home of Superface docs.
 
   <sup>[Help for config ➚](https://docusaurus.io/docs/docusaurus.config.js)</sup>
 
-
 4. ### Get the changes reviewed
+
 - When you're happy with your changes, open a PR and get it reviewed by someone.<br />
-_Opening a PR will automatically deploy an online preview of your docs. It also verifies the build
-doesn't contain any broken links._
+  _Opening a PR will automatically deploy an online preview of your docs. It also verifies the build
+  doesn't contain any broken links._
 
 5. ### Deploy to production
-- Once your changes are verified and reviewed by another pair of eyes, it is ready to be merged to `main`.<br />
-_Merging will automatically deploy `main` branch to production._
 
+- Once your changes are verified and reviewed by another pair of eyes, it is ready to be merged to `main`.<br />
+  _Merging will automatically deploy `main` branch to production._
 
 ---
 
@@ -63,20 +65,21 @@ _Merging will automatically deploy `main` branch to production._
   <br />
   These docs are built using https://docusaurus.io/.
 
-  The site is deployed on [Vercel](https://vercel.com/) to
-  [`docs`](https://vercel.com/superface/docs) project.
+The site is deployed on [Vercel](https://vercel.com/) to
+[`docs`](https://vercel.com/superface/docs) project.
+
+All deployments are automated via GitHub Actions and you can keep track of them
+in [the repository's environments](https://github.com/superfaceai/docs/deployments).
 
-  All deployments are automated via GitHub Actions and you can keep track of them
-  in [the repository's environments](https://github.com/superfaceai/docs/deployments).
+- Preview: gets deployed for each PR
+- Production: gets deployed continuously from `main` branch
 
-  - Preview: gets deployed for each PR
-  - Production: gets deployed continuously from `main` branch
+Each deploy first verifies the validity of the build.
 
-  Each deploy first verifies the validity of the build.
+If you'd like to build locally:
 
-  If you'd like to build locally:
+```bash
+yarn build
+```
 
-  ```bash
-  yarn build
-  ```
-</details>
+</details>

docs/comlink/comlink-intro.mdx

@@ -62,4 +62,4 @@ slug: /comlink
       </div>
     </div>
   </div>
-</div>
+</div>

docs/guides/add-new-provider.md

@@ -32,7 +32,7 @@ This definition is later used by _Map_ documents that create a request/response
 
 :::info Before you start
 
-Please [check our registry for existing providers](./find-provider-by-name.md) before creating your own. Chances are the provider you're interested in was already defined by someone else. 
+Please [check our registry for existing providers](./find-provider-by-name.md) before creating your own. Chances are the provider you're interested in was already defined by someone else.
 
 In that case you can skip this guide & simply [create a mapping for the capability using an existing provider](./map-capability-to-provider.md).
 
@@ -71,7 +71,6 @@ Running the above command creates a new JSON file at `<provider-name>.provider.j
 
 To be able to call the provider's web services, you need to first define them. Each service points to a specific base URL and has an identifier that is unique within the provider document.
 
-
 ```json title="<provider-name>.provider.json" {3-8}
 {
   "name": "<provider-name>",
@@ -116,7 +115,7 @@ If the provider offers a public API that _does not_ require any authentication,
 
 :::
 
-Define the expected form of authentication using _security schemes_.  The actual credentials, tokens or keys will be provided later in runtime by the consumer either directly or via environment variables. Currently 3 types of security schemes are supported:
+Define the expected form of authentication using _security schemes_. The actual credentials, tokens or keys will be provided later in runtime by the consumer either directly or via environment variables. Currently 3 types of security schemes are supported:
 
 - [Basic Auth](#basic-auth)
 - [Bearer Token](#bearer-token)
@@ -143,7 +142,7 @@ Use the following scheme with an arbitrary ID which can be referenced later from
       "id": "<scheme-id>",
       "type": "http",
       "scheme": "basic"
-    }   
+    }
   ]
 }
 ```
@@ -185,7 +184,6 @@ _Replace the security scheme `id` value in the example with your own ID. Provide
 
 Use the following scheme with an arbitrary ID which can be referenced later from the mapping.
 
-
 ```json title="<provider-name>.provider.json" {10-17}
 {
   "name": "<provider-name>",
@@ -223,7 +221,6 @@ _e.g. `https://api.example.com/?accessKey=<apikey>`_
 - `in` must be set to `query`
 - `name` is the query param name that holds the API key (e.g. `accessKey`)
 
-
 ## Examples
 
 - [Provider using Basic auth](https://github.com/superfaceai/station/blob/main/providers/twilio.json)

docs/guides/create-new-capability.md

@@ -57,6 +57,7 @@ Use the `--help` flag for more options and examples:
 ```shell
 superface create --help
 ```
+
 :::
 
 The CLI creates `use_case_name.supr` file in current directory and links to it from the `superface/super.json`.
@@ -150,7 +151,6 @@ If you prefer learning by example, you can check the source Comlink profile for
 
 The use-case can be marked as `safe`, `unsafe` or `idempotent`. If the safety is not specified, the use-case is treated as `unsafe` by default.
 
-
 `safe`
 : The use-case doesn't change anything or doesn't perform any action. Generally reading operations can be considered safe, for example retrieving information about shipment or geocoding a postal address.
 
@@ -189,7 +189,7 @@ While the safety information is optional, it can be used by OneSDK to treat the
 
 ### Define Input Fields {#input}
 
-To execute the use-case, you typically need to provide some input. For example to send a text message, you need at least a recipient's phone number and the message's contents. 
+To execute the use-case, you typically need to provide some input. For example to send a text message, you need at least a recipient's phone number and the message's contents.
 
 In Comlink profile, the use-case's input is specified in the `input` block:
 
@@ -272,7 +272,7 @@ The first description in the profile should explain the overall purpose of the u
 """
 Shipment information
 
-Track your shipment. Get the latest information on your shipment status. 
+Track your shipment. Get the latest information on your shipment status.
 """
 
 name = "delivery-tracking/shipment-info"
@@ -353,8 +353,7 @@ Object
 : Corresponds to Object in JavaScript or Dictionary in Python.
 : Uses curly brackets, e.g. `{myField number}` defines an object with single field of type number.
 
-Objects are commonly used to define inputs, results, and errors: 
-
+Objects are commonly used to define inputs, results, and errors:
 
 ```hcl
 usecase UseCaseName {
@@ -418,7 +417,6 @@ Note that marking the field as non-nullable doesn't make it required. To make th
 
 In the above use-case the `trackingNumber` field is both required, and non-nullable:
 
-
 ```hcl
 usecase UseCaseName {
   input {

docs/guides/find-provider-by-name.md

@@ -12,4 +12,4 @@ curl -H "Accept: application/json" https://superface.ai/providers/<provider-name
 
 #### Using any other HTTP requesting tool
 
-Send `GET` request to `https://superface.ai/providers/<provider-name>` with `Accept` header set to `application/json`.
+Send `GET` request to `https://superface.ai/providers/<provider-name>` with `Accept` header set to `application/json`.

docs/guides/map-capability-to-provider.md

@@ -21,7 +21,7 @@ The easiest way to then bootstrap a new Map document is using [Superface CLI](/r
 superface create --map --profileId <profile-name@version> --providerName <provider-name>
 ```
 
-_Replace the `<profile-name@version>` and `<provider-name>` in the command with the actual profile and provider you wish to create new Map for._ 
+_Replace the `<profile-name@version>` and `<provider-name>` in the command with the actual profile and provider you wish to create new Map for._
 
 Running the above command creates a new Comlink file and links the new map in your local `super.json` configuration file. The new empty map will look something like this:
 
@@ -35,7 +35,6 @@ Comment for the map to UseCaseName
 map UseCaseName {} // UseCaseName will be different based on the actual use case in the profile
 ```
 
-
 ## Map use cases
 
 Every profile defines one or more _use cases_. You need to map the use case interfaces to the concrete requests and results towards a provider. If you used CLI to bootstrap the map, it will have pre-defined empty mappings for every profile use case.
@@ -49,7 +48,7 @@ You can access these inputs via `input` object which is available _inside use ca
 <details>
   <summary>Example</summary>
 
-  Given the following use case definition in a profile:
+Given the following use case definition in a profile:
 
 ```hcl title="profile.supr" {4-7}
 ...
@@ -68,7 +67,7 @@ usecase GetWeather {
 ...
 ```
 
-  These input props are accessible in the use case mapping.
+These input props are accessible in the use case mapping.
 
 ```hcl title="profile.provider.suma" {4-6}
 ...
@@ -149,7 +148,7 @@ map UseCaseName {
 }
 ```
 
-_The above definition makes call to `/api/messages?from=...` with body  of content type `application/json` including object with 2 parameters (`to` & `text`).<br />See [Comlink reference](https://superface.ai/docs/comlink/map#sec-HTTP-Request) for details on `request` block._
+_The above definition makes call to `/api/messages?from=...` with body of content type `application/json` including object with 2 parameters (`to` & `text`).<br />See [Comlink reference](https://superface.ai/docs/comlink/map#sec-HTTP-Request) for details on `request` block._
 
 ### Handle server responses {#handle-response}
 
@@ -177,8 +176,9 @@ map UseCaseName {
 ```
 
 _The above example definition:_
-- _handles any response with status code `201` and  `application/json` content type in success context,_
-- _handles any response with status code `400` and  `application/problem+json` content type in error context._
+
+- _handles any response with status code `201` and `application/json` content type in success context,_
+- _handles any response with status code `400` and `application/problem+json` content type in error context._
 
 _Any other response won't be handled and will result in an unexpected error_.
 
@@ -245,8 +245,7 @@ map UseCaseName {
 
 _The above definition maps the 2 expected result fields. One from the response's body, the other is loaded from headers and transformed with a simple Comlink expression.<br />See [Comlink reference](https://superface.ai/docs/comlink/map#sec-Map-Result) for detailed specification of `map result` statement._
 
-
-:::note 
+:::note
 
 `map result` is a regular Comlink statement; and as such can theoretically happen from anywhere inside the use case mapping, not necessarily from an inside of the response handler. An example of this would be a capability that doesn't need to call a remote server. However this is _very rare_ and the results are usually mapped from the HTTP responses so the example shows the most common place where the result mapping happens.
 
@@ -286,8 +285,7 @@ map UseCaseName {
 
 _The above definition maps the 2 expected error fields when server responds with status `429 (Too Many Requests)`. One is hardcoded as it describes the error scenario, the other constructs a helpful message with a value from response headers using a simple Comlink expression.<br />See [Comlink reference](https://superface.ai/docs/comlink/map#sec-Map-Error) for detailed specification of `map error` statement._
 
-
-:::note 
+:::note
 
 `map error` is a regular Comlink statement; and as such can theoretically happen from anywhere inside the use case mapping, not necessarily from an inside of the response handler. Although the errors are usually mapped from the failed HTTP responses, sometimes you might want to map error from different places. _One example would be validating the inputs against some domain rule. In such case, you might want to map error (or; fail early) when invalid inputs were provided, even before making the request._
 
@@ -363,7 +361,7 @@ response 400 "application/problem+json" {
   return map error if (body.error_code === "InvalidPhone") {
     title = "Invalid phone number"
     detail = "Please provide phone number in E.164 format"
-  } 
+  }
 
   return map error if (body.error_code === "InvalidKey") {
     title = "Unauthorized"
@@ -397,4 +395,4 @@ Comlink supports everything you might expect from a powerful scripting language.
 ## Examples {#examples}
 
 - [Map with reusable operations, iterations & expressions](https://github.com/superfaceai/station/blob/main/capabilities/delivery-tracking/shipment-info/maps/dhl.suma)
-- [Map with multiple error response mappings](https://github.com/superfaceai/station/blob/main/capabilities/communication/send-email/maps/postmark.suma)
+- [Map with multiple error response mappings](https://github.com/superfaceai/station/blob/main/capabilities/communication/send-email/maps/postmark.suma)