Merge pull request #55 from fbsamples/prettier

Prettier

Author: anujs3

.prettierignore

@@ -0,0 +1,8 @@
+node_modules/
+build/
+dist/
+*.min.js
+postman/threads-api.postman_collection.json
+.github/workflows/postman-sync.yaml
+.devcontainer/devcontainer.json
+package.json

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+    "singleQuote": true,
+    "tabWidth": 4
+}

CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-professional setting
+-   The use of sexualized language or imagery and unwelcome sexual attention or
+    advances
+-   Trolling, insulting/derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or electronic
+    address, without explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Our Responsibilities
 
@@ -77,4 +77,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -1,11 +1,14 @@
 # Contributing to Threads API Sample App
+
 We want to make contributing to this project as easy and transparent as
 possible.
 
 ## Our Development Process
+
 ... (in particular how this is synced with internal changes to the project)
 
 ## Pull Requests
+
 We actively welcome your pull requests.
 
 1. Fork the repo and create your branch from `main`.
@@ -16,12 +19,14 @@ We actively welcome your pull requests.
 6. If you haven't already, complete the Contributor License Agreement ("CLA").
 
 ## Contributor License Agreement ("CLA")
+
 In order to accept your pull request, we need you to submit a CLA. You only need
 to do this once to work on any of Meta's open source projects.
 
 Complete your CLA here: <https://code.facebook.com/cla>
 
 ## Issues
+
 We use GitHub issues to track public bugs. Please ensure your description is
 clear and has sufficient instructions to be able to reproduce the issue.
 
@@ -30,5 +35,6 @@ disclosure of security bugs. In those cases, please go through the process
 outlined on that page and do not file a public issue.
 
 ## License
+
 By contributing to Threads API Sample App, you agree that your contributions will be licensed
-under the LICENSE file in the root directory of this source tree.
+under the LICENSE file in the root directory of this source tree.

README.md

@@ -11,42 +11,46 @@ You can use this Sample App to test the [Threads API](https://developers.faceboo
 
 In order to run the Sample App you will need to install some required software, as follows:
 
-- Node JS
+-   Node JS
 
 ## Running the Sample App
 
 Note: If you are using devcontainers, ensure that containers are enabled and supported by your IDE.
 
 1. Install necessary tools
-    * If you are using a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers), skip to step 2.
-    * Install [nodeJS](https://nodejs.org/en/download/) to run the application. If you're using a Mac, you can install it via Homebrew: `brew install node`
-    * Install [mkcert](https://mkcert.org/) to create the OpenSSL Certificate. If you're using a Mac, you can install it via Homebrew: `brew install mkcert`
+
+    - If you are using a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers), skip to step 2.
+    - Install [nodeJS](https://nodejs.org/en/download/) to run the application. If you're using a Mac, you can install it via Homebrew: `brew install node`
+    - Install [mkcert](https://mkcert.org/) to create the OpenSSL Certificate. If you're using a Mac, you can install it via Homebrew: `brew install mkcert`
 
 2. Run `npm install` in your terminal
 
 3. Create a new file called `.env` and copy/paste all the environment variables from `.env.template`. Replace any environnment variables that have placeholders, such as APP_ID.
 
 4. Map a domain to your local machine for local development
-    * Note: Threads apps do not support redirect URLs with using `localhost` so you must map a domain to test locally this Sample App.
-    * Map a new entry in your hosts file to the domain that you will use to test the Sample App e.g. `threads-sample.meta`.
-    * If you're using a Linux or Mac, this will be your `/etc/hosts` file.
-    * Add an entry like so:
+
+    - Note: Threads apps do not support redirect URLs with using `localhost` so you must map a domain to test locally this Sample App.
+    - Map a new entry in your hosts file to the domain that you will use to test the Sample App e.g. `threads-sample.meta`.
+    - If you're using a Linux or Mac, this will be your `/etc/hosts` file.
+    - Add an entry like so:
         ```
         127.0.0.1   threads-sample.meta
         ```
-    * This will map threads-sample.meta to localhost, so you may visit https://threads-sample.meta:8000 to see the Threads Sample App.
-    * This domain must match the one defined in your `.env` file as the value of the `HOST` variable.
+    - This will map threads-sample.meta to localhost, so you may visit https://threads-sample.meta:8000 to see the Threads Sample App.
+    - This domain must match the one defined in your `.env` file as the value of the `HOST` variable.
 
 5. Create an OpenSSL Cert
-    * OAuth redirects are only supported over HTTPS so you must create an SSL certificate
-    * `mkcert threads-sample.meta` - This will create pem files for SSL.
-    * You will see `threads-sample.meta.pem` and `threads-sample.meta-key.pem `files generated.
-    * If you are using a host that is different than `threads-sample.meta` then replace it with your specific domain.
+
+    - OAuth redirects are only supported over HTTPS so you must create an SSL certificate
+    - `mkcert threads-sample.meta` - This will create pem files for SSL.
+    - You will see `threads-sample.meta.pem` and `threads-sample.meta-key.pem `files generated.
+    - If you are using a host that is different than `threads-sample.meta` then replace it with your specific domain.
 
 6. Run the Sample App
-    * Run `npm start` from the command line.
-    * Once the Sample App starts running, go to https://threads-sample.meta:8000 to test the workflow.
-    * If you are using a different domain or port then replace those values accordingly.
+    - Run `npm start` from the command line.
+    - Once the Sample App starts running, go to https://threads-sample.meta:8000 to test the workflow.
+    - If you are using a different domain or port then replace those values accordingly.
 
 ## License
+
 Threads API is Meta Platform Policy licensed, as found in the LICENSE file.

package.json

@@ -5,7 +5,9 @@
   "main": "index.js",
   "scripts": {
     "start": "node ./src/index.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "format:check": "prettier --check .",
+    "format:write": "prettier --write ."
   },
   "author": "",
   "license": "ISC",