chore: convert repository to Typescript (#109)

* chore: [ts-migrate] Init tsconfig.json file

Co-authored-by: ts-migrate <>

* chore: [ts-migrate] Rename files from JS/JSX to TS/TSX

Co-authored-by: ts-migrate <>

* chore: Convert JS files to TS

* chore: Update snapshot file to use Typescript file extension

* chore: Remove ts-migrate dependency now that project has been converted to Typescript

* chore: Add Jest Typescript types.

Remove ts-expect-error comments that were introduced during initial migration with the ts-migrate tool now that the types are available in the project.

* chore: Make changes needed to remove the last ts-expect-error comments

Co-authored-by: Erica Pisani <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: 3 people

package.json

@@ -26,6 +26,7 @@
     "@babel/eslint-parser": "^7.16.5",
     "@babel/eslint-plugin": "^7.16.5",
     "@netlify/eslint-config-node": "^5.1.8",
+    "@types/jest": "^27.4.1",
     "babel-preset-gatsby-package": "^2.5.0",
     "cross-env": "^7.0.3",
     "gatsby": "^4.5.3",
@@ -51,7 +52,8 @@
     "url": "https://github.com/netlify/gatsby-plugin-netlify.git"
   },
   "scripts": {
-    "build": "babel src --out-dir . --ignore \"**/__tests__\"",
+    "build": "tsc && cd src/__tests__ && tsc",
+    "clean": "tsc --build --clean",
     "prepare": "cross-env NODE_ENV=production npm run build",
     "prepublishOnly": "npm run prepare",
     "format": "npm run format:code && npm run format:other",
@@ -60,7 +62,7 @@
     "lint": "eslint --ext .js,.jsx,.ts,.tsx .",
     "prettier": "prettier \"**/*.{md,css,scss,yaml,yml}\"",
     "test": "jest",
-    "watch": "babel -w src --out-dir . --ignore \"**/__tests__\""
+    "watch": "tsc --watch"
   },
   "engines": {
     "node": ">=12.13.0"

src/__tests__/__snapshots__/build-headers-program.js.snap renamed to src/__tests__/__snapshots__/build-headers-program.ts.snap

@@ -171,17 +171,20 @@ const createPluginData = async () => {
       ],
     },
     pathPrefix: ``,
-    publicFolder: (...files) => join(tmpDir, ...files),
+    publicFolder: (...files: any[]) => join(tmpDir, ...files),
   }
 }
 
-jest.mock(`fs-extra`, () => ({
-  ...jest.requireActual(`fs-extra`),
-  existsSync: jest.fn(),
-}))
+jest.mock(`fs-extra`, () => {
+  const actualFsExtra = jest.requireActual(`fs-extra`)
+  return {
+    ...actualFsExtra,
+    existsSync: jest.fn(),
+  }
+})
 // eslint-disable-next-line max-lines-per-function
 describe(`build-headers-program`, () => {
-  let reporter
+  let reporter: any
 
   beforeEach(() => {
     reporter = {
@@ -213,7 +216,7 @@ describe(`build-headers-program`, () => {
   it(`with manifest['pages-manifest']`, async () => {
     const pluginData = await createPluginData()
 
-    existsSync.mockImplementation((path) => !path.includes(`page-data.json`) && !path.includes(`app-data.json`))
+    existsSync.mockImplementation((path: any) => !path.includes(`page-data.json`) && !path.includes(`app-data.json`))
 
     // gatsby < 2.9 uses page-manifest
     pluginData.manifest[`pages-manifest`] = [`pages-manifest-ab11f09e0ca7ecd3b43e.js`]
@@ -244,7 +247,7 @@ describe(`build-headers-program`, () => {
       ...DEFAULT_OPTIONS,
       mergeCachingHeaders: true,
     }
-    existsSync.mockImplementation((path) => !path.includes(`app-data.json`))
+    existsSync.mockImplementation((path: any) => !path.includes(`app-data.json`))
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 

src/__tests__/build-headers-program.js renamed to src/__tests__/build-headers-program.ts

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+  }
+}

src/__tests__/gatsby-node.js renamed to src/__tests__/gatsby-node.ts

@@ -16,12 +16,12 @@ import {
   PAGE_DATA_DIR,
 } from './constants'
 
-const getHeaderName = (header) => {
+const getHeaderName = (header: any) => {
   const matches = header.match(/^([^:]+):/)
   return matches && matches[1]
 }
 
-const validHeaders = (headers, reporter) => {
+const validHeaders = (headers: any, reporter: any) => {
   if (!headers || !_.isObject(headers)) {
     return false
   }
@@ -40,20 +40,20 @@ const validHeaders = (headers, reporter) => {
   )
 }
 
-const linkTemplate = (assetPath, type = `script`) =>
+const linkTemplate = (assetPath: any, type = `script`) =>
   `Link: <${assetPath}>; rel=preload; as=${type}${type === `fetch` ? `; crossorigin` : ``}`
 
-const pathChunkName = (path) => {
+const pathChunkName = (path: any) => {
   const name = path === `/` ? `index` : kebabHash(path)
   return `path---${name}`
 }
 
-const getPageDataPath = (path) => {
+const getPageDataPath = (path: any) => {
   const fixedPagePath = path === `/` ? `index` : path
   return posix.join(`page-data`, fixedPagePath, `page-data.json`)
 }
 
-const getScriptPath = (file, manifest) => {
+const getScriptPath = (file: any, manifest: any) => {
   const chunk = manifest[file]
 
   if (!chunk) {
@@ -71,14 +71,19 @@ const getScriptPath = (file, manifest) => {
   })
 }
 
-const getLinkHeaders = (filesByType, pathPrefix) =>
-  Object.entries(filesByType).flatMap(([type, files]) =>
+const getLinkHeaders = (filesByType: any, pathPrefix: any) =>
+  Object.entries(filesByType).flatMap(([type, files]: [string, Array<string>]) =>
     files.map((file) => linkTemplate(`${pathPrefix}/${file}`, type)),
   )
 
-const headersPath = (pathPrefix, path) => `${pathPrefix}${path}`
+const headersPath = (pathPrefix: any, path: any) => `${pathPrefix}${path}`
 
-const preloadHeadersByPage = ({ pages, manifest, pathPrefix, publicFolder }) => {
+const preloadHeadersByPage = ({
+  pages,
+  manifest,
+  pathPrefix,
+  publicFolder
+}: any) => {
   const linksByPage = {}
 
   const appDataPath = publicFolder(PAGE_DATA_DIR, `app-data.json`)
@@ -91,7 +96,7 @@ const preloadHeadersByPage = ({ pages, manifest, pathPrefix, publicFolder }) =>
     hasPageData = existsSync(pageDataPath)
   }
 
-  pages.forEach((page) => {
+  pages.forEach((page: any) => {
     const scripts = _.flatMap(COMMON_BUNDLES, (file) => getScriptPath(file, manifest))
     scripts.push(
       ...getScriptPath(pathChunkName(page.path), manifest),
@@ -119,8 +124,8 @@ const preloadHeadersByPage = ({ pages, manifest, pathPrefix, publicFolder }) =>
   return linksByPage
 }
 
-const defaultMerge = (...headers) => {
-  const unionMerge = (objValue, srcValue) => {
+const defaultMerge = (...headers: any[]) => {
+  const unionMerge = (objValue: any, srcValue: any) => {
     if (Array.isArray(objValue)) {
       return _.union(objValue, srcValue)
     }
@@ -130,18 +135,18 @@ const defaultMerge = (...headers) => {
   return _.mergeWith({}, ...headers, unionMerge)
 }
 
-const headersMerge = (userHeaders, defaultHeaders) => {
+const headersMerge = (userHeaders: any, defaultHeaders: any) => {
   const merged = {}
   Object.keys(defaultHeaders).forEach((path) => {
     if (!userHeaders[path]) {
       merged[path] = defaultHeaders[path]
       return
     }
     const headersMap = {}
-    defaultHeaders[path].forEach((header) => {
+    defaultHeaders[path].forEach((header: any) => {
       headersMap[getHeaderName(header)] = header
     })
-    userHeaders[path].forEach((header) => {
+    userHeaders[path].forEach((header: any) => {
       // override if exists
       headersMap[getHeaderName(header)] = header
     })
@@ -155,34 +160,32 @@ const headersMerge = (userHeaders, defaultHeaders) => {
   return merged
 }
 
-const transformLink = (manifest, publicFolder, pathPrefix) => (header) =>
-  header.replace(LINK_REGEX, (__, prefix, file, suffix) => {
-    const hashed = manifest[file]
-    if (hashed) {
-      return `${prefix}${pathPrefix}${hashed}${suffix}`
-    }
-    if (existsSync(publicFolder(file))) {
-      return `${prefix}${pathPrefix}${file}${suffix}`
-    }
-    throw new Error(
-      `Could not find the file specified in the Link header \`${header}\`.` +
-        `The gatsby-plugin-netlify is looking for a matching file (with or without a ` +
-        `webpack hash). Check the public folder and your gatsby-config.js to ensure you are ` +
-        `pointing to a public file.`,
-    )
-  })
+const transformLink = (manifest: any, publicFolder: any, pathPrefix: any) => (header: any) => header.replace(LINK_REGEX, (__: any, prefix: any, file: any, suffix: any) => {
+  const hashed = manifest[file]
+  if (hashed) {
+    return `${prefix}${pathPrefix}${hashed}${suffix}`
+  }
+  if (existsSync(publicFolder(file))) {
+    return `${prefix}${pathPrefix}${file}${suffix}`
+  }
+  throw new Error(
+    `Could not find the file specified in the Link header \`${header}\`.` +
+      `The gatsby-plugin-netlify is looking for a matching file (with or without a ` +
+      `webpack hash). Check the public folder and your gatsby-config.js to ensure you are ` +
+      `pointing to a public file.`,
+  )
+})
 
 // Writes out headers file format, with two spaces for indentation
 // https://www.netlify.com/docs/headers-and-basic-auth/
-const stringifyHeaders = (headers) =>
-  Object.entries(headers).reduce((text, [path, headerList]) => {
-    const headersString = headerList.reduce((accum, header) => `${accum}  ${header}\n`, ``)
-    return `${text}${path}\n${headersString}`
-  }, ``)
+const stringifyHeaders = (headers: any) => Object.entries(headers).reduce((text, [path, headerList]: [string, Array<string>]) => {
+  const headersString = headerList.reduce((accum, header) => `${accum}  ${header}\n`, ``)
+  return `${text}${path}\n${headersString}`
+}, ``)
 
 // program methods
 
-const validateUserOptions = (pluginOptions, reporter) => (headers) => {
+const validateUserOptions = (pluginOptions: any, reporter: any) => (headers: any) => {
   if (!validHeaders(headers, reporter)) {
     throw new Error(
       `The "headers" option to gatsby-plugin-netlify is in the wrong shape. ` +
@@ -192,7 +195,7 @@ const validateUserOptions = (pluginOptions, reporter) => (headers) => {
     )
   }
 
-  ;[`mergeSecurityHeaders`, `mergeLinkHeaders`, `mergeCachingHeaders`].forEach((mergeOption) => {
+  [`mergeSecurityHeaders`, `mergeLinkHeaders`, `mergeCachingHeaders`].forEach((mergeOption) => {
     if (!_.isBoolean(pluginOptions[mergeOption])) {
       throw new TypeError(
         `The "${mergeOption}" option to gatsby-plugin-netlify must be a boolean. Check your gatsby-config.js.`,
@@ -212,18 +215,23 @@ const validateUserOptions = (pluginOptions, reporter) => (headers) => {
 }
 
 const mapUserLinkHeaders =
-  ({ manifest, pathPrefix, publicFolder }) =>
-  (headers) =>
-    Object.fromEntries(
-      Object.entries(headers).map(([path, headerList]) => [
-        path,
-        headerList.map(transformLink(manifest, publicFolder, pathPrefix)),
-      ]),
-    )
+  ({
+    manifest,
+    pathPrefix,
+    publicFolder
+  }: any) =>
+  (headers: any) => Object.fromEntries(
+    Object.entries(headers).map(([path, headerList]: [string, Array<string>]) => [
+      path,
+      headerList.map(transformLink(manifest, publicFolder, pathPrefix)),
+    ]),
+  )
 
 const mapUserLinkAllPageHeaders =
-  (pluginData, { allPageHeaders }) =>
-  (headers) => {
+  (pluginData: any, {
+    allPageHeaders
+  }: any) =>
+  (headers: any) => {
     if (!allPageHeaders) {
       return headers
     }
@@ -233,7 +241,7 @@ const mapUserLinkAllPageHeaders =
     const headersList = allPageHeaders.map(transformLink(manifest, publicFolder, pathPrefix))
 
     const duplicateHeadersByPage = {}
-    pages.forEach((page) => {
+    pages.forEach((page: any) => {
       const pathKey = headersPath(pathPrefix, page.path)
       duplicateHeadersByPage[pathKey] = headersList
     })
@@ -242,8 +250,10 @@ const mapUserLinkAllPageHeaders =
   }
 
 const applyLinkHeaders =
-  (pluginData, { mergeLinkHeaders }) =>
-  (headers) => {
+  (pluginData: any, {
+    mergeLinkHeaders
+  }: any) =>
+  (headers: any) => {
     if (!mergeLinkHeaders) {
       return headers
     }
@@ -260,8 +270,10 @@ const applyLinkHeaders =
   }
 
 const applySecurityHeaders =
-  ({ mergeSecurityHeaders }) =>
-  (headers) => {
+  ({
+    mergeSecurityHeaders
+  }: any) =>
+  (headers: any) => {
     if (!mergeSecurityHeaders) {
       return headers
     }
@@ -270,8 +282,10 @@ const applySecurityHeaders =
   }
 
 const applyCachingHeaders =
-  (pluginData, { mergeCachingHeaders }) =>
-  (headers) => {
+  (pluginData: any, {
+    mergeCachingHeaders
+  }: any) =>
+  (headers: any) => {
     if (!mergeCachingHeaders) {
       return headers
     }
@@ -301,18 +315,20 @@ const applyCachingHeaders =
   }
 
 const applyTransfromHeaders =
-  ({ transformHeaders }) =>
-  (headers) =>
-    _.mapValues(headers, transformHeaders)
+  ({
+    transformHeaders
+  }: any) =>
+  (headers: any) => _.mapValues(headers, transformHeaders)
 
-const transformToString = (headers) => `${HEADER_COMMENT}\n\n${stringifyHeaders(headers)}`
+const transformToString = (headers: any) => `${HEADER_COMMENT}\n\n${stringifyHeaders(headers)}`
 
 const writeHeadersFile =
-  ({ publicFolder }) =>
-  (contents) =>
-    writeFile(publicFolder(NETLIFY_HEADERS_FILENAME), contents)
+  ({
+    publicFolder
+  }: any) =>
+  (contents: any) => writeFile(publicFolder(NETLIFY_HEADERS_FILENAME), contents)
 
-const buildHeadersProgram = (pluginData, pluginOptions, reporter) =>
+const buildHeadersProgram = (pluginData: any, pluginOptions: any, reporter: any) =>
   _.flow(
     validateUserOptions(pluginOptions, reporter),
     mapUserLinkHeaders(pluginData),

src/__tests__/tsconfig.json

@@ -3,7 +3,7 @@ import { existsSync, readFile, writeFile } from 'fs-extra'
 import { HEADER_COMMENT } from './constants'
 
 // eslint-disable-next-line max-statements
-export default async function writeRedirectsFile(pluginData, redirects, rewrites) {
+export default async function writeRedirectsFile(pluginData: any, redirects: any, rewrites: any) {
   const { publicFolder } = pluginData
 
   if (redirects.length === 0 && rewrites.length === 0) return null
@@ -22,7 +22,7 @@ export default async function writeRedirectsFile(pluginData, redirects, rewrites
   ])
 
   // Map redirect data to the format Netlify expects
-  redirects = redirects.map((redirect) => {
+  redirects = redirects.map((redirect: any) => {
     const { fromPath, isPermanent, redirectInBrowser, force, toPath, statusCode, ...rest } = redirect
 
     let status = isPermanent ? `301` : `302`
@@ -49,7 +49,10 @@ export default async function writeRedirectsFile(pluginData, redirects, rewrites
     return pieces.join(`  `)
   })
 
-  rewrites = rewrites.map(({ fromPath, toPath }) => `${fromPath}  ${toPath}  200`)
+  rewrites = rewrites.map(({
+    fromPath,
+    toPath
+  }: any) => `${fromPath}  ${toPath}  200`)
 
   let commentFound = false
 

src/build-headers-program.js renamed to src/build-headers-program.ts

@@ -14,7 +14,9 @@ import makePluginData from './plugin-data'
 const assetsManifest = {}
 
 /** @type {import("gatsby").GatsbyNode["pluginOptionsSchema"]} */
-export const pluginOptionsSchema = ({ Joi }) => {
+export const pluginOptionsSchema = ({
+  Joi
+}: any) => {
   const MATCH_ALL_KEYS = /^/
 
   // headers is a specific type used by Netlify: https://www.gatsbyjs.com/plugins/gatsby-plugin-netlify/#headers
@@ -42,7 +44,10 @@ export const pluginOptionsSchema = ({ Joi }) => {
 // Inject a webpack plugin to get the file manifests so we can translate all link headers
 /** @type {import("gatsby").GatsbyNode["onCreateWebpackConfig"]} */
 
-export const onCreateWebpackConfig = ({ actions, stage }) => {
+export const onCreateWebpackConfig = ({
+  actions,
+  stage
+}: any) => {
   if (stage !== BUILD_HTML_STAGE && stage !== BUILD_CSS_STAGE) {
     return
   }
@@ -58,7 +63,11 @@ export const onCreateWebpackConfig = ({ actions, stage }) => {
 }
 
 /** @type {import("gatsby").GatsbyNode["onPostBuild"]} */
-export const onPostBuild = async ({ store, pathPrefix, reporter }, userPluginOptions) => {
+export const onPostBuild = async ({
+  store,
+  pathPrefix,
+  reporter
+}: any, userPluginOptions: any) => {
   const pluginData = makePluginData(store, assetsManifest, pathPrefix)
   const pluginOptions = { ...DEFAULT_OPTIONS, ...userPluginOptions }
 
@@ -71,7 +80,7 @@ export const onPostBuild = async ({ store, pathPrefix, reporter }, userPluginOpt
   reporter.info(`[gatsby-plugin-netlify] Creating SSR/DSG redirects...`)
 
   let count = 0
-  const rewrites = []
+  const rewrites: any = []
 
   let needsFunctions = functions.length !== 0
 

src/constants.js renamed to src/constants.ts

@@ -1,13 +1,13 @@
 import path from "path"
 
-export function buildPrefixer(prefix, ...paths) {
-  return (...subpaths) => path.join(prefix, ...paths, ...subpaths)
+export function buildPrefixer(prefix: any, ...paths: any[]) {
+  return (...subpaths: any[]) => path.join(prefix, ...paths, ...subpaths);
 }
 
 // This function assembles data across the manifests and store to match a similar
 // shape of `static-entry.js`. With it, we can build headers that point to the correct
 // hashed filenames and ensure we pull in the componentChunkName.
-export default function makePluginData(store, assetsManifest, pathPrefix) {
+export default function makePluginData(store: any, assetsManifest: any, pathPrefix: any) {
   const { program, pages, components } = store.getState()
   const publicFolder = buildPrefixer(program.directory, `public`)
   const stats = require(publicFolder(`webpack.stats.json`))

src/create-redirects.js renamed to src/create-redirects.ts

@@ -0,0 +1,106 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES2019",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    "types": [
+      "node",
+      "jest"
+    ], /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    // "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules/", "src/__tests__"]
+}