fix: fix TypeScript declarations to match that we distribute as CommonJS

The plugin itself is now the export object. A "default" property is provided for backwards
compatibility. The built types are transformed by fix-types-for-back-compat.js, which adds an
exported declaration of ResolveTypeScriptPluginOptions for backwards compatibility.

fix #27

Author: djcsdy

.gitignore

@@ -9,6 +9,7 @@ npm-debug.log*
 *.d.ts
 *.js.map
 !/types/*.d.ts
+!/fix-types-for-back-compat.js
 
 # macOS
 .DS_Store
@@ -31,4 +32,4 @@ Temporary Items
 Thumbs.db
 ehthumbs.db
 Desktop.ini
-$RECYCLE.BIN/
+$RECYCLE.BIN/

.npmignore

@@ -8,6 +8,7 @@
 /.snyk
 *.ts
 !*.d.ts
+/fix-types-for-back-compat.js
 
 # yarn and npm
 package-lock.json
@@ -36,4 +37,4 @@ Temporary Items
 Thumbs.db
 ehthumbs.db
 Desktop.ini
-$RECYCLE.BIN/
+$RECYCLE.BIN/

.prettierignore

@@ -3,4 +3,5 @@ node_modules
 *.js
 *.d.ts
 *.js.map
-!/types/*.d.ts
+!/types/*.d.ts
+!/fix-types-for-back-compat.js

fix-types-for-back-compat.js

@@ -0,0 +1,49 @@
+"use strict";
+
+const typescript = require("typescript");
+const fs = require("fs");
+
+const program = typescript.createProgram(["index.d.ts"], {});
+const source = program.getSourceFile("index.d.ts");
+const printer = typescript.createPrinter();
+
+const fix = context => node => {
+    const visit = node => {
+        if (
+            typescript.isIdentifier(node) &&
+            node.escapedText === "ResolveTypescriptPluginOptions"
+        ) {
+            return typescript.factory.createQualifiedName(
+                typescript.factory.createIdentifier("ResolveTypescriptPlugin"),
+                typescript.factory.createIdentifier("ResolveTypescriptPluginOptions")
+            );
+        } else {
+            return typescript.visitEachChild(node, visit, context);
+        }
+    };
+    const visitTopLevel = node => {
+        if (
+            typescript.isInterfaceDeclaration(node) &&
+            node.name.escapedText === "ResolveTypescriptPluginOptions"
+        ) {
+            return typescript.factory.createModuleDeclaration(
+                [],
+                [typescript.factory.createModifier(typescript.SyntaxKind.DeclareKeyword)],
+                typescript.factory.createIdentifier("ResolveTypescriptPlugin"),
+                typescript.factory.createModuleBlock([node]),
+                typescript.NodeFlags.Namespace
+            );
+        } else {
+            return typescript.visitEachChild(node, visit, context);
+        }
+    };
+    return typescript.visitEachChild(node, visitTopLevel, context);
+};
+
+if (source != null) {
+    typescript.transform(source, [fix]).transformed.forEach(node => {
+        if (typescript.isSourceFile(node)) {
+            fs.writeFileSync("index.d.ts", printer.printFile(node));
+        }
+    });
+}

index.ts

@@ -4,11 +4,15 @@ type Resolver = NonNullable<ResolveOptions["resolver"]>;
 
 const pluginName = "ResolveTypescriptPlugin";
 
-export interface ResolveTypescriptPluginOptions {
+interface ResolveTypescriptPluginOptions {
     includeNodeModules?: boolean;
 }
 
-export default class ResolveTypescriptPlugin {
+class ResolveTypescriptPlugin {
+    /** @deprecated For backwards compatibility with versions < v1.2.
+     * Will be removed in v2.0. */
+    public static default = ResolveTypescriptPlugin;
+
     private static defaultOptions: ResolveTypescriptPluginOptions = {
         includeNodeModules: false
     };
@@ -55,3 +59,5 @@ export default class ResolveTypescriptPlugin {
         }
     }
 }
+
+export = ResolveTypescriptPlugin;

package.json

@@ -17,7 +17,7 @@
   "scripts": {
     "fix": "tsc --noEmit && eslint . --fix && prettier --write .",
     "lint": "tsc --noEmit && eslint . && prettier --check .",
-    "prepare": "tsc",
+    "prepare": "tsc && node ./fix-types-for-back-compat.js",
     "semantic-release": "semantic-release",
     "test": "ava"
   },