Decouple Markdown translation from Webpack plumbing

phildarnowsky-broad · phildarnowsky-broad · commit 4e12cc435fd5 · 2022-08-16T16:31:22.000-04:00
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,9 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  projects: ['<rootDir>/packages/*'],
+  transform: {
+    '.': 'ts-jest',
+  },
+}
diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
     "lint:css": "stylelint './**/*.js'",
     "lint:js": "eslint .",
     "lint:js:fix": "eslint . --fix",
-    "format": "prettier --write \"**/*.{js,jsx,ts,tsx}\""
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx}\"",
+    "test": "jest"
   },
   "workspaces": [
     "packages/*",
@@ -26,6 +27,8 @@
     "@babel/preset-typescript": "7.10.1",
     "@testing-library/jest-dom": "^5.2.0",
     "@testing-library/react": "^10.0.1",
+    "@types/jest": "^26.0.0",
+    "@types/memory-fs": "^0.3.3",
     "@typescript-eslint/eslint-plugin": "3.8.0",
     "@typescript-eslint/parser": "3.8.0",
     "babel-eslint": "^10.1.0",
@@ -46,6 +49,7 @@
     "file-loader": "^6.0.0",
     "html-webpack-plugin": "^4.0.1",
     "jest": "^26.1.0",
+    "memory-fs": "^0.5.0",
     "prettier": "2.0.5",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
@@ -55,6 +59,7 @@
     "stylelint-config-styled-components": "^0.1.1",
     "stylelint-order": "^4.0.0",
     "stylelint-processor-styled-components": "^1.10.0",
+    "ts-jest": "^26.1.0",
     "webpack": "^4.42.1",
     "webpack-cli": "^3.3.11",
     "webpack-dev-server": "^3.10.3"
diff --git a/packages/classification-selector/jest.config.js b/packages/classification-selector/jest.config.js
@@ -1,4 +1,8 @@
 module.exports = {
   coverageDirectory: 'coverage',
   testRegex: '(/__tests__/.*|(\\.|/)(test))\\.[jt]sx?$',
+  preset: 'ts-jest',
+  transform: {
+    '.': 'ts-jest',
+  },
 }
diff --git a/packages/markdown-loader/example/MarkdownLoaderExample.js b/packages/markdown-loader/example/MarkdownLoaderExample.js
@@ -1,5 +1,15 @@
-import example from './ExampleContent.md'
+import importedExample from './ExampleContent.md'
 
-document.title = example.title
+document.title = importedExample.title
 
-document.body.innerHTML = example.html
+const { translateMarkdown } = require('../src/markdownLoader')
+
+const literalSource = `
+# Begin first section
+This section was generated via \`translateMarkdown\`. The section below was \`import\`ed from a static Markdown source file.
+# End first section. Second section follows.
+`
+
+translateMarkdown(literalSource).then(translatedLiteralExample => {
+  document.body.innerHTML = [translatedLiteralExample.contents, importedExample.html].join(' ')
+})
diff --git a/packages/markdown-loader/jest.config.js b/packages/markdown-loader/jest.config.js
@@ -0,0 +1,8 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  transform: {
+    '.': 'ts-jest',
+  },
+  testPathIgnorePatterns: ['index.ts'],
+}
diff --git a/packages/markdown-loader/package.json b/packages/markdown-loader/package.json
@@ -3,14 +3,16 @@
   "version": "1.0.0",
   "license": "MIT",
   "repository": {
-    "type" : "git",
-    "url" : "https://github.com/broadinstitute/gnomad-browser-toolkit.git",
+    "type": "git",
+    "url": "https://github.com/broadinstitute/gnomad-browser-toolkit.git",
     "directory": "packages/markdown-loader"
   },
   "homepage": "https://github.com/broadinstitute/gnomad-browser-toolkit#readme",
   "bugs": "https://github.com/broadinstitute/gnomad-browser-toolkit/issues",
   "main": "lib/cjs/markdownLoader.js",
-  "files": ["lib"],
+  "files": [
+    "lib"
+  ],
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/markdown-loader/src/__tests__/__snapshots__/markdownLoader.spec.ts.snap b/packages/markdown-loader/src/__tests__/__snapshots__/markdownLoader.spec.ts.snap
@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`markdownLoader translateMarkdown returns promise to string of rendered HTML 1`] = `
+"<h1>This is a heading</h1>
+<p>Followed by a paragraph</p>
+<ul>
+<li>Some people</li>
+<li>overuse</li>
+<li>bulleted lists
+</li>
+</ul>
+"
+`;
diff --git a/packages/markdown-loader/src/__tests__/example.md b/packages/markdown-loader/src/__tests__/example.md
@@ -0,0 +1,7 @@
+# This is a heading
+
+Followed by a paragraph
+
+	* Some people
+	* overuse
+	* bulleted lists
diff --git a/packages/markdown-loader/src/__tests__/markdownLoader.spec.ts b/packages/markdown-loader/src/__tests__/markdownLoader.spec.ts
@@ -0,0 +1,20 @@
+import { translateMarkdown } from '../markdownLoader'
+
+describe('markdownLoader', () => {
+  test('translateMarkdown returns promise to string of rendered HTML', async done => {
+    const exampleMarkdownSource = `
+# This is a heading
+
+Followed by a paragraph
+
+* Some people
+* overuse
+* bulleted lists
+	`
+
+    translateMarkdown(exampleMarkdownSource).then((result: any) => {
+      expect(result.contents).toMatchSnapshot()
+      done()
+    })
+  })
+})
diff --git a/packages/markdown-loader/src/markdownLoader.js b/packages/markdown-loader/src/markdownLoader.js
@@ -33,39 +33,42 @@ const linkTransformer = () => tree => {
 }
 /* eslint-enable no-param-reassign */
 
-module.exports = function markdownLoader(content) {
-  const callback = this.async()
-
+const translateMarkdown = markdownSource =>
   remark()
     .use(frontmatter)
     .use(extract, { yaml })
     .use(imageFinder)
     .use(linkTransformer)
     .use(html)
-    .process(content)
-    .then(vfile => {
-      let output = `export default ${JSON.stringify({
-        ...vfile.data,
-        html: vfile.contents,
-      })};`
+    .process(markdownSource)
 
-      const imports = []
+const markdownLoader = function (content) {
+  const callback = this.async()
+  translateMarkdown(content).then(vfile => {
+    let output = `export default ${JSON.stringify({
+      ...vfile.data,
+      html: vfile.contents,
+    })};`
 
-      output = output.replace(/___MD_CONTENT_IMAGE_([0-9]+)___/g, (match, p1) => {
-        const imageIndex = parseInt(p1, 10)
-        const request = loaderUtils.stringifyRequest(
-          this,
-          loaderUtils.urlToRequest(vfile.images[imageIndex])
-        )
-        imports.push(`import ___MD_CONTENT_IMAGE_${imageIndex}__ from ${request}`)
+    const imports = []
 
-        return `" + ___MD_CONTENT_IMAGE_${imageIndex}__ + "`
-      })
+    output = output.replace(/___MD_CONTENT_IMAGE_([0-9]+)___/g, (_match, p1) => {
+      const imageIndex = parseInt(p1, 10)
+      const request = loaderUtils.stringifyRequest(
+        this,
+        loaderUtils.urlToRequest(vfile.images[imageIndex])
+      )
+      imports.push(`import ___MD_CONTENT_IMAGE_${imageIndex}__ from ${request}`)
 
-      if (imports.length > 0) {
-        output = `${imports.join(';')};${output}`
-      }
+      return `" + ___MD_CONTENT_IMAGE_${imageIndex}__ + "`
+    })
 
-      callback(null, output)
-    }, callback)
+    if (imports.length > 0) {
+      output = `${imports.join(';')};${output}`
+    }
+    callback(null, output)
+  }, callback)
 }
+
+module.exports = markdownLoader
+module.exports.translateMarkdown = translateMarkdown
diff --git a/packages/markdown-loader/tsconfig.json b/packages/markdown-loader/tsconfig.json
@@ -0,0 +1,69 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    "allowJs": true /* Allow javascript files to be compiled. */,
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    "types": ["jest"] /* Type declaration files to be included in compilation. */,
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "types": ["jest"],
+  "allowJs": true
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`	`1`	`module.exports = {`
`2`	`2`	`coverageDirectory: 'coverage',`
`3`	`3`	`testRegex: '(/__tests__/.*\|(\\.\|/)(test))\\.[jt]sx?$',`
	`4`	`+ preset: 'ts-jest',`
	`5`	`+ transform: {`
	`6`	`+ '.': 'ts-jest',`
	`7`	`+ },`
`4`	`8`	`}`