dts-pack
Generates concatenated .d.ts
file(s) for the TypeScript project.
Install
npm install dts-pack
Usage
Usage:
dts-pack --entry <entry-name> --module <module-name> [<options...>]
dts-pack --list [<options...>]
Options:
--help, -h, -? Show help [boolean]
--project, -p The project file or directory
[string] [default: "./tsconfig.json"]
--entry, -e The entry module name in the project [string]
--moduleName, -m The output module name [string]
--export, -x The export entity name in the entry module name [string]
--rootName, -r The root variable name [string]
--outDir, -o The output directory name (not file name)
[string] [default: "./"]
--style, -s The declaration style
[string] [choices: "module", "namespace"] [default: "module"]
--defaultName, -d The 'default' name for namespace-style
[string] [default: "_default"]
--importBindingName The identifier for binding modules with 'import'
[string] [default: "__module"]
--list If specified, outputs all imports and exports and exit
without emitting files. [boolean]
--version, -v Show version number [boolean]
Options
--help, -h, -? (boolean)
Shows the usage.
--project, -p (string)
Specifies the TypeScript project file (such as tsconfig.json) or the directory path.
If omitted, './tsconfig.json'
will be used.
--entry, -e (string)
Specifies the entry module name to expose exported entities. This is treated as a source name of the project, so the name must be the relative path name from the root source directory.
If an extension is omitted, .ts
will be appended.
--moduleName, -m (string)
Specifies the module name. This name will be used as the output filename or the directory name.
--export, -x (string)
Specifies the export name in the entry file to expose. If omitted, the entire entry module will be used as a namespace and will be exposed (such as import * as XXX from '...'; export = XXX;
).
To expose default, use '--export default'.
--rootName, -r (string)
Specifies the root variable (entity) name. This name will be used as a global entity of the exported data (e.g. export as namespace XXX;
). If omitted, the root name will not be created. This is useful for the modules exposing the global namespace (like UMD modules); if the declaration file is used for the type reference (e.g. with typeRoots
option or reference
directive), you can use the module via the namespace name without import
ing.
You can specify a nested namespace name like Some.Namespace.Name
; if specified, all namespaces will be created.
--outDir, -o (string)
Specifies the output directory. Note that you cannot specify the output filename directly; use --outDir
and --moduleName
.
--style, -s ('module' | 'namespace'
)
Specifies the declaration style. Following style names are valid.
'module'
(default)
Outputs two files named <moduleName>/index.d.ts
and <moduleName>/<moduleName>.d.ts
. index.d.ts
refers <moduleName>.d.ts
with reference
directive, and <moduleName>.d.ts
contains all modules in the project. For putting <moduleName>/
directory to your directory for external modules, you can use the module with import ... from '<moduleName>'
. You can also import
child modules, but it may cause errors because of lacks of actual child modules' sources (e.g. using with concatenated JS module).
'namespace'
[Experimental] Outputs one file named <moduleName>.d.ts
, containing dummy namespaces and exported entities. You can use import ... from '<moduleName>'
, but cannot import child modules.
This style declares dummy namespaces, and some entity types may be differ from actual types. And, for restriction of specification, the default
will be renamed to _default
(or other name specified with --defaultName
option). You can still use default
to the option --export
(renamed automatically), but cannot use default
for the descendant entities.
--defaultName, -d (string)
Specifies the entity name to rename from default
. If omitted, _default
will be used. This option will be ignored if 'module'
-style is used.
--importBindingName (string)
Specifies the dummy binding name for importing external modules (e.g. import __module from '<external-module>'
). Default is __module
.
--list (boolean)
Outputs all imports and exports in the sources of the project file. If this option is specified, no files are outputted.
--version, -v (boolean)
Shows the version number.
Examples
Output examples for both 'module-style' and 'namespace-style' is in the examples directory. For creating module-style, enter the following command on the directory:
dts-pack -p ./tsconfig.json -e index.ts -m myModule -s module -x default -o ./dist-module-style
For creating namespace-style, change 'module' of the command line above to 'namespace'.
License
MIT License