Patch 21 (#25)

* #21 updated to meet Prettier style guidelines

Author: mvogelgesang

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "trailingComma": "none",
+  "overrides": [
+    {
+      "files": "**/lwc/**/*.html",
+      "options": { "parser": "lwc" }
+    },
+    {
+      "files": "*.{cmp,page,component,design,auradoc}",
+      "options": { "parser": "html" }
+    }
+  ]
+}

CONTRIBUTING.md

@@ -1,11 +1,13 @@
-# Welcome!
+# Welcome
 
 We're so glad you're thinking about contributing to a U.S. Government open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
 
 ## How to contribute to this project
 
 - We want to ensure a welcoming environment for all of our projects. Our staff follows this [Code of Conduct](CODE_OF_CONDUCT.md) and all contributors should do the same.
 - Report bugs and request features via Github Issues
+  - If you are not sure that the issue is related to the website you can [create the issue in our general repository](https://github.com/gsa/code-gov/issues/new): [code-gov](https://github.com/gsa/code-gov)
+- [Email us](mailto://code@gsa.gov) your ideas on how to improve the code-gov-front-end. We're always open to suggestions.
 - Create a [Github pull request](https://help.github.com/articles/creating-a-pull-request/) with new functionality or fixing a bug.
 - Improve or create documentation.
 - Help us improve our tests.
@@ -17,12 +19,12 @@ As noted in [LICENSE](LICENSE.md), this project is in the worldwide public domai
 
 All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
 
-# Issue Guidelines
-In the interest of making it easier for our contributors to manage site issues, we request that issues follow certain guidelines.  Our developers mainly use [issues](/issues) to identify and prioritize their work.  If you have questions about code.gov or would like start a general discussion, we kindly request that you email us at code@gsa.gov.  Our issue guidelines are a living document and a work in progress, so feel free to offer feedback on it, by emailing us at [gsalabs@gsa.gov](mailto://gsalabs@gsa.gov)
- - **Specific**: The issue makes specific requests.  An example of a specific request would be `Reduce the Size of Images`.   An example of a non-specific request would be `Improve Site Performance`.
- - **Measurable**: The issue has specific requirements and can be closed when those requirements are met.  This helps us track the progress in addressing problems.  For example, tech debt is always something to work on, so we should create separate issues for this, such as `Consolidate Styling of Repo and Task Cards` and `Convert Validator from Monaco Editor to jsoneditor`, rather than `Address Tech Debt`.
- - **Actionable**: An issue should request a specific action from a member of the code.gov team or community.  An example of something actionable would be `Remove Debugging Text from Loading Screen`.  An example of something that isn't actionable by our team or community is `My city should be forking Code.gov`.
- - **Realistic**: The issue is something that is achievable by the resources of the project, including contributions from the open source community.  An example of a realistic issue is `Include Line Numbers in Validator`.
- - **Time-Aware**: The issue is something that can be resolved within 6 months.  If you think your issue might take longer, we encourage you to break up your issues into smaller issues (like stepping stones) that we can address.  We can still work on big problems, but it is easier for us to track progress and identify what we need to work on, when big problems are broken up into smaller ones.
- 
- 
+## Issue Guidelines
+
+In the interest of making it easier for our contributors to manage site issues, we request that issues follow certain guidelines. Our developers mainly use [issues](/issues) to identify and prioritize their work. If you have questions about code.gov or would like start a general discussion, we kindly request that you email us at code@gsa.gov. Our issue guidelines are a living document and a work in progress, so feel free to offer feedback on it, by emailing us at [gsalabs@gsa.gov](mailto://gsalabs@gsa.gov)
+
+- **Specific**: The issue makes specific requests. An example of a specific request would be `Reduce the Size of Images`. An example of a non-specific request would be `Improve Site Performance`.
+- **Measurable**: The issue has specific requirements and can be closed when those requirements are met. This helps us track the progress in addressing problems. For example, tech debt is always something to work on, so we should create separate issues for this, such as `Consolidate Styling of Repo and Task Cards` and `Convert Validator from Monaco Editor to jsoneditor`, rather than `Address Tech Debt`.
+- **Actionable**: An issue should request a specific action from a member of the code.gov team or community. An example of something actionable would be `Remove Debugging Text from Loading Screen`. An example of something that isn't actionable by our team or community is `My city should be forking Code.gov`.
+- **Realistic**: The issue is something that is achievable by the resources of the project, including contributions from the open source community. An example of a realistic issue is `Include Line Numbers in Validator`.
+- **Time-Aware**: The issue is something that can be resolved within 6 months. If you think your issue might take longer, we encourage you to break up your issues into smaller issues (like stepping stones) that we can address. We can still work on big problems, but it is easier for us to track progress and identify what we need to work on, when big problems are broken up into smaller ones.

INSTALLATION.md

@@ -2,31 +2,31 @@
 
 ## Dependencies
 
-* Font Awesome
-  * **Required For** fontAwesomeIcon and socialMediaNavMenu components.
-  * Register with Font Awesome to create icon kits, [https://fontawesome.com/start](https://fontawesome.com/start). You'll receive a JS snippet to include in your site. Hold onto that for later.
+- Font Awesome
+  - **Required For** fontAwesomeIcon and socialMediaNavMenu components.
+  - Register with Font Awesome to create icon kits, [https://fontawesome.com/start](https://fontawesome.com/start). You'll receive a JS snippet to include in your site. Hold onto that for later.
 
 ## Instructions
 
-* Two methods available to push code to your sandbox
-  * Install via [https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx)
-  * Clone this repository and push
-* Enable Communities in your Salesforce org
-* For new communities 
-  * Create new community (Setup > Communities > New Template (for e.g. Customer Account Portal)
-  * Provide Name > Builder > Theme 
-  * Select USWDS Lightning Community
-* For existing communities
-  * (Setup > Communities> Builder > Theme)
-  * Select USWDS Lightning Community
-* Enter name of community and a community specific url (if desired)
-* From Workspaces, navigate to Administration
-  * Login & Registration
-    * Update Logo to use Agency-specific logo
-    * Update Footer text. Note, US Government agencies do not hold copyright, see [Government Works](https://www.usa.gov/government-works). Entering © My Agency is improper. Instead, just enter the agency name.
-    * Set Logout Page URL
-    * Save
-  * Update other settings as needed.
+- Two methods available to push code to your sandbox
+  - Install via [https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx)
+  - Clone this repository and push
+- Enable Communities in your Salesforce org
+- For new communities
+  - Create new community (Setup > Communities > New Template (for e.g. Customer Account Portal)
+  - Provide Name > Builder > Theme
+  - Select USWDS Lightning Community
+- For existing communities
+  - (Setup > Communities> Builder > Theme)
+  - Select USWDS Lightning Community
+- Enter name of community and a community specific url (if desired)
+- From Workspaces, navigate to Administration
+  - Login & Registration
+    - Update Logo to use Agency-specific logo
+    - Update Footer text. Note, US Government agencies do not hold copyright, see [Government Works](https://www.usa.gov/government-works). Entering © My Agency is improper. Instead, just enter the agency name.
+    - Set Logout Page URL
+    - Save
+  - Update other settings as needed.
 
 ### Experience Builder Setup
 
@@ -36,62 +36,62 @@ Navigate to Experience Builder by clicking Administration in the top left, and c
 
 This theme relies on five navigation menus:
 
-* Main Navigation
-* Header Secondary Navigation - below Search
-  * Limit this nav to three or fewer entries
-* Main Footer Nav
-* Footer Secondary Nav
-  * Many agencies require standard links on every website such as Privacy Policy, Accessibility, SORN, etc.
-* Social Media Nav
+- Main Navigation
+- Header Secondary Navigation - below Search
+  - Limit this nav to three or fewer entries
+- Main Footer Nav
+- Footer Secondary Nav
+  - Many agencies require standard links on every website such as Privacy Policy, Accessibility, SORN, etc.
+- Social Media Nav
 
 #### Change Theme Layout and Settings
 
-* Settings > Theme > Configure
-* Change Theme Layout Component for the Default and Login Theme Layouts to USWDS Theme Layout. Accept alert and click OK.
-  * Add Theme Images
-    * Navigate to Theme (paint brush)
-    * Update Images
-      * Upload your organization logo under Company Logo. Update Login Page Background Image if desired.
-        * A logo with transparent background is best as the header and footer are different colors.
-    * Update Theme Settings
-      * Work down the list of theme settings. As you tab through, the underlying page will update after each field.
-      * If you created a community specific URL ...force.com/blah, update the Path to Home Page section to include beginning of URI path
-      * Enter navigation menu names for each Nav Menu Name section
-      * If you plan to override a particular section, toggle the section on to reveal an Aura.Component[] drop zone
-    * Update Theme Colors
-      * This repository ships with base theme colors but can be customized to specific needs. While not comprehensive, the following maps color settings to components in the community.
-        * Action Color
-          * Tab Component (specifically active tab)
-          * Tile Menu
-        * Overlay Text Color
-          * User Profile Menu
-        * Detail Text Color
-          * Tabs (inactive)
+- Settings > Theme > Configure
+- Change Theme Layout Component for the Default and Login Theme Layouts to USWDS Theme Layout. Accept alert and click OK.
+  - Add Theme Images
+    - Navigate to Theme (paint brush)
+    - Update Images
+      - Upload your organization logo under Company Logo. Update Login Page Background Image if desired.
+        - A logo with transparent background is best as the header and footer are different colors.
+    - Update Theme Settings
+      - Work down the list of theme settings. As you tab through, the underlying page will update after each field.
+      - If you created a community specific URL ...force.com/blah, update the Path to Home Page section to include beginning of URI path
+      - Enter navigation menu names for each Nav Menu Name section
+      - If you plan to override a particular section, toggle the section on to reveal an Aura.Component[] drop zone
+    - Update Theme Colors
+      - This repository ships with base theme colors but can be customized to specific needs. While not comprehensive, the following maps color settings to components in the community.
+        - Action Color
+          - Tab Component (specifically active tab)
+          - Tile Menu
+        - Overlay Text Color
+          - User Profile Menu
+        - Detail Text Color
+          - Tabs (inactive)
 
 #### Add Font Awesome JS
 
-Fontawsome needs to be a trusted site for both scripts and other resources.  There are two sites that need to be defined by Salesforce:
+Fontawsome needs to be a trusted site for both scripts and other resources. There are two sites that need to be defined by Salesforce:
 
 1. Under Salesforce Setup (Not in Experience Builder) search for CSP Trusted Sites.
 1. Click New Trusted Site.
-    1. Trusted Site Name: kitfreefontawsome
-    1. Trusted Site URL: [https://kit-free.fontawesome.com](https://kit-free.fontawesome.com)
-    1. Context: Communities
-    1. Leave all other boxes checked
+   1. Trusted Site Name: kitfreefontawsome
+   1. Trusted Site URL: [https://kit-free.fontawesome.com](https://kit-free.fontawesome.com)
+   1. Context: Communities
+   1. Leave all other boxes checked
 1. Click Save
 
-Back in Experience Builder > Settings > Security.  
+Back in Experience Builder > Settings > Security.
 
 1. Change the Content Secuirty Policy (CSP) to "Allow Inline Scripts and Script Access to Whitelisted Third-party Hosts
 1. Click + Add Trusted Site.
-    1. Name: fontawesome
-    1. URL: [https://kit.fontawesome.com](https://kit.fontawesome.com)
+   1. Name: fontawesome
+   1. URL: [https://kit.fontawesome.com](https://kit.fontawesome.com)
 
 Enter the header script Tag:
-From Settings>Advanced.  
+From Settings>Advanced.
 
-1. Click Edit Head Markup.  
-1. Paste the script tag.  
+1. Click Edit Head Markup.
+1. Paste the script tag.
 1. Click Save
 
-When saved you should not get any CSP errors.  
+When saved you should not get any CSP errors.

README.md

@@ -1,5 +1,7 @@
 # US Web Design System Salesforce Lightning Community Theme
 
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
 An implementation of the US Web Design System for Salesforce Lightning Communities.
 
 ![US Web Design System Salesforce Community Template Example](img/desktop.png "US Web Design System Salesforce Community Theme Example")