Release v0.0.2 (#1)

GiedriusGrabauskas · web-flow · commit 932b89b527e0 · 2016-08-08T14:15:35.000+03:00
* Fixes:
- Hotfix for baseDir read from config.
- Hotfix for out file from configuration name.
- checkGeneratedArguments moved to before baseUrl check.

* Update README.md

* Removed dots from CLI options descriptions.

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update package.json
diff --git a/README.md b/README.md
@@ -1,2 +1,58 @@
-# dts-bundle-appends
-Appends cutom .d.ts files into bundled d.ts file.
+# dts-bundle-appends 
+[![NPM version](http://img.shields.io/npm/v/dts-bundle-appends.svg)](https://www.npmjs.com/package/dts-bundle-appends) [![dependencies Status](https://david-dm.org/quatrocode/dts-bundle-appends/status.svg)](https://david-dm.org/quatrocode/dts-bundle-appends) [![devDependencies Status](https://david-dm.org/quatrocode/dts-bundle-appends/dev-status.svg)](https://david-dm.org/quatrocode/dts-bundle-appends?type=dev)
+
+Appends custom `d.ts` files into one `d.ts` file bundled by [dts-bundle](https://github.com/TypeStrong/dts-bundle). 
+
+## Usage
+1) Install from npm:
+```cmd
+npm install dts-bundle-appends
+```
+2) Run `dts-bundle`.
+
+3) After `d.ts` file bundled, run `dts-bundle-appends`.
+
+## Requirements
+[NodeJS](https://nodejs.org/): >= 6.0.0 
+
+## Configuration
+Default configuration are taken from a `dts-bundle.json` file.
+
+Also, you can specify a custom config file (see [#command-line](#command-line)).
+
+### Configuration options
+| Argument     | Type                           | Description                                                                                                                                                          |
+|--------------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| appends      | `string | Array<string>`       | Specifies a list of glob patterns that match `d.ts` files to be appended in bundled `d.ts` file. Read more about [globs](https://github.com/isaacs/node-glob#glob-primer). |
+
+*All other configuration options available from `dts-bundle` (read more [TypeStrong/dts-bundle#options](https://github.com/TypeStrong/dts-bundle#options)).
+
+
+### Configuration example
+```json
+{
+    "name": "module-name",
+    "main": "dist/main.d.ts",
+    "out": "module-name.d.ts",
+    "baseDir": "dist",
+    "appends": [
+      "src/global.d.ts"
+    ]
+}
+```
+
+## Command line
+```cmd
+Usage: dts-bundle-appends [options]
+
+Options:
+  --help        Show help                                                    [boolean]
+  --version     Show version number                                          [boolean]
+  --appends     Appends files to global                                       [string]
+  --out         dts-bundle bundled out file                                   [string]
+  --configJson  dts-bundle configuration file    [string] [default: "dts-bundle.json"]
+  --baseDir     dts-bundle base directory                                     [string]
+  ```
+
+## License
+[GPL-3.0](LICENSE)
diff --git a/dist/arguments.js b/dist/arguments.js
@@ -7,20 +7,20 @@ exports.default = yargs
     return `Current version: ${require('../package.json').version}`;
 })
     .option('appends', {
-    describe: 'Appends files to global.',
+    describe: 'Appends files to global',
     type: "string"
 })
     .option("out", {
-    describe: "dts-bundle bundled out file.",
+    describe: "dts-bundle bundled out file",
     type: "string"
 })
     .option("configJson", {
-    describe: "dts-bundle configuration file.",
+    describe: "dts-bundle configuration file",
     default: "dts-bundle.json",
     type: "string"
 })
     .option("baseDir", {
-    describe: "dts-bundle base directory.",
+    describe: "dts-bundle base directory",
     type: "string"
 })
     .usage('Usage: dts-bundle-appends [options]')
diff --git a/dist/cli.js b/dist/cli.js
@@ -21,21 +21,21 @@ class Cli {
             let argvCheck = yield this.checkArguments(argv);
             if (argvCheck.valid) {
                 let appends, out, baseDir;
-                if (argv.appends != null && argv.out != null && argv.out.length > 0) {
+                if (argv.appends != null && argv.out != null && argv.out.length > 0 && argv.baseDir != null && argv.baseDir.length > 0) {
                     out = argv.out;
                     appends = argv.appends;
                     baseDir = argv.baseDir || undefined;
                 }
                 else {
                     let dtsConfig = yield this.readDtsBundleConfig(argv.configJson);
-                    out = argv.out || dtsConfig.out || dtsConfig.name;
+                    out = argv.out || dtsConfig.out || this.addDTsExtension(dtsConfig.name);
                     appends = argv.appends || dtsConfig.appends;
                     baseDir = argv.baseDir || dtsConfig.baseDir || undefined;
                 }
-                if (baseDir !== undefined) {
-                    out = path.join(baseDir, out);
-                }
                 if (this.checkGeneratedArguments(appends, out)) {
+                    if (baseDir !== undefined) {
+                        out = path.join(baseDir, out);
+                    }
                     new appends_1.default(appends, out);
                 }
             }
@@ -44,6 +44,12 @@ class Cli {
             }
         });
     }
+    addDTsExtension(name) {
+        if (name != null) {
+            return `${name}.d.ts`;
+        }
+        return undefined;
+    }
     checkGeneratedArguments(appends, out) {
         if (appends == null) {
             this.throwError("[ERROR] Appends files list not specified");
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "dts-bundle-appends",
   "version": "0.0.1",
-  "description": "Appends custom definitions into bundled d.ts file.",
+  "description": "Appends custom d.ts files into d.ts file bundle by dts-bundle.",
   "keywrods": [
     "dts-bundle",
     "typescript",
diff --git a/src/arguments.ts b/src/arguments.ts
@@ -13,20 +13,20 @@ export default yargs
         return `Current version: ${require('../package.json').version}`;
     })
     .option('appends', {
-        describe: 'Appends files to global.',
+        describe: 'Appends files to global',
         type: "string"
     })
     .option("out", {
-        describe: "dts-bundle bundled out file.",
+        describe: "dts-bundle bundled out file",
         type: "string"
     })
     .option("configJson", {
-        describe: "dts-bundle configuration file.",
+        describe: "dts-bundle configuration file",
         default: "dts-bundle.json",
         type: "string"
     })
     .option("baseDir", {
-        describe: "dts-bundle base directory.",
+        describe: "dts-bundle base directory",
         type: "string"
     })
     .usage('Usage: dts-bundle-appends [options]')
diff --git a/src/cli.ts b/src/cli.ts
@@ -41,29 +41,35 @@ class Cli {
             let appends: string | Array<string>,
                 out: string,
                 baseDir: string;
-            if (argv.appends != null && argv.out != null && argv.out.length > 0) {
+            if (argv.appends != null && argv.out != null && argv.out.length > 0 && argv.baseDir != null && argv.baseDir.length > 0) {
                 out = argv.out;
                 appends = argv.appends;
                 baseDir = argv.baseDir || undefined;
             } else {
                 let dtsConfig = await this.readDtsBundleConfig(argv.configJson);
-                out = argv.out || dtsConfig.out || dtsConfig.name;
+                out = argv.out || dtsConfig.out || this.addDTsExtension(dtsConfig.name);
                 appends = argv.appends || dtsConfig.appends;
                 baseDir = argv.baseDir || dtsConfig.baseDir || undefined;
             }
 
-            if (baseDir !== undefined) {
-                out = path.join(baseDir, out);
-            }
-
             if (this.checkGeneratedArguments(appends, out)) {
+                if (baseDir !== undefined) {
+                    out = path.join(baseDir, out);
+                }
                 new Appends(appends, out);
             }
         } else {
             this.throwError("[ERROR] " + argvCheck.errorMessage);
         }
     }
 
+    private addDTsExtension(name: string): string | undefined {
+        if (name != null) {
+            return `${name}.d.ts`;
+        }
+        return undefined;
+    }
+
     private checkGeneratedArguments(appends: string | Array<string>, out: string) {
         if (appends == null) {
             this.throwError("[ERROR] Appends files list not specified");

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "dts-bundle-appends",`
`3`	`3`	`"version": "0.0.1",`
`4`		`- "description": "Appends custom definitions into bundled d.ts file.",`
	`4`	`+ "description": "Appends custom d.ts files into d.ts file bundle by dts-bundle.",`
`5`	`5`	`"keywrods": [`
`6`	`6`	`"dts-bundle",`
`7`	`7`	`"typescript",`