aminya / flowgen-package

Generate FlowTyped compatible types for all the TypeScript definitions in a package

Flowgen-package

Generate Flow types for all the TypeScript definitions in a package

CLI

flowgen-package --packageName semver --bundlePath ./semver.js.flow
flowgen-package --packageName semver --bundlePath ./semver.js.flow --packageDir "./node_modules/some_package"
flowgen-package --packageName semver --bundlePath ./semver.js.flow --typesInstallScript "pnpm install --save-dev @types/semver"

Usage: flowgen-package [options]

Options:
  -V, --version                              output the version number
  --packageName <packageName>                The name of the package
  --bundlePath <bundlePath>                  Generate a bundle suitable for FlowTyped at this path
  --typesInstallScript <typesInstallScript>  The install script used to install `@types/packageName`. By default npm install is used
  --packageDir <packageDir>                  If given instead of installing `@types/packageName`, the types for this package are generated
  -h, --help                                 display help for command

JavsScirpt API

const { flowgenPackage } = require("flowgen-package")

flowgenPackage({
  packageName: "semver",
  bundlePath: "./semver.js",
})

For more information and options see the following:

/**
 * @typedef {object} Options
 * @property {string} packageName The name of the package
 * @property {string | undefined} bundlePath Generate a bundle suitable for FlowTyped at this path
 * @property {string | undefined} typesInstallScript The install script used to install `@types/packageName`. By default
 *   npm install is used
 * @property {string | undefined} packageDir If given instead of installing `@types/packageName`, the types for this
 *   package are generated
 */

/**
 * Generate Flow types from @types package
 *
 * @param {Options} options See the above for the documentation of options
 */
async function flowgenPackage(options)

flowgen-package's Issues

imports within declare module

flowgen-package looks promising!

I tried using with with @aws-sdk/client-ssm...

The output has import statements nested within declare module. Later in the file, the imported types are actually defined, but I don't think that the import statements are allowed within declare module anymore. For example:

// Generated from @types/@aws-sdk/client-ssm/dist/types/SSM using github.com/aminya/flowgen-package
declare module "@aws-sdk/client-ssm/dist/types/SSM" {
  import type  SSMClient from "@aws-sdk/client-ssm/dist/types/SSMClient"
  import {
    AddTagsToResourceCommandInput,
    AddTagsToResourceCommandOutput,
  } from "./commands/AddTagsToResourceCommand";

//....

declare module "@aws-sdk/client-ssm/dist/types/commands/AddTagsToResourceCommand" {
//...
  declare export type AddTagsToResourceCommandInput = { ... } & AddTagsToResourceRequest;

Do you know if there is a solution to this problem?

Probably the importFromRegex is not capable of matching this multi-line case.

Add License

I was hoping to use this module but I am unable to do so until a license is added.

Would you mind adding one? I would love to contribute back to the library. Ideally MIT so people are able to iterate upon the project.