Refactor markdown + add Jest tests (#2)

.eslintrc.json

@@ -2,9 +2,11 @@
     "env": {
         "commonjs": true,
         "es6": true,
-        "node": true
+        "node": true,
+        "jest/globals": true
     },
     "extends": ["airbnb-base", "prettier"],
+    "plugins": ["jest"],
     "globals": {},
     "parserOptions": {
         "ecmaVersion": 2018

examples/markdown/test.md

@@ -12,7 +12,7 @@ Thanks for subscribing to my mailing list.
 
 This is an email which has been converted from markdown to HTML.
 
-Testing link in markdown: [link](https://test.com?param=*|MC:DATE|*)
+Testing link in markdown: [link](https://test.com?param=*|MC:DATE|*&another=true&test=lets%20test)
 
 Thanks,
 Marc

jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
+
+    // Stop running tests after `n` failures
+    // bail: 0,
+
+    // Respect "browser" field in package.json when resolving modules
+    // browser: false,
+
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "/private/var/folders/ht/lvz630p97_q64zh90cspcmh83_ggwr/T/jest_1uh6zc",
+
+    // Automatically clear mock calls and instances between every test
+    // clearMocks: false,
+
+    // Indicates whether the coverage information should be collected while executing the test
+    // collectCoverage: false,
+
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: null,
+
+    // The directory where Jest should output its coverage files
+    coverageDirectory: 'coverage',
+
+    // An array of regexp pattern strings used to skip coverage collection
+    // coveragePathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // A list of reporter names that Jest uses when writing coverage reports
+    // coverageReporters: [
+    //   "json",
+    //   "text",
+    //   "lcov",
+    //   "clover"
+    // ],
+
+    // An object that configures minimum threshold enforcement for coverage results
+    // coverageThreshold: null,
+
+    // A path to a custom dependency extractor
+    // dependencyExtractor: null,
+
+    // Make calling deprecated APIs throw helpful error messages
+    // errorOnDeprecated: false,
+
+    // Force coverage collection from ignored files using an array of glob patterns
+    // forceCoverageMatch: [],
+
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: null,
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: null,
+
+    // A set of global variables that need to be available in all test environments
+    // globals: {},
+
+    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+    // maxWorkers: "50%",
+
+    // An array of directory names to be searched recursively up from the requiring module's location
+    // moduleDirectories: [
+    //   "node_modules"
+    // ],
+
+    // An array of file extensions your modules use
+    // moduleFileExtensions: [
+    //   "js",
+    //   "json",
+    //   "jsx",
+    //   "ts",
+    //   "tsx",
+    //   "node"
+    // ],
+
+    // A map from regular expressions to module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
+
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
+
+    // Activates notifications for test results
+    // notify: false,
+
+    // An enum that specifies notification mode. Requires { notify: true }
+    // notifyMode: "failure-change",
+
+    // A preset that is used as a base for Jest's configuration
+    // preset: null,
+
+    // Run tests from one or more projects
+    // projects: null,
+
+    // Use this configuration option to add custom reporters to Jest
+    // reporters: undefined,
+
+    // Automatically reset mock state between every test
+    // resetMocks: false,
+
+    // Reset the module registry before running each individual test
+    // resetModules: false,
+
+    // A path to a custom resolver
+    // resolver: null,
+
+    // Automatically restore mock state between every test
+    // restoreMocks: false,
+
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: null,
+
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
+
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
+
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
+
+    // A list of paths to modules that run some code to configure or set up the testing framework before each test
+    // setupFilesAfterEnv: [],
+
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
+
+    // The test environment that will be used for testing
+    testEnvironment: 'node',
+
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
+
+    // Adds a location field to test results
+    // testLocationInResults: false,
+
+    // The glob patterns Jest uses to detect test files
+    // testMatch: [
+    //   "**/__tests__/**/*.[jt]s?(x)",
+    //   "**/?(*.)+(spec|test).[tj]s?(x)"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    // testPathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // The regexp pattern or array of patterns that Jest uses to detect test files
+    // testRegex: [],
+
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: null,
+
+    // This option allows use of a custom test runner
+    // testRunner: "jasmine2",
+
+    // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+    // testURL: "http://localhost",
+
+    // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+    // timers: "real",
+
+    // A map from regular expressions to paths to transformers
+    // transform: null,
+
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
+
+    // Indicates whether each individual test should be reported during the run
+    // verbose: null,
+
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
+
+    // Whether to use watchman for file crawling
+    // watchman: true,
+};

package.json

@@ -22,12 +22,15 @@
         "eslint-config-airbnb-base": "^14.0.0",
         "eslint-config-prettier": "^6.5.0",
         "eslint-plugin-import": "^2.18.2",
+        "eslint-plugin-jest": "^23.0.3",
         "husky": ">=1",
+        "jest": "^24.9.0",
         "lint-staged": ">=8",
         "prettier": "1.18.2"
     },
     "scripts": {
-        "lint": "eslint ."
+        "lint": "eslint .",
+        "test": "jest"
     },
     "husky": {
         "hooks": {

src/markdown.js

@@ -1,30 +1,69 @@
 const fs = require('fs').promises;
+const url = require('url');
+const querystring = require('querystring');
 const frontmatter = require('frontmatter');
 const marked = require('marked');
 
-// https://mailchimp.com/help/all-the-merge-tags-cheat-sheet/
-const isMailChimpTag = text => /\|(.+?)\|/.test(text);
+const isMailchimpTag = text => /\|(.+?)\|/.test(text);
 
-const originalRenderer = new marked.Renderer();
+const createMailchimpRenderer = originalRenderer => {
+    const mailchimpRenderer = new marked.Renderer();
 
-const createHtmlFromMarkdown = (content, keepMailChimpTags = true) => {
-    const newRenderer = new marked.Renderer();
+    mailchimpRenderer.em = text =>
+        isMailchimpTag(text) ? `*${text}*` : originalRenderer.em(text);
+
+    mailchimpRenderer.link = (href, text, title) => {
+        const { hostname, protocol, query } = url.parse(href);
+
+        const queryParameters = querystring.parse(query);
 
-    newRenderer.em = text =>
-        keepMailChimpTags && isMailChimpTag(text)
-            ? `*${text}*`
-            : originalRenderer.em(text);
+        const newBaseUrl = `${protocol}//${hostname}`;
+        const newQueryParameters = Object.keys(queryParameters)
+            .map(key => {
+                const value = queryParameters[key];
+                const encodedValue = isMailchimpTag(value)
+                    ? value
+                    : encodeURIComponent(value);
+                return `${key}=${encodedValue}`;
+            })
+            .join('&');
 
+        const newHref =
+            newQueryParameters.length > 0
+                ? `${newBaseUrl}?${newQueryParameters}`
+                : newBaseUrl;
+        return `<a href="${newHref}">${title}</a>`;
+    };
+
+    return mailchimpRenderer;
+};
+
+const createRenderer = (keepMailChimpTags = true) => {
+    const originalRenderer = new marked.Renderer();
+    return keepMailChimpTags
+        ? createMailchimpRenderer(originalRenderer)
+        : originalRenderer;
+};
+
+const createHtmlFromMarkdown = (content, keepMailChimpTags = true) => {
     return marked(content, {
-        renderer: newRenderer,
+        renderer: createRenderer(keepMailChimpTags),
     });
 };
 
 const parseMarkdownFile = async (
     markdownFilename,
     keepMailChimpTags = true
 ) => {
-    const fileContent = await fs.readFile(markdownFilename, 'utf8');
+    let fileContent;
+
+    try {
+        fileContent = await fs.readFile(markdownFilename, 'utf8');
+    } catch (error) {
+        return {
+            errors: [error.toString()],
+        };
+    }
 
     const { content, data } = frontmatter(fileContent);
     const html = createHtmlFromMarkdown(content, keepMailChimpTags);

src/markdownToHtmlEmail.js

@@ -28,6 +28,8 @@ const markdownToHtmlEmail = async options => {
         keepMailChimpTags
     );
 
+    console.log(fileData);
+
     const mjmlRenderedTemplate = await renderHandlebars({
         filename: mjmlTemplateFilename,
         context: {