Clean up dev environment

baileytincher · baileytincher · commit 288d9182a284 · 2021-05-02T11:52:24.000-05:00
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,7 @@
-node_modules/**/*
-coverage/**/*
-dist/**/*
-.github/**/*
+**/node_modules/**/*
+**/coverage/**/*
+**/dist/**/*
+**/build/**/*
+**/.github/**/*
+**/.webpack/**/*
+**/.serverless/**/*
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,9 @@
 {
   "parser": "@typescript-eslint/parser",
+  "env": {
+    "node": true,
+    "jest/globals": true
+  },
   "parserOptions": {
     "ecmaVersion": 2020,
     "sourceType": "module"
@@ -9,7 +13,11 @@
     "prettier/@typescript-eslint",
     "plugin:prettier/recommended"
   ],
+  "plugins": ["jest"],
   "rules": {
-    "strict": 2
+    "strict": "error",
+    "@typescript-eslint/no-explicit-any": "error",
+    "@typescript-eslint/explicit-function-return-type": "error",
+    "no-undef": "error"
   }
 }
diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged
diff --git a/.huskyrc.json b/.huskyrc.json
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
diff --git a/.npmignore copy b/.npmignore copy
@@ -0,0 +1,21 @@
+tests
+coverage
+jest.config.ts
+
+.github
+
+*.md
+
+.eslintignore
+.eslintrc.json
+.prettierignore
+.prettierrc.json
+.husky
+
+yarn-error.log
+
+src
+!dist/src
+
+webpack.config.ts
+tsconfig.json
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,12 @@
-node_modules
-coverage
-.*ignore
-yarn*
-dist
-.github
+**/node_modules
+**/coverage
+**/.*ignore
+**/yarn*
+**/dist
+**/build
+**/.github
+**/.webpack
+**/.serverless
+**/.husky
+**/*.sql
+**/.env*
diff --git a/package.json b/package.json
@@ -21,34 +21,46 @@
     "postversion": "git push && git push --tags"
   },
   "devDependencies": {
-    "@types/aws-lambda": "^8.10.66",
+    "@shallot/aws": "^1.0.6",
+    "@types/aws-lambda": "^8.10.76",
     "@types/content-type": "^1.1.3",
     "@types/http-errors": "^1.8.0",
-    "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.2",
-    "@types/webpack": "^4.41.25",
-    "@types/webpack-node-externals": "^2.5.0",
-    "@typescript-eslint/eslint-plugin": "^4.5.0",
-    "@typescript-eslint/parser": "^4.5.0",
-    "eslint": "^7.12.0",
-    "eslint-config-prettier": "^6.14.0",
+    "@types/jest": "^26.0.23",
+    "@types/node": "^15.0.1",
+    "@types/webpack": "^5.28.0",
+    "@types/webpack-node-externals": "^2.5.1",
+    "@typescript-eslint/eslint-plugin": "^4.11.0",
+    "@typescript-eslint/parser": "^4.11.0",
+    "eslint": "^7.10.0",
+    "eslint-config-prettier": "^7.1.0",
+    "eslint-plugin-jest": "^24.3.4",
     "eslint-plugin-prettier": "^3.1.4",
-    "husky": "^4.3.0",
-    "jest": "^26.6.1",
-    "lint-staged": "^10.4.2",
-    "prettier": "^2.1.2",
-    "shallot": "^1.2.1",
-    "ts-jest": "^26.4.3",
-    "ts-loader": "^8.0.11",
-    "ts-node": "^9.0.0",
-    "typescript": "^4.0.3",
-    "webpack": "^5.9.0",
-    "webpack-cli": "^4.2.0",
-    "webpack-node-externals": "^2.5.2",
+    "husky": "^6.0.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^10.5.4",
+    "prettier": "https://github.com/prettier/prettier",
+    "ts-jest": "^26.5.5",
+    "ts-loader": "^9.1.1",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3",
+    "webpack": "^5.36.1",
+    "webpack-cli": "^4.6.0",
+    "webpack-node-externals": "^3.0.0",
     "yarn": "^1.22.10"
   },
   "dependencies": {
     "content-type": "^1.0.4",
     "http-errors": "^1.8.0"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "eslint --ext .ts,.js --fix"
+    ],
+    "**/*.js": [
+      "eslint --ext .ts,.js --fix"
+    ],
+    "*": [
+      "prettier --no-error-on-unmatched-pattern --write"
+    ]
   }
 }
diff --git a/src/aws/index.ts b/src/aws/index.ts
@@ -3,7 +3,7 @@
  * https://github.com/middyjs/middy/tree/master/packages/http-json-body-parser
  */
 
-import type { ShallotMiddlewareWithOptions } from 'shallot/dist/aws/core';
+import type { ShallotAWSMiddlewareWithOptions } from '@shallot/aws';
 import type { APIGatewayEvent } from 'aws-lambda';
 
 import ContentType from 'content-type';
@@ -30,12 +30,13 @@ const isJSONContentType = (requestHeaders: APIGatewayEvent['headers']): boolean
  *
  * @param config optional object to pass config options
  */
-const ShallotAWSHttpJsonBodyParser: ShallotMiddlewareWithOptions<
+const ShallotAWSHttpJsonBodyParser: ShallotAWSMiddlewareWithOptions<
   APIGatewayEvent,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   any,
   TShallotJSONBodyParserOptions
 > = (config) => ({
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
   before: async (request) => {
     if (request.event.headers != null && isJSONContentType(request.event.headers)) {
       try {
diff --git a/tests/aws.test.ts b/tests/aws.test.ts
@@ -1,9 +1,9 @@
-import type { ShallotMiddleware } from 'shallot/dist/aws/core';
+import type { ShallotAWSMiddleware } from '@shallot/aws';
 import type { Context, Handler, APIGatewayEvent } from 'aws-lambda';
 
 import { test, describe, jest, expect } from '@jest/globals';
 
-import { ShallotAWS } from 'shallot';
+import ShallotAWS from '@shallot/aws';
 import { ShallotAWSHttpJsonBodyParser } from '../src';
 
 describe('AWS JSON Body Parser Middleware', () => {
@@ -28,12 +28,12 @@ describe('AWS JSON Body Parser Middleware', () => {
   test('Valid JSON body', async () => {
     const wrappedHandler = ShallotAWS(mockHandler).use(ShallotAWSHttpJsonBodyParser());
 
-    const mockEvent = ({
+    const mockEvent = {
       body: JSON.stringify(sampleBody),
       headers: {
         'Content-Type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     const res = await wrappedHandler(mockEvent, mockContext, jest.fn());
 
     expect(res.body).toEqual(sampleBody);
@@ -42,12 +42,12 @@ describe('AWS JSON Body Parser Middleware', () => {
   test('Lowercase content-type', async () => {
     const wrappedHandler = ShallotAWS(mockHandler).use(ShallotAWSHttpJsonBodyParser());
 
-    const mockEvent = ({
+    const mockEvent = {
       body: JSON.stringify(sampleBody),
       headers: {
         'content-type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     const res = await wrappedHandler(mockEvent, mockContext, jest.fn());
 
     expect(res.body).toEqual(sampleBody);
@@ -56,49 +56,49 @@ describe('AWS JSON Body Parser Middleware', () => {
   test('Missing content-type header', async () => {
     const wrappedHandler = ShallotAWS(mockHandler).use(ShallotAWSHttpJsonBodyParser());
 
-    const mockEventNoHeader = ({
+    const mockEventNoHeader = {
       body: JSON.stringify(sampleBody),
       headers: {},
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     const res = await wrappedHandler(mockEventNoHeader, mockContext, jest.fn());
     expect(res.body).toEqual(mockEventNoHeader.body);
   });
 
   test('Invalid event body', async () => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const onErrorMiddleware: ShallotMiddleware<APIGatewayEvent, any> = {
+    const onErrorMiddleware: ShallotAWSMiddleware<APIGatewayEvent, any> = {
       onError: jest.fn(),
     };
     const wrappedHandler = ShallotAWS(mockHandler)
       .use(ShallotAWSHttpJsonBodyParser())
       .use(onErrorMiddleware);
 
-    const mockEventNoHeader = ({
+    const mockEventNoHeader = {
       body: 'this is not json',
       headers: {
         'Content-Type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     await wrappedHandler(mockEventNoHeader, mockContext, jest.fn());
 
     expect(onErrorMiddleware.onError).toHaveBeenCalled();
   });
 
   test('Null event body', async () => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const onErrorMiddleware: ShallotMiddleware<APIGatewayEvent, any> = {
+    const onErrorMiddleware: ShallotAWSMiddleware<APIGatewayEvent, any> = {
       onError: jest.fn(),
     };
     const wrappedHandler = ShallotAWS(mockHandler)
       .use(ShallotAWSHttpJsonBodyParser())
       .use(onErrorMiddleware);
 
-    const mockEventNoHeader = ({
+    const mockEventNoHeader = {
       body: null,
       headers: {
         'Content-Type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     await wrappedHandler(mockEventNoHeader, mockContext, jest.fn());
 
     expect(onErrorMiddleware.onError).toHaveBeenCalled();
@@ -107,32 +107,33 @@ describe('AWS JSON Body Parser Middleware', () => {
   test('Base64 encoded body', async () => {
     const wrappedHandler = ShallotAWS(mockHandler).use(ShallotAWSHttpJsonBodyParser());
 
-    const mockEvent = ({
+    const mockEvent = {
       isBase64Encoded: true,
       body: Buffer.from(JSON.stringify(sampleBody)).toString('base64'),
       headers: {
         'Content-Type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     const res = await wrappedHandler(mockEvent, mockContext, jest.fn());
 
     expect(res.body).toEqual(sampleBody);
   });
 
   test('Custom reviver', async () => {
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
     const reviver = (_: unknown, v: unknown) => (typeof v === 'string' ? 'test' : v);
     const wrappedHandler = ShallotAWS(mockHandler).use(
       ShallotAWSHttpJsonBodyParser({
         reviver,
       })
     );
 
-    const mockEvent = ({
+    const mockEvent = {
       body: JSON.stringify(sampleBody),
       headers: {
         'Content-Type': 'application/json',
       },
-    } as unknown) as APIGatewayEvent;
+    } as unknown as APIGatewayEvent;
     const res = await wrappedHandler(mockEvent, mockContext, jest.fn());
 
     expect(res.body).toEqual({ hello: reviver('', '') });
diff --git a/webpack.config.ts b/webpack.config.ts
@@ -26,7 +26,9 @@ const config: Configuration = {
     path: path.resolve(__dirname, 'dist'),
   },
   devtool: 'source-map',
-  externals: [nodeExternals()],
+  // Type definitions are broke on webpack-node-externals
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  externals: [nodeExternals() as any],
 };
 
 export default config;
diff --git a/yarn.lock b/yarn.lock
