ci(package.json): use make

Author: chimurai

.editorconfig

@@ -16,3 +16,6 @@ trim_trailing_whitespace = false
 # Matches the exact files either package.json or .travis.yml
 [{package.json,.travis.yml}]
 indent_size = 2
+
+[Makefile]
+indent_style = tab

.eslintignore

@@ -1 +1,2 @@
 dist/*
+test/pkg/*

.github/workflows/ci.yml

@@ -59,8 +59,8 @@ jobs:
         if: steps.yarn-cache.outputs.cache-hit != 'true' # Over here!
         run: yarn install --frozen-lockfile --ignore-scripts
 
-      - name: yarn test
-        run: yarn test
+      - name: make test
+        run: make test
 
         env:
           CI: true

Makefile

@@ -0,0 +1,55 @@
+SHELL = /bin/sh
+
+YARN = yarn
+PRETTIER = $(YARN) prettier
+ESLINT = $(YARN) eslint
+JEST = $(YARN) test
+TOUCH = touch
+
+ARTIFACTS = dist coverage
+SRC_TS := $(wildcard ./src/*.ts)
+ESLINT_GLOB = "{src,test}/**/*.ts"
+PRETTIER_GLOB = "**/*.{js,ts,md,yml,json,html}"
+
+.DEFAULT_TARGET = all
+
+.PHONY: clean coverage build lint lint-fix production test
+
+all: production
+
+install: node_modules
+
+node_modules: yarn.lock
+	$(YARN) install
+	$(TOUCH) $@
+
+production: install clean build
+	rm dist/tsconfig.tsbuildinfo
+
+clean:
+	rm -rf $(ARTIFACTS)
+
+build: dist
+
+dist: $(SRC_TS)
+	$(YARN) tsc
+	$(TOUCH) $@
+
+lint:
+	$(ESLINT) $(ESLINT_GLOB)
+	$(PRETTIER) --list-different $(PRETTIER_GLOB)
+
+lint-fix:
+	$(ESLINT) --fix $(ESLINT_GLOB)
+	$(PRETTIER) --write $(PRETTIER_GLOB)
+
+test: test-unit test-pkg
+
+test-unit:
+	$(JEST)
+
+test-pkg:
+	(cd ./test/pkg && make clean install test)
+
+coverage: clean build
+	$(JEST) --coverage --coverageReporters=lcov

README.md

@@ -582,10 +582,10 @@ $ yarn lint:fix
 $ yarn build
 
 # unit tests
-$ yarn test
+$ yarn build && yarn test
 
 # code coverage
-$ yarn cover
+$ yarn build && yarn coverage
 ```
 
 ## Changelog

package.json

@@ -8,20 +8,14 @@
     "dist"
   ],
   "scripts": {
-    "clean": "rm -rf dist && rm -rf coverage",
-    "lint": "yarn prettier && yarn eslint",
-    "lint:fix": "yarn prettier:fix && yarn eslint:fix",
-    "eslint": "eslint '{src,test}/**/*.ts'",
-    "eslint:fix": "yarn eslint --fix",
-    "prettier": "prettier --list-different \"**/*.{js,ts,md,yml,json,html}\"",
-    "prettier:fix": "prettier --write \"**/*.{js,ts,md,yml,json,html}\"",
-    "prebuild": "yarn clean",
+    "clean": "make clean",
+    "lint": "make lint",
+    "lint:fix": "make lint-fix",
     "build": "tsc",
-    "pretest": "yarn build",
     "test": "jest",
-    "precoverage": "yarn build",
-    "coverage": "jest --coverage --coverageReporters=lcov",
-    "prepare": "husky install && yarn build && rm dist/tsconfig.tsbuildinfo"
+    "coverage": "make coverage",
+    "prepare": "husky install",
+    "prepack": "make production"
   },
   "repository": {
     "type": "git",

test.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+FILES="
+package.json
+yarn.lock
+node_modules/acorn/package.json
+"
+
+# calculate md5 of individual files and concat different hashes into 1 string
+MD5_CONCAT=$(echo $FILES | xargs md5)
+
+# calculate md5 of all $FILES combined
+MD5_ALL=$(echo $MD5_CONCAT | md5)
+
+echo $MD5_ALL

test/pkg/Makefile

@@ -0,0 +1,13 @@
+.PHONY: clean install test
+
+clean:
+	rm -rf node_modules http-proxy-middleware.tgz
+
+install:
+	(cd ../.. && make install)
+	(cd ../.. && npm pack)
+	(mv ../../http-proxy-middleware-*.tgz ./http-proxy-middleware.tgz)
+	npm install ./http-proxy-middleware.tgz --no-package-lock
+
+test:
+	npm test

test/pkg/README.md

@@ -0,0 +1,14 @@
+# Why this test is needed
+
+Testing purely with TypeScript doesn't cover this issue: https://github.com/Microsoft/TypeScript/wiki/'this'-in-TypeScript#red-flags-for-this
+
+https://github.com/chimurai/http-proxy-middleware/blob/c935888ea7135365bea3c4c81e4ffe48f359a670/src/http-proxy-middleware.ts#L45-L46
+
+## npm package test
+
+```shell
+make clean install test
+```
+
+Create `http-proxy-middleware.tgz` package; install and test it locally with a simple use-case to
+test for the TypeScript red-flag issue.

test/pkg/app.js

@@ -0,0 +1,15 @@
+const express = require('express');
+const { createProxyMiddleware } = require('http-proxy-middleware');
+
+const app = express();
+
+app.use(
+  createProxyMiddleware({
+    target: 'https://jsonplaceholder.typicode.com',
+    changeOrigin: true,
+  })
+);
+
+module.exports = {
+  app,
+};

test/pkg/app.spec.js

@@ -0,0 +1,14 @@
+const request = require('supertest');
+const { app } = require('./app');
+
+describe('package: http-proxy-middleware', () => {
+  let agent;
+
+  beforeEach(() => {
+    agent = request(app);
+  });
+
+  it('should proxy /users', async () => {
+    return agent.get(`/users`).expect(200);
+  });
+});

test/pkg/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  testEnvironment: 'node',
+};

test/pkg/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "dist",
+  "private": "true",
+  "description": "http-proxy-middleware package test",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "http-proxy-middleware": "file:http-proxy-middleware.tgz"
+  }
+}