build: spellchecker (#689)

* build(cspell): add spellchecker
* build(cspell): add cspell github-action
* docs: fix spelling mistakes

.github/workflows/ci.yml

@@ -95,3 +95,50 @@ jobs:
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.github_token }}
+
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: streetsidesoftware/cspell-action@main
+        with:
+          # Github token used to fetch the list of changed files in the commit.
+          # Default: ${{ github.token }}
+          github_token: ${{ github.token }}
+
+          # Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.
+          # The default is to check ALL files that were changed in in the pull_request or push.
+          # Note: `ignorePaths` defined in cspell.json still apply.
+          # Example:
+          # files: |
+          #   **/*.{ts,js}
+          #   !dist/**/*.{ts,js}
+          #   # Hidden directories need an explicit .* to be included
+          #   .*/**/*.yml
+          #
+          # To not check hidden files, use:
+          # files: "**"
+          #
+          # Default: ALL files
+          files: '**'
+
+          # The point in the directory tree to start spell checking.
+          # Default: .
+          root: '.'
+
+          # Notification level to use with inline reporting of spelling errors.
+          # Allowed values are: warning, error, none
+          # Default: warning
+          inline: error
+
+          # Determines if the action should be failed if any spelling issues are found.
+          # Allowed values are: true, false
+          # Default: true
+          strict: true
+
+          # Limit the files checked to the ones in the pull request or push.
+          incremental_files_only: false
+
+          # Path to `cspell.json`
+          config: 'cspell.json'

CONTRIBUTORS.txt

@@ -0,0 +1,19 @@
+aremishevsky
+Bezalel
+bforbis
+Chim
+cloudmu
+dylang
+Elad
+graingert
+julbra
+leonardobazico
+Liran
+midgleyc
+mpth
+oshri
+oufeng
+rsethc
+sunnylqm
+Tazelaar
+trbngr

README.md

@@ -340,7 +340,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onOpen(proxySocket) {
     // listen for messages coming FROM the target here
-    proxySocket.on('data', hybiParseAndLogMessage);
+    proxySocket.on('data', hybridParseAndLogMessage);
   }
   ```
 
@@ -585,6 +585,9 @@ $ yarn test
 
 # code coverage
 $ yarn cover
+
+# check spelling mistakes
+$ yarn spellcheck
 ```
 
 ## Changelog

cspell.json

@@ -0,0 +1,40 @@
+{
+  "language": "en",
+  "spellCheckDelayMs": 500,
+  "dictionaries": ["node", "npm", "typescript", "contributors"],
+  "ignorePaths": ["node_modules/**", "coverage/**", "dist/**", "package.json", "yarn.lock"],
+  "dictionaryDefinitions": [
+    {
+      "name": "contributors",
+      "path": "CONTRIBUTORS.txt"
+    }
+  ],
+  "ignoreRegExpList": ["[a-z]+path"],
+  "words": [
+    "camelcase",
+    "codesandbox",
+    "deepcode",
+    "depthfrom",
+    "fastify",
+    "globbing",
+    "gzipped",
+    "insertanchor",
+    "lcov",
+    "Lenna",
+    "lipsum",
+    "lorum",
+    "middlewares",
+    "millis",
+    "mockttp",
+    "Nodejitsu",
+    "ntlm",
+    "proxied",
+    "proxying",
+    "rawbody",
+    "restream",
+    "streamify",
+    "vhosted",
+    "websockets",
+    "xfwd"
+  ]
+}

examples/response-interceptor/index.js

@@ -8,6 +8,7 @@ const express = require('express');
 const { createProxyMiddleware, responseInterceptor } = require('../../dist'); // require('http-proxy-middleware');
 
 // test with double-byte characters
+// cSpell:ignore Kroket, ส้มตำไทย, चिकन
 const favoriteFoods = [
   {
     country: 'NL',

examples/websocket/index.html

@@ -93,7 +93,7 @@ <h2>WebSocket demo</h2>
             log('DISCONNECTED');
           });
           socket.addEventListener('error', () => {
-            log('SOCKET ERROR OCCURED');
+            log('SOCKET ERROR OCCURRED');
           });
           socket.addEventListener('message', (msg) => {
             log('RECEIVED:' + msg.data);

package.json

@@ -22,7 +22,8 @@
     "precoverage": "yarn build",
     "coverage": "jest --coverage --coverageReporters=lcov",
     "prepare": "husky install",
-    "prepack": "yarn build && rm dist/tsconfig.tsbuildinfo"
+    "prepack": "yarn build && rm dist/tsconfig.tsbuildinfo",
+    "spellcheck": "npx --yes cspell --show-context --show-suggestions '**/*.*'"
   },
   "repository": {
     "type": "git",

recipes/async-response.md

@@ -50,7 +50,7 @@ const myProxy = createProxyMiddleware({
   selfHandleResponse: true,
   onProxyReq: (proxyReq, req, res) => {
     // before
-    // get something async from entry middlware before the proxy kicks in
+    // get something async from entry middleware before the proxy kicks in
     console.log('proxyReq:', req.locals.da);
 
     proxyReq.setHeader('mpth-1', req.locals.da);

recipes/logLevel.md

@@ -12,7 +12,7 @@ Possible values:
 
 ## Level: debug
 
-Log everyting.
+Log everything.
 
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');

recipes/logProvider.md

@@ -60,7 +60,7 @@ const logProvider = function (provider) {
   const logger = new winston.Logger({
     transports: [
       new winston.transports.Console(),
-      new winston.transports.File({ filename: 'somefile.log' }),
+      new winston.transports.File({ filename: 'some-file.log' }),
     ],
   });
 

recipes/modify-post.md

@@ -44,8 +44,8 @@ const proxy_options = {
       let body = new Object();
 
       body.filename = 'reports/statistics/summary_2016.pdf';
-      body.routeid = 's003b012d002';
-      body.authid = 'bac02c1d-258a-4177-9da6-862580154960';
+      body.routeId = 's003b012d002';
+      body.authId = 'bac02c1d-258a-4177-9da6-862580154960';
 
       // URI encode JSON object
       body = Object.keys(body)

recipes/response-interceptor.md

@@ -99,7 +99,7 @@ Some working examples on <https://03rjl.sse.codesandbox.io>/[relative wikimedia
 _You can just use any relative image path from <https://upload.wikimedia.org> and use the relative image path on <https://03rjl.sse.codesandbox.io> to see the manipulated image._
 
 ```javascript
-const Jimp = require('jimp'); // use jimp libray for image manipulation
+const Jimp = require('jimp'); // use jimp library for image manipulation
 
 const proxy = createProxyMiddleware({
   target: 'https://upload.wikimedia.org',

test/e2e/websocket.spec.ts

@@ -125,6 +125,7 @@ describe('E2E WebSocket proxy', () => {
     beforeEach(() => {
       // override
       proxyServer = createApp(
+        // cSpell:ignore notworkinghost
         createProxyMiddleware('ws://notworkinghost:6789', {
           router: { '/socket': `ws://localhost:${WS_SERVER_PORT}` },
           pathRewrite: { '^/socket': '' },

test/unit/response-interceptor.spec.ts

@@ -52,12 +52,10 @@ describe('responseInterceptor', () => {
       response
     );
 
-    httpIncomingMessage.emit('error', new Error('some error meessage'));
+    httpIncomingMessage.emit('error', new Error('some error message'));
 
     expect(response.setHeader).not.toHaveBeenCalled();
     expect(response.write).not.toHaveBeenCalled();
-    expect(response.end).toHaveBeenCalledWith(
-      'Error fetching proxied request: some error meessage'
-    );
+    expect(response.end).toHaveBeenCalledWith('Error fetching proxied request: some error message');
   });
 });

test/unit/router.spec.ts

@@ -144,7 +144,7 @@ describe('router unit test', () => {
       });
 
       it('should target http://localhost:6000 path in not present in router config', () => {
-        fakeReq.url = '/unknow-path';
+        fakeReq.url = '/unknown-path';
         result = getTarget(fakeReq, proxyOptionWithRouter);
         return expect(result).resolves.toBeUndefined();
       });