style: adding stricter linting checks with prettier (cdklabs#92)

Author: dontirun

.eslintrc.json

@@ -8,8 +8,19 @@ repos:
       - id: trailing-whitespace
         exclude: ^API.md||.github/$
   - repo: https://github.com/pre-commit/mirrors-eslint
-    rev: v7.28.0
+    rev: v7.31.0
     hooks:
       - id: eslint
         files: \.[jt]sx?$
         types: [file]
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v2.3.2'
+    hooks:
+      - id: prettier
+        exclude: |
+          (?x)(
+              ^.github/|
+              ^.projen/|
+              ^.mergify.yml|
+              ^.*.json
+          )

.github/workflows/build.yml

@@ -63,13 +63,13 @@ const project = new AwsCdkConstructLibrary({
     '@aws-cdk/aws-wafv2',
     '@aws-cdk/core',
   ],
-
   pullRequestTemplateContents: [
     '',
     '----',
     '',
     '*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*',
   ],
+  eslintOptions: { prettier: true },
   publishToPypi: {
     distName: 'cdk-nag',
     module: 'cdk_nag',
@@ -93,6 +93,10 @@ const project = new AwsCdkConstructLibrary({
   buildWorkflow: true,
   release: true,
 });
+project.package.addField('prettier', { singleQuote: true, semi: true });
+project.eslint.addRules({
+  'prettier/prettier': ['error', { singleQuote: true, semi: true }],
+});
 project.package.addField('resolutions', {
   'trim-newlines': '3.0.1',
 });
@@ -125,7 +129,7 @@ project.buildWorkflow.file.addOverride('jobs.build.steps', [
   {
     if: 'steps.git_diff.outputs.has_changes',
     name: 'Commit and push changes (if changed)',
-    run: 'git add . && git commit -m "chore: self mutation" \n&& git push origin HEAD:${{ github.event.pull_request.head.ref }}',
+    run: 'git add . && git commit -m "chore: self mutation" \ngit push origin HEAD:${{ github.event.pull_request.head.ref }}',
   },
   {
     if: 'steps.git_diff.outputs.has_changes',
@@ -144,6 +148,7 @@ project.buildWorkflow.file.addOverride('jobs.build.steps', [
     },
   },
 ]);
+
 project.release.addJobs({
   release: {
     runsOn: 'ubuntu-latest',

.pre-commit-config.yaml

@@ -2,6 +2,7 @@
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 ## Code of Conduct
 
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).

.projen/deps.json

@@ -68,7 +68,8 @@ This repository use [pre-commit](https://pre-commit.com/) hooks for linting and
 6. Build
    - `npx projen build`
 7. Update relevant documentation
-8. Create the commit and update files based on `pre-commit` findings
+8. Create the commit with relevant files
+   - Note: you may need to update the commit if `pre-commit` changes/suggests changes to files
 
 ### Step 4: Make the pull request
 

.projenrc.js

@@ -82,7 +82,7 @@ user.addToPolicy(
   new PolicyStatement({
     actions: ['s3:PutObject'],
     resources: [new Bucket(this, 'rBucket').arnForObjects('*')],
-  }),
+  })
 );
 const cfnUser = user.node.children;
 for (const child of cfnUser) {