chore: publish types

index.js

@@ -152,6 +152,14 @@ import typedArrayLength from './codemods/typed-array-length/index.js';
 import typedarrayPrototypeSlice from './codemods/typedarray.prototype.slice/index.js';
 import xtend from './codemods/xtend/index.js';
 
+/**
+ * @typedef {import('./types.js').Codemod} Codemod
+ * @typedef {import('./types.js').CodemodOptions} CodemodOptions
+ */
+
+/**
+ * @type {Record<string, (options: CodemodOptions) => Codemod>}
+ */
 export const codemods = {
   "abort-controller": abortController,
   "array-buffer-byte-length": arrayBufferByteLength,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "module-replacements-codemods",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "type": "module",
   "scripts": {
@@ -9,10 +9,13 @@
     "format": "biome format --write **/*",
     "lint:types": "tsc",
     "which": "node scripts/which.js",
-    "prepublishOnly": "node scripts/generate-index.js"
+    "prepublishOnly": "npm run lint:types && node scripts/generate-index.js"
   },
   "exports": {
-    ".": "./index.js"
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./index.js"
+    }
   },
   "keywords": [],
   "author": "",
@@ -22,6 +25,7 @@
     "jscodeshift": "^0.16.1"
   },
   "files": [
+    "types",
     "index.js",
     "CONSTANTS.js",
     "codemods"

tsconfig.json

@@ -8,9 +8,14 @@
     "strict": true,
     "noImplicitThis": true,
     "alwaysStrict": true,
-    "skipLibCheck": true,
-    "noEmit": true
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./types",
+    "skipLibCheck": true
   },
-  "include": ["types.ts", "**/*.js"],
-  "exclude": ["test/fixtures/**/*"]
+  "include": ["types.ts", "index.js", "codemods/*.js"],
+  "exclude": [
+    "test/fixtures/**/*",
+    "scripts/*.js"
+  ]
 }

types/codemods/CONSTANTS.d.ts

@@ -0,0 +1 @@
+export const ALL_TYPED_ARRAY_OBJECTS: string[];

types/codemods/abort-controller/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array-buffer-byte-length/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array-every/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array-includes/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array-map/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.from/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.of/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.at/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @NOTE
+ * `array.prototype.at` supports passing a callback, e.g.:
+ * `var results = at(arr, (x, i) => x);`
+ *
+ * We don't support that for now, but the most common usage seems to be similar
+ * to the native usage
+ *
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.concat/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.copywithin/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.entries/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.every/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.filter/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.find/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.findindex/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.findlast/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.findlastindex/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.flat/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.flatmap/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.foreach/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.indexof/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.join/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.keys/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.lastindexof/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.map/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.push/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;

types/codemods/array.prototype.reduce/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function _default(options?: import("../../types.js").CodemodOptions | undefined): Codemod;
+export type Codemod = import("../../types.js").Codemod;
+export type CodemodOptions = import("../../types.js").CodemodOptions;