feat: add conditional exports

Author: jedwards1211

.gitignore

@@ -1,7 +1,9 @@
 /coverage
 /.nyc_output
 node_modules
-/es
+/mjs
+/cjs
+/types
 .eslintcache
 *.js
 *.js.flow

.npmignore

@@ -3,12 +3,36 @@
   "version": "0.0.0-development",
   "description": "super powerful structural search and replace for JavaScript and TypeScript to automate your refactoring",
   "bin": {
-    "astx": "cli/index.js"
+    "astx": "./cjs/cli/index.js"
   },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./mjs/index.mjs",
+      "require": "./cjs/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./node": {
+      "import": "./mjs/node/index.mjs",
+      "require": "./cjs/node/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./cli": {
+      "import": "./mjs/cli/index.mjs",
+      "require": "./cjs/cli/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "files": [
+    "mjs",
+    "cjs",
+    "types"
+  ],
   "astx": {
     "parser": "babel"
   },
-  "main": "index.js",
+  "main": "./cjs/index.js",
+  "types": "./types/index.d.ts",
   "sideEffects": false,
   "scripts": {
     "cli": "babel-node --extensions .ts src/cli/index.ts",
@@ -18,12 +42,13 @@
     "prettier:check": "prettier --list-different $npm_package_config_prettier",
     "tsc": "tsc",
     "tsc:watch": "npm run tsc -- --watch",
-    "clean": "rimraf es lib $(cd src; ls) *.js *.d.ts *.js.flow",
-    "build": "npm run clean && npm run build:types && npm run build:mjs && npm run check:mjs && npm run build:cjs",
-    "build:types": "tsc -p tsconfig.build.json && tsc -p tsconfig.build.json --outDir es && copy 'src/**/*.js.flow' . && copy 'src/**/*.js.flow' es",
-    "build:mjs": "cross-env OUTPUT_ESM=1 babel src --out-dir es --out-file-extension .mjs --extensions .ts --source-maps inline && babel-node --extensions .ts src/cli/index.ts -t convertImportsToMjs.ts --workers 1 --parser babel --no-gitignore -y 'es/**/*.mjs'",
-    "check:mjs": "node es/index.mjs && node es/node/index.mjs && node es/cli/index.mjs --help",
-    "build:cjs": "cross-env BABEL_ENV=es5 babel src --out-dir . --extensions \".ts\"",
+    "clean": "rimraf mjs cjs types",
+    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:mjs && npm run check:mjs",
+    "build:types": "tsc -p tsconfig.build.json && mkdir -p cjs && copy 'src/**/*.js.flow' cjs && mkdir -p mjs && copy 'src/**/*.js.flow' mjs",
+    "build:cjs": "cross-env BABEL_ENV=es5 babel src --out-dir cjs --extensions .ts",
+    "check:cjs": "node cjs/index.js && node cjs/node/index.js && node cjs/cli/index.js --help",
+    "build:mjs": "cross-env OUTPUT_ESM=1 babel src --out-dir mjs --out-file-extension .mjs --extensions .ts --source-maps inline && babel-node --extensions .ts src/cli/index.ts -t convertImportsToMjs.ts --workers 1 --parser babel --no-gitignore -y 'mjs/**/*.mjs'",
+    "check:mjs": "node mjs/index.mjs && node mjs/node/index.mjs && node mjs/cli/index.mjs --help",
     "test": "cross-env NODE_ENV=test BABEL_ENV=coverage nyc --reporter=lcov --reporter=text mocha $npm_package_config_mocha",
     "test:watch": "cross-env NODE_ENV=test BABEL_ENV=test mocha $npm_package_config_mocha --watch",
     "test:debug": "cross-env NODE_ENV=test BABEL_ENV=test mocha --inspect-brk $npm_package_config_mocha",

package.json

@@ -18,12 +18,19 @@ export {
   type CompiledReplacement,
 } from './compileReplacement'
 export { type Backend } from './backend/Backend'
-export { type NodePath, type Node } from './types'
+export {
+  type NodePath,
+  type Node,
+  type Expression,
+  type Statement,
+  type Location,
+  type File,
+} from './types'
 export { default as getBabelAutoBackend } from './babel/getBabelAutoBackend'
 export { default as getBabelBackend } from './babel/getBabelBackend'
 export { default as BabelBackend } from './babel/BabelBackend'
 export { default as getRecastBackend } from './recast/getRecastBackend'
 export { default as RecastBackend } from './recast/RecastBackend'
 export { default as CodeFrameError } from './util/CodeFrameError'
 export { default as CompilePathError } from './util/CompilePathError'
-export { type AstxConfig } from './AstxConfig'
+export { type AstxConfig, AstxConfigType } from './AstxConfig'

src/index.ts

@@ -1,6 +1,12 @@
 export { default as AstxWorkerPool } from './AstxWorkerPool'
-export { default as runTransform } from './runTransform'
-export { default as runTransformOnFile } from './runTransformOnFile'
+export {
+  default as runTransform,
+  type RunTransformOptions,
+} from './runTransform'
+export {
+  default as runTransformOnFile,
+  type RunTransformOnFileOptions,
+} from './runTransformOnFile'
 export {
   type IpcPath,
   type IpcNode,

src/node/index.ts

@@ -6,6 +6,16 @@ import { astxCosmiconfig } from './astxCosmiconfig'
 import { Transform, TransformResult } from '../Astx'
 import Gitignore from 'gitignore-fs'
 
+export type RunTransformOptions = {
+  gitignore?: Gitignore | null
+  transform?: Transform
+  transformFile?: string
+  paths?: readonly string[]
+  cwd?: string
+  config?: Partial<AstxConfig>
+  signal?: AbortSignal
+}
+
 export default async function* runTransform({
   gitignore,
   transform: _transform,
@@ -14,15 +24,7 @@ export default async function* runTransform({
   cwd = process.cwd(),
   config,
   signal,
-}: {
-  gitignore?: Gitignore | null
-  transform?: Transform
-  transformFile?: string
-  paths?: readonly string[]
-  cwd?: string
-  config?: Partial<AstxConfig>
-  signal?: AbortSignal
-}): AsyncIterable<TransformResult> {
+}: RunTransformOptions): AsyncIterable<TransformResult> {
   clearCache()
   astxCosmiconfig.clearSearchCache()
 

src/node/runTransform.ts

@@ -17,7 +17,7 @@
     // "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. */,
+    "outDir": "./types" /* 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 */
@@ -50,8 +50,7 @@
     // "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": [
-      "./node_modules/@types",
-      "./types"
+      "./node_modules/@types"
     ] /* List of folders to include type definitions from. */,
     // "types": [],                           /* 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. */,