ci: format with prettier (DenverCoder1#254)

* ci: format with prettier

* style: Formatted code with Prettier

* Update print width

* style: Formatted code with Prettier

* ci: ignore minified

* Update prettier.yml

* Update CONTRIBUTING.md

* Restore jscolor.min.js

* increase length to 120

* style: Formatted code with Prettier

Co-authored-by: DenverCoder1 <[email protected]>

Author: DenverCoder1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: 'bug'
-assignees: ''
-
+title: ""
+labels: "bug"
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: 'enhancement'
-assignees: ''
-
+title: ""
+labels: "enhancement"
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/ISSUE_TEMPLATE/question.md

@@ -1,14 +1,11 @@
 ---
 name: Question
 about: I have a question about GitHub Streak Stats
-title: ''
-labels: 'question'
-assignees: ''
-
+title: ""
+labels: "question"
+assignees: ""
 ---
 
-
 **Description**
 
 A brief description of the question or issue:
-

.github/ISSUE_TEMPLATE/theme.md

@@ -1,21 +1,21 @@
 ---
 name: Theme Request
 about: Request a theme for the project
-title: ''
-labels: 'theme'
-assignees: ''
-
+title: ""
+labels: "theme"
+assignees: ""
 ---
 
 **Describe your theme in detail**
 A clear description about what the theme would entail.
 
 **Include a screenshot / image**
+
 <!-- Optional -->
 
 **Color palette**
 Describe the colors that could be used with this theme.
 
-
 Are you going to add the theme?
+
 - [ ] Check for yes

.github/pull_request_template.md

@@ -15,8 +15,8 @@ Fixes # <!-- add issue number -->
 
 ## How Has This Been Tested?
 
-<!-- 
-If you have changed a feature of the stats cards, please describe the tests you made to verify your changes. 
+<!--
+If you have changed a feature of the stats cards, please describe the tests you made to verify your changes.
 Changes strictly related to documentation can skip this section.
 -->
 

.github/workflows/prettier.yml

@@ -0,0 +1,24 @@
+name: Format with Prettier
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Prettify code
+        uses: creyD/[email protected]
+        with:
+          prettier_options: "--write **/*.{php,md,js,css} !**/*.min.js --print-width 120"
+          commit_message: "style: Formatted code with Prettier"
+          prettier_plugins: "@prettier/plugin-php"

.gitignore

@@ -1,4 +1,16 @@
+# Generated files
+vendor/
+node_modules/
+*.log
 composer.phar
-/vendor/
+yarn.lock
+package-lock.json
+
+# Local Configuration
+package.json
+
+# Environment
 .env
+
+# IDE
 .vscode/

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
 

CONTRIBUTING.md

@@ -20,9 +20,9 @@ You can refer to the following articles on the basics of Git and GitHub in case
 
 #### Requirements
 
-* [PHP 8.0+](https://www.apachefriends.org/index.html)
-* [Composer](https://getcomposer.org)
-* [Imagick](https://www.php.net/imagick)
+- [PHP 8.0+](https://www.apachefriends.org/index.html)
+- [Composer](https://getcomposer.org)
+- [Imagick](https://www.php.net/imagick)
 
 #### Linux
 
@@ -60,6 +60,7 @@ TOKEN=<your-token>
 ```
 
 ### Install dependencies
+
 Run the following command to install all the required dependencies to work on this project.
 
 ```bash
@@ -91,40 +92,37 @@ Below you will find the process and workflow used to review and merge your chang
 ### Step 0 : Find an issue
 
 - Take a look at the existing issues or create your **own** issues!
-- Wait for the issue to be assigned to you after which you can start working on it.
 
 ![issues tab](https://user-images.githubusercontent.com/63443481/136185624-24447858-de8d-4b0a-bb6b-2528d9031196.PNG)
 
-
 ### Step 1 : Fork the Project
 
 - Fork this repository. This will create a copy of this repository on your GitHub profile.
-Keep a reference to the original project in the `upstream` remote.  
+  Keep a reference to the original project in the `upstream` remote.
 
 ```bash
-git clone https://github.com/<your-username>/github-readme-streak-stats.git  
-cd github-readme-streak-stats  
-git remote add upstream https://github.com/DenverCoder1/github-readme-streak-stats.git  
-```  
+git clone https://github.com/<your-username>/github-readme-streak-stats.git
+cd github-readme-streak-stats
+git remote add upstream https://github.com/DenverCoder1/github-readme-streak-stats.git
+```
 
 ![fork button](https://user-images.githubusercontent.com/63443481/136185816-0b6770d7-0b00-4951-861a-dd15e3954918.PNG)
-  
 
 - If you have already forked the project, update your copy before working.
 
 ```bash
 git remote update
 git checkout <branch-name>
 git rebase upstream/<branch-name>
-```  
+```
 
 ### Step 2 : Branch
 
 Create a new branch. Use its name to identify the issue you're addressing.
 
 ```bash
-# It will create a new branch with the name Branch_Name and switch to that branch 
-git checkout -b Branch_Name
+# Creates a new branch with the name feature_name and switches to it
+git checkout -b feature_name
 ```
 
 ### Step 3 : Work on the issue assigned
@@ -133,9 +131,9 @@ git checkout -b Branch_Name
 - Make all the necessary changes to the codebase.
 - After you've made changes or made your contribution to the project, add changes to the branch you've just created using:
 
-```bash  
-# To add all new files to the branch  
-git add .  
+```bash
+# To add all new files to the branch
+git add .
 
 # To add only a few files to the branch
 git add <some files (with path)>
@@ -155,21 +153,23 @@ git commit -m "message"
 - Now you are ready to your work on the remote repository.
 - When your work is ready and complies with the project conventions, upload your changes to your fork:
 
-```bash  
+```bash
 # To push your work to your remote repository
 git push -u origin Branch_Name
 ```
 
 - Here is how your branch will look.
-![forked branch](https://user-images.githubusercontent.com/63443481/136186235-204f5c7a-1129-44b5-af20-89aa6a68d952.PNG)
+
+  ![forked branch](https://user-images.githubusercontent.com/63443481/136186235-204f5c7a-1129-44b5-af20-89aa6a68d952.PNG)
 
 ### Step 6 : Pull Request
 
-- Go to your forked repository in your browser and click on "Compare and pull request". Then add a title and description to your pull request that explains your contribution.  
+- Go to your forked repository in your browser and click on "Compare and pull request". Then add a title and description to your pull request that explains your contribution.
 
-<img width="700" alt="compare and pull request" src="https://user-images.githubusercontent.com/63443481/136186304-c0a767ea-1fd2-4b0c-b5a8-3e366ddc06a3.PNG">  
+<img width="700" alt="compare and pull request" src="https://user-images.githubusercontent.com/63443481/136186304-c0a767ea-1fd2-4b0c-b5a8-3e366ddc06a3.PNG">
 
-<img width="882" alt="opening pull request" src="https://user-images.githubusercontent.com/63443481/136186322-bfd5f333-136a-4d2f-8891-e8f97c379ba8.PNG">  
+<img width="882" alt="opening pull request" src="https://user-images.githubusercontent.com/63443481/136186322-bfd5f333-136a-4d2f-8891-e8f97c379ba8.PNG">
 
 - Voila! Your Pull Request has been submitted and it's ready to be merged.🥳
-#### Happy Contributing!
+
+#### Happy Contributing!

README.md

@@ -43,11 +43,11 @@ To enable a theme, append `&theme=` followed by the theme name to the end of the
 [![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=DenverCoder1&theme=dark)](https://git.io/streak-stats)
 ```
 
-|     Theme      |                               Preview                               |
-| :------------: | :-----------------------------------------------------------------: |
-|   `default`    |             ![default](https://i.imgur.com/IaTuYdS.png)             |
-|     `dark`     |              ![dark](https://i.imgur.com/bUrsjlp.png)               |
-| `highcontrast` |          ![highcontrast](https://i.imgur.com/ovrVrTY.png)           |
+|     Theme      |                               Preview                                |
+| :------------: | :------------------------------------------------------------------: |
+|   `default`    |             ![default](https://i.imgur.com/IaTuYdS.png)              |
+|     `dark`     |               ![dark](https://i.imgur.com/bUrsjlp.png)               |
+| `highcontrast` |           ![highcontrast](https://i.imgur.com/ovrVrTY.png)           |
 |  More themes!  | **🎨 [See a list of all available themes](./docs/themes/README.md)** |
 
 > If you have come up with a new theme you'd like to share with others, open an issue to add it!
@@ -138,15 +138,14 @@ You can deploy the PHP files on any website server with PHP installed or as a He
 
 [![](https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png)](#) [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/DenverCoder1/github-readme-streak-stats/tree/main "Deploy to Heroku")
 
-  5. **Add the token** as a Config Var with the key `TOKEN`:
+5. **Add the token** as a Config Var with the key `TOKEN`:
 
-  ![heroku config variables](https://user-images.githubusercontent.com/20955511/136292022-a8d9b3b5-d7d8-4a5e-a049-8d23b51ce9d7.png)
-  
-  6. Click **"Deploy App"** at the end of the form
-  7. Once the app is deployed, you can use `<your-app-name>.herokuapp.com` in place of `github-readme-streak-stats.herokuapp.com`
-  
-</details>
+![heroku config variables](https://user-images.githubusercontent.com/20955511/136292022-a8d9b3b5-d7d8-4a5e-a049-8d23b51ce9d7.png)
 
+6. Click **"Deploy App"** at the end of the form
+7. Once the app is deployed, you can use `<your-app-name>.herokuapp.com` in place of `github-readme-streak-stats.herokuapp.com`
+
+</details>
 
 ## 🤗 Contributing
 
@@ -186,6 +185,7 @@ cd github-readme-streak-stats
 ```
 
 ### Install dependencies
+
 Run the following command to install all the required dependencies to work on this project.
 
 ```bash