@atlaskit/codemod-cli 0.9.7 → 0.10.2

package/report.api.md

@@ -0,0 +1,89 @@
+## API Report File for "@atlaskit/codemod-cli".
+
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+```ts
+declare type CliFlags = {
+  /**
+   * The transform to run
+   */
+  transform?: string;
+  /**
+   * select which transform to run
+   */
+  preset?: string;
+  /**
+   * Comma separated list of packages to run transforms for, @scope/package[@version]. If version is supplied, will only run transforms above that version
+   */
+  packages?: string;
+  /**
+   * Parser to use for parsing the source files
+   */
+  parser: 'babel' | 'babylon' | 'flow' | 'ts' | 'tsx';
+  /**
+   * Transform files with these file extensions (comma separated list)
+   */
+  extensions: string;
+  /**
+   * Ignore files that match a provided glob expression
+   */
+  ignorePattern: string;
+  /**
+   * Determines changed packages since the specified git ref and runs all codemods for them. The ref can be any valid git ref, e.g. a commit hash, HEAD etc.
+   */
+  sinceRef?: string;
+  /**
+   * Return a 1 exit code when errors were found during execution of codemods
+   */
+  failOnError?: boolean;
+  /**
+   * Filters source paths to package directories that declare a dependency on the package being upgraded
+   */
+  filterPaths?: boolean;
+};
+
+/** Converts required args to optional if they have a default
+ * Example: export type UserFlags = Default<Flags, keyof typeof defaultFlags>;
+ */
+declare type Default<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+declare const defaultFlags: {
+  parser: 'babel';
+  extensions: string;
+  ignorePattern: string;
+  logger: Console;
+};
+
+declare type Flags_2 = CliFlags & {
+  logger: {
+    log: (...args: any) => void;
+    warn: (...args: any) => void;
+  };
+};
+export { Flags_2 as Flags };
+
+declare function main(
+  input: string[],
+  userFlags: UserFlags,
+): Promise<{
+  transforms: {
+    module: string;
+    root: string;
+    dir: string;
+    base: string;
+    ext: string;
+    name: string;
+  }[];
+}>;
+export default main;
+
+export declare class NoTransformsExistError extends Error {}
+
+export declare type UserFlags = Default<Flags_2, keyof typeof defaultFlags>;
+
+export declare class ValidationError extends Error {}
+
+export {};
+```