Changelog, readme and other readability corrections, touch #456.

CHANGELOG.md

@@ -38,10 +38,10 @@ _Enhancements:_
 - Introduced two new types of custom errors: `ExportError` for functionality-related errors and `HttpError` for server-related errors.
 - Introduced a new error logging mechanism with stack tracing using new function called `logWithStack`.
 - Expanded some error logs with request IDs.
-- Set headless mode to 'shell' for better performance, utilizing an older yet more efficient headless instance.
+- Set headless mode to `shell` for better performance, utilizing an older yet more efficient headless instance.
 - Set the `defaultViewport` to null and optimized code to trigger `setViewport` only once, reducing performance impact during export.
 - Removed unnecessary initial page on browser launch using `waitForInitialPage` and the `--no-startup-window` Chrome flag.
-- Revised Chromium flags sent to the browser, now located in the args array within the config file.
+- Revised Chromium flags sent to the browser, now located in the `args` array within the config file.
 - Optimized code by reducing evaluate function calls to enhance performance and minimize jumping between NodeJS and browser processes.
 - Optimized and moved chart creation initialization scripts from the HTML template to a separate module named `highcharts.js`.
 - Optimized the `clearPage` function to ensure content cleaning is only performed once, during resource release.
@@ -148,15 +148,15 @@ _Fixes:_
 
 # 3.0.2
 
-- Changed the priority of loading options to: config -> custom JSON -> envs -> CLI.
+- Changed the priority of loading options to: `config -> custom JSON -> envs -> CLI`.
 - Corrected the The unhandledRejection error, message: Protocol error: Connection closed. Most likely the page has been closed, an error related to closing the browser earlier than closing each of an active page.
-- Refactored the way options are set (the setOptions function).
-- Corrected straight inject with JS functions in chart's options (e.g. formatter), when the allowCodeExecution is set to true.
-- Organized code into two separate functions (singleExport and batchExport).
+- Refactored the way options are set (the `setOptions` function).
+- Corrected straight inject with JS functions in chart's options (e.g. formatter), when the `allowCodeExecution` is set to true.
+- Organized code into two separate functions (`singleExport` and `batchExport`).
 - Corrected reseting global options for Highcharts between each export.
 - Corrections for the linter.
 - Samples and tests corrections.
-- Added sample for the loadConfig option.
+- Added sample for the `loadConfig` option.
 - Updated README.
 - Other small fixes.
 
@@ -168,7 +168,7 @@ _Fixes:_
 
 _Fixes and enhancements:_
 
-- Replaced PhantomJS with Puppeteer.
+- Replaced `PhantomJS` with `Puppeteer`.
 - Updated the config handling system to optionally load JSON files, and improved environment var loading.
 - Rewrote the HC caching system: it's now easier to include custom modules/dependency lists in your own deployments.
 - The install step no longer requires interaction when installing.
@@ -189,15 +189,13 @@ This version is not backwards compatible out of the box!
 
 _Breaking changes:_
 
-- Log destinations must now exist before starting file logging
+- Log destinations must now exist before starting file logging.
 - When running in server mode, the following options are now disabled by default:
   - `callback`
   - `resources`
   - `customCode`
 
-Disabled options can be enabled by adding the `--allowCodeExecution` flag when
-starting the server. Using this flag is not recommended, and should not be
-done unless the server is sandboxed and not reachable on the public internet.
+Disabled options can be enabled by adding the `--allowCodeExecution` flag when starting the server. Using this flag is not recommended, and should not be done unless the server is sandboxed and not reachable on the public internet.
 
 _Changelog:_
 
@@ -212,12 +210,12 @@ _Changelog:_
 
 # 2.0.29
 
-- Added polyfill for `DOMParser` to accommodate Highcharts 9.0.
+- Added polyfill for `DOMParser` to accommodate Highcharts `v9.0`.
 - Updated some dependencies.
 
 # 2.0.28
 
-- Fixed UUID and mkdirp versions in package.json.
+- Fixed UUID and mkdirp versions in `package.json`.
 
 # 2.0.27
 
@@ -243,21 +241,21 @@ _Changelog:_
 
 - Added support for fetching sources through `npm` for automated builds. To use, set `HIGHCHARTS_CDN` to `npm`.
 - Added support for `pareto` charts.
-- Fixed issue with script concatination causing exporting errors when including certain modules.
+- Fixed issue with script concatenation causing exporting errors when including certain modules.
 
 # 2.0.18
 
-- Added HIGHCHARTS_CDN variable support for build process.
+- Added `HIGHCHARTS_CDN` variable support for build process.
 
 # 2.0.17
 
-- Added support for 7.1 charts.
+- Added support for `7.1` charts.
 - Updated dependencies.
 
 # 2.0.16
 
-- Added support for bullet charts.
-- Added support for Gantt charts.
+- Added support for `bullet` charts.
+- Added support for `gantt` charts.
 - Added configuration option for chart generation timeout (`--timeoutThreshold`).
 - Gracefull failing of 404 map collections now working properly.
 - Increased max configuration size from 5MB to 50MB.
@@ -275,18 +273,18 @@ _Changelog:_
 
 # 2.0.14
 
-- Fixed issue with CDN pull failing when using Highcharts < 6.0.
+- Fixed issue with CDN pull failing when using Highcharts < `v6.0`.
 
 # 2.0.13
 
 - Fixed an issue that caused a comma to appear when exporting charts.
 
 # 2.0.12
 
-- Build.js now uses cached respones when building styled mode to speed things up.
-- `historgram-bellcurve` is now included by default.
-- Added optional inclusion system to build.js.
-  - Will now prompt for inclusion of `wordcloud` and `annotations`.
+- The `build.js` now uses cached respones when building styled mode to speed things up.
+- The `historgram-bellcurve` is now included by default.
+- Added optional inclusion system to `build.js`.
+- Will now prompt for inclusion of `wordcloud` and `annotations`.
 
 # 2.0.11
 
@@ -298,16 +296,16 @@ _Changelog:_
 
 # 2.0.9
 
-- Added build config for including moment.js support.
+- Added build config for including `moment.js` support.
 
 # 2.0.8
 
 - Fixed `tmpdir` when starting in server mode.
 
 # 2.0.7
 
-- Now including sunburst/xrange/streamgraph/tilemap when baking with a supported version.
-- Added package-lock.json.
+- Now including `sunburst/xrange/streamgraph/tilemap` when baking with a supported version.
+- Added `package-lock.json`.
 
 # 2.0.6
 
@@ -320,8 +318,7 @@ _Changelog:_
 
 # 2.0.4
 
-- Fixed bug causing unpredictable export results if one or more exported.
-  charts contain bundled images.
+- Fixed bug causing unpredictable export results if one or more exported (charts contain bundled images).
 
 # 2.0.3
 
@@ -330,7 +327,7 @@ _Changelog:_
 # 2.0.2
 
 - Server now respects `host` option.
-- Added promise sample/test for batch export.
+- Added promise `sample/test` for batch export.
 
 # 2.0.1
 
@@ -339,8 +336,7 @@ _Changelog:_
 # 2.0.0
 
 - Fixed Phantom cleanup: instead of reaping every 2.5s, workers are checked for timeout when other work is posted.
-- Added additional error handlers to:
-  - `hhtp(s)Server`, `process`.
+- Added additional error handlers to: `http(s)Server`, `process`.
 - Worker busy check before restarting.
 - Now checking if the client connection is still open before sending returns.
 - Changed return codes for error conditions.
@@ -368,7 +364,7 @@ _Changelog:_
 
 # 1.0.9
 
-- Set minimum node version to 5.10.0.
+- Set minimum node version to `5.10.0`.
 
 # 1.0.8
 

README.md

@@ -290,7 +290,7 @@ The format, along with its default values, is as follows (using the recommended
 
 ## Custom JSON Config
 
-To load an additional JSON configuration file, use the `--loadConfig <filepath>` option. This JSON file can either be manually created or generated through a prompt triggered by the `--createConfig` option.
+To load an additional JSON configuration file, use the `--loadConfig <filepath>` option. This JSON file can either be manually created or generated through a prompt triggered by the `--createConfig <filepath>` option.
 
 ## Environment Variables
 

lib/server/web_socket.js

@@ -43,7 +43,7 @@ export function init(address) {
     const connectionOptions = {
       rejectUnauthorized: webSocketOptions.rejectUnauthorized,
       headers: {
-        // Set an access token that lasts only 5 minutes
+        // Set an access token
         auth: jwt.sign({ success: 'success' }, webSocketOptions.secret, {
           algorithm: 'HS256'
         }),