Move TS outdir to dist/ (TypeStrong#366)

cl3m0 · Dec 27, 2016 · 0214ebe · 0214ebe
1 parent 8ed8989
commit 0214ebe
Show file tree

Hide file tree

Showing 19 changed files with 41 additions and 85 deletions.
diff --git a/.baseDir.d.ts b/.baseDir.d.ts
diff --git a/.baseDir.js.map b/.baseDir.js.map
diff --git a/.gitignore b/.gitignore
@@ -15,4 +15,4 @@
 /node_modules/
 /typescript/
 /coverage/
-/lib/
+/dist/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}
diff --git a/bin/typedoc b/bin/typedoc
@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 
-var td = require('../lib/cli.js');
+var td = require('../dist/lib/cli.js');
 new td.CliApplication();
diff --git a/gruntfile.js b/gruntfile.js
@@ -90,7 +90,7 @@ module.exports = function(grunt)
     grunt.registerTask('build-specs', function() {
         var FS = require('fs-extra');
         var Path = require('path');
-        var TypeDoc = require('./index.js');
+        var TypeDoc = require('./');
 
         var base = Path.join(__dirname, 'test', 'converter');
         var app = new TypeDoc.Application({

diff --git a/index.d.ts b/index.d.ts
diff --git a/index.js b/index.js
diff --git a/index.js.map b/index.js.map
diff --git a/package.json b/package.json
@@ -3,8 +3,8 @@
   "description": "Create api documentations for typescript projects.",
   "version": "0.5.1",
   "homepage": "http://typedoc.org",
-  "main": "index.js",
-  "typings": "index.d.ts",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "bin": {
     "typedoc": "bin/typedoc"
   },

diff --git a/test/converter.js b/test/converter.js
@@ -1,4 +1,4 @@
-var TypeDoc = require("../index.js");
+var TypeDoc = require("../");
 var FS      = require('fs');
 var Path    = require('path');
 var Assert  = require("assert");

diff --git a/test/converter/export-default/specs.json b/test/converter/export-default/specs.json
@@ -30,8 +30,8 @@
             }
           ],
           "type": {
-            "type": "instrinct",
-            "name": "number"
+            "type": "unknown",
+            "name": "5"
           },
           "defaultValue": "5"
         }

diff --git a/test/converter/export/specs.json b/test/converter/export/specs.json
@@ -30,8 +30,8 @@
             }
           ],
           "type": {
-            "type": "instrinct",
-            "name": "number"
+            "type": "unknown",
+            "name": "5"
           },
           "defaultValue": "5"
         },

diff --git a/test/converter/react/specs.json b/test/converter/react/specs.json
@@ -85,21 +85,8 @@
                 }
               ],
               "type": {
-                "type": "reflection",
-                "declaration": {
-                  "id": 35,
-                  "name": "__type",
-                  "kind": 65536,
-                  "kindString": "Type literal",
-                  "flags": {},
-                  "sources": [
-                    {
-                      "fileName": "react.d.ts",
-                      "line": 142,
-                      "character": 16
-                    }
-                  ]
-                }
+                "type": "reference",
+                "name": "__type"
               },
               "inheritedFrom": {
                 "type": "reference",
@@ -150,7 +137,7 @@
               }
             },
             {
-              "id": 36,
+              "id": 35,
               "name": "refs",
               "kind": 1024,
               "kindString": "Property",
@@ -165,21 +152,21 @@
               "type": {
                 "type": "reflection",
                 "declaration": {
-                  "id": 37,
+                  "id": 36,
                   "name": "__type",
                   "kind": 65536,
                   "kindString": "Type literal",
                   "flags": {},
                   "indexSignature": [
                     {
-                      "id": 38,
+                      "id": 37,
                       "name": "__index",
                       "kind": 8192,
                       "kindString": "Index signature",
                       "flags": {},
                       "parameters": [
                         {
-                          "id": 39,
+                          "id": 38,
                           "name": "key",
                           "kind": 32768,
                           "kindString": "Parameter",
@@ -579,7 +566,7 @@
                 34,
                 6,
                 32,
-                36,
+                35,
                 33
               ]
             },

diff --git a/test/events.js b/test/events.js
@@ -9,7 +9,7 @@
 
 var Assert   = require("assert");
 var _        = require("lodash");
-var EventsNS = require("../lib/utils/events");
+var EventsNS = require("../dist/lib/utils/events");
 var Events   = EventsNS.EventDispatcher;
 var Event    = EventsNS.Event;
 

diff --git a/test/renderer.js b/test/renderer.js
@@ -1,4 +1,4 @@
-var TypeDoc = require("../index.js");
+var TypeDoc = require("../");
 var FS      = require("fs-extra");
 var Path    = require("path");
 var Assert  = require("assert");

diff --git a/test/renderer/specs/index.html b/test/renderer/specs/index.html
@@ -80,13 +80,6 @@ <h2 id="installation">Installation</h2>
 				<pre><code class="lang-bash">$ npm install typedoc --global
 $ typedoc
 </code></pre>
-				<h2 id="preview">Preview</h2>
-				<p>If you want to know what a documentation created with TypeDoc looks like, head over
-					to the homepage of the project. We&#39;ve setup examples demonstrating the two default
-				themes shipped with the package:</p>
-				<p><a href="http://typedoc.io/themes/default">http://typedoc.io/themes/default</a><br>
-				<a href="http://typedoc.io/themes/minimal">http://typedoc.io/themes/minimal</a></p>
-				<p>The default themes can be found here: <a href="https://github.com/TypeStrong/typedoc-default-themes">https://github.com/TypeStrong/typedoc-default-themes</a></p>
 				<h2 id="usage">Usage</h2>
 				<h3 id="shell">Shell</h3>
 				<p>TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. One major
@@ -184,7 +177,7 @@ <h2 id="contributing">Contributing</h2>
 					an issue or create a pull requests:<br>
 				<a href="https://github.com/TypeStrong/typedoc">https://github.com/TypeStrong/typedoc</a></p>
 				<h2 id="license">License</h2>
-				<p>Copyright (c) 2015 <a href="http://www.TypeDoc.de">Sebastian Lenz</a>.<br>
+				<p>Copyright (c) 2015 <a href="http://typedoc.org">Sebastian Lenz</a>.<br>
 				Licensed under the Apache License 2.0.</p>
 			</div>
 		</div>

diff --git a/test/typedoc.js b/test/typedoc.js
@@ -1,4 +1,4 @@
-var TypeDoc = require("../index.js");
+var TypeDoc = require("../");
 var Path    = require("path");
 var Assert  = require("assert");
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,23 +1,19 @@
 {
-    "compilerOptions": {
-        "module": "commonjs",
-        "target": "ES5",
-        "noImplicitAny": false,
-        "removeComments": true,
-        "preserveConstEnums": true,
-        "declaration": true,
-        "sourceMap": true,
-        "inlineSources": true, // required for debugging for npm installs
-        "outDir": "./",
-        "rootDir": "./src",
-        "experimentalDecorators": true
-    },
-    "include": [
-        "src/**/*.ts"
-    ],
-    "exclude": [
-    ],
-    "atom": {
-        "rewriteTsconfig": true
-    }
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES5",
+    "noImplicitAny": false,
+    "removeComments": true,
+    "preserveConstEnums": true,
+    "declaration": true,
+    "sourceMap": true,
+    "inlineSources": true, // Required for debugging NPM published package.
+    "outDir": "dist/",
+    "rootDir": "src/",
+    "experimentalDecorators": true
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": []
 }