Merge pull request #7 from go-to-k/docs/descriptioin

docs: change description

.projenrc.ts

@@ -1,5 +1,5 @@
 import { awscdk } from 'projen';
-import { TrailingComma } from 'projen/lib/javascript';
+import { TrailingComma, Transform } from 'projen/lib/javascript';
 const project = new awscdk.AwsCdkConstructLibrary({
   author: 'go-to-k',
   authorAddress: '24818752+go-to-k@users.noreply.github.com',
@@ -10,6 +10,8 @@ const project = new awscdk.AwsCdkConstructLibrary({
   name: 'elb-other-5xx-alarm',
   projenrcTs: true,
   repositoryUrl: 'https://github.com/go-to-k/elb-other-5xx-alarm.git',
+  description:
+    'CloudWatch Alarm for HTTPCode_ELB_5XX_Count excluding 500, 502, 503, and 504 (e.g. 501, 505, 561)',
   prettier: true,
   prettierOptions: {
     settings: {
@@ -23,13 +25,42 @@ const project = new awscdk.AwsCdkConstructLibrary({
   eslintOptions: {
     dirs: ['src'],
     prettier: true,
+    ignorePatterns: [
+      'example/**/*',
+      'lambda/**/*',
+      'test/assets/**/*',
+      'test/*.snapshot/**/*',
+      '*.d.ts',
+    ],
+  },
+  jestOptions: {
+    configFilePath: 'jest.config.json',
+    jestConfig: {
+      testEnvironment: 'node',
+      roots: ['<rootDir>/test'],
+      testMatch: ['**/*.test.ts'],
+      transform: {
+        '^.+\\.tsx?$': new Transform('ts-jest'),
+      },
+      snapshotSerializers: ['<rootDir>/test/snapshot-plugin.ts'],
+    },
   },
   license: 'MIT',
   keywords: ['aws', 'cdk', 'aws-cdk', 'cloudwatch', 'elb'],
   gitignore: ['*.js', '*.d.ts', 'cdk.out/'],
+  githubOptions: {
+    pullRequestLintOptions: {
+      semanticTitleOptions: {
+        types: ['feat', 'fix', 'chore', 'docs', 'test', 'refactor', 'ci'],
+      },
+    },
+  },
   // deps: [],                /* Runtime dependencies of this module. */
   // description: undefined,  /* The description is just a string that helps people understand the purpose of the package. */
   // devDeps: [],             /* Build dependencies for this module. */
   // packageName: undefined,  /* The "name" in package.json. */
 });
+project.setScript('cdk', 'cdk');
+project.setScript('integ:deploy', "cdk deploy --app='./lib/integ.js'");
+project.setScript('integ:destroy', "cdk destroy --app='./lib/integ.js'");
 project.synth();

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
+  "editor.formatOnType": true,
+  "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+  "search.exclude": {},
+  "cSpell.words": ["projen", "awscdk"],
+  "typescript.preferences.importModuleSpecifier": "relative"
+}

test/snapshot-plugin.ts

@@ -0,0 +1,11 @@
+module.exports = {
+  test: (val: unknown) => typeof val === 'string',
+  serialize: (val: string) => {
+    return `"${val
+      .replace(/([A-Fa-f0-9]{64}.zip)/, 'HASH-REPLACED.zip')
+      .replace(
+        /\${AWS::AccountId}.dkr.ecr.\${AWS::Region}.\${AWS::URLSuffix}.*:[a-z0-9]*/,
+        'registry.hub.docker.com/library/busybox',
+      )}"`;
+  },
+};