From e69b78be99bf23b64cbe33394e9022b9c2da85c9 Mon Sep 17 00:00:00 2001
From: Dan Miller <daniel@cloudposse.com>
Date: Mon, 11 Mar 2024 10:39:05 -0700
Subject: [PATCH] feat: `prettier` in READMEs
 (https://github.com/cloudposse/terraform-aws-components/pull/998)

---
 src/README.md | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/src/README.md b/src/README.md
index e958d13..c8e8c5a 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,8 +1,10 @@
 # Component: `aurora-mysql-resources`
 
-This component is responsible for provisioning Aurora MySQL resources: additional databases, users, permissions, grants, etc.
+This component is responsible for provisioning Aurora MySQL resources: additional databases, users, permissions, grants,
+etc.
 
-NOTE: Creating additional users (including read-only users) and databases requires Spacelift, since that action to be done via the mysql provider, and by default only the automation account is whitelisted by the Aurora cluster.
+NOTE: Creating additional users (including read-only users) and databases requires Spacelift, since that action to be
+done via the mysql provider, and by default only the automation account is whitelisted by the Aurora cluster.
 
 ## Usage
 
@@ -10,7 +12,8 @@ NOTE: Creating additional users (including read-only users) and databases requir
 
 Here's an example snippet for how to use this component.
 
-`stacks/catalog/aurora-mysql/resources/defaults.yaml` file (base component for Aurora MySQL Resources with default settings):
+`stacks/catalog/aurora-mysql/resources/defaults.yaml` file (base component for Aurora MySQL Resources with default
+settings):
 
 ```yaml
 components:
@@ -22,8 +25,10 @@ components:
         enabled: true
 ```
 
-Example (not actual)
-`stacks/uw2-dev.yaml` file (override the default settings for the cluster resources in the `dev` account, create an additional database and user):
+Example (not actual):
+
+`stacks/uw2-dev.yaml` file (override the default settings for the cluster resources in the `dev` account, create an
+additional database and user):
 
 ```yaml
 import:
@@ -43,12 +48,13 @@ components:
             db_user: example
             db_password: ""
             grants:
-              - grant: [ "ALL" ]
+              - grant: ["ALL"]
                 db: example
                 object_type: database
                 schema: null
 ```
 
+<!-- prettier-ignore-start -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
@@ -124,10 +130,11 @@ components:
 | <a name="output_additional_grants"></a> [additional\_grants](#output\_additional\_grants) | Additional DB users created |
 | <a name="output_additional_users"></a> [additional\_users](#output\_additional\_users) | Additional DB users created |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
+<!-- prettier-ignore-end -->
 
 ## References
-* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/aurora-mysql-resources) - Cloud Posse's upstream component
 
+- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/aurora-mysql-resources) -
+  Cloud Posse's upstream component
 
 [<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)