feat(package) we will automatically determine package.json for you

Author: basarat

README.md

@@ -28,6 +28,7 @@ JavaScript developers can now just open a `.ts` file and start hacking away like
 * Compile on save
 * Project Context Support (`tsconfig.json`)
 * Project Build Support
+* `package.json` Support
 * Format code
 * Goto Declaration
 * Find References
@@ -81,6 +82,22 @@ Shortcut: `F6`. If there are any errors they are shown as well.
 
 ![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/build%20errors.png)
 
+## `package.json` Support
+Where a sample package.json looks like:
+```json
+{
+    "name": "awesome",
+    "main": "./dist/foo.js",
+    "typescript": {
+        "definition": "./definition/awesome.d.ts"
+    }
+}
+```
+
+We would generate a `definition/awesome.d.ts` file for you so that other TypeScript projects can do a simple `require('awesome')`.
+
+Also note that any node modules that ship with `typescript.definition` that you import will automatically get type inference / completion.
+
 ## Format Code
 Shortcut : `ctrl+alt+l` or `cmd+alt+l`. Will format just the selection if you have something selected otherwise it will format the entire file.
 

dist/main/tsconfig/tsconfig.js

@@ -206,17 +206,21 @@ function getProjectSync(pathOrSrcFile) {
         }
     }
     projectSpec.files = projectSpec.files.map(function (file) { return path.resolve(projectFileDirectory, file); });
-    var packagePath = projectSpec.package;
     var package = null;
-    if (packagePath) {
-        var packageJSONPath = getPotentiallyRelativeFile(projectFileDirectory, packagePath);
-        var parsedPackage = JSON.parse(fs.readFileSync(packageJSONPath).toString());
-        package = {
-            main: parsedPackage.main,
-            name: parsedPackage.name,
-            directory: path.dirname(packageJSONPath),
-            definition: parsedPackage.typescript && parsedPackage.typescript.definition
-        };
+    try {
+        var packagePath = travelUpTheDirectoryTreeTillYouFind(projectFileDirectory, 'package.json');
+        if (packagePath) {
+            var packageJSONPath = getPotentiallyRelativeFile(projectFileDirectory, packagePath);
+            var parsedPackage = JSON.parse(fs.readFileSync(packageJSONPath).toString());
+            package = {
+                main: parsedPackage.main,
+                name: parsedPackage.name,
+                directory: path.dirname(packageJSONPath),
+                definition: parsedPackage.typescript && parsedPackage.typescript.definition
+            };
+        }
+    }
+    catch (ex) {
     }
     var project = {
         compilerOptions: {},

docs/CHANGELOG.md

@@ -9,5 +9,8 @@ We only plan strictly document the breaking changes. The rest is optional.
 # v2
 * New default shortcuts for `build` : `F6` an `goto definition`: `F12`. Because I don't want to mess with your atom defaults and a major use base is VS users. [Link #145](https://github.com/TypeStrong/atom-typescript/issues/145)
 
+# v3
+* We will now resolve a parent `package.json` for you *automatically* so that its *one less thing you need to configure*. :rose:
+
 # Planned
 * No breaking changes yet.

docs/tsconfig.md

@@ -13,7 +13,6 @@ i.e. an empty JSON file at the *root* of your project :heart: This will be suffi
 * [`compilerOptions`](https://github.com/TypeStrong/atom-typescript/blob/e2fa67c4715189b71430f766ed9a92d9fb3255f9/lib/main/tsconfig/tsconfig.ts#L8-L35): similar to what you would pass on the commandline to `tsc`.
   * One exception : [We don't support `--out` because it will hurt you in the long run, and we will warn you if you use it](https://github.com/TypeStrong/atom-typescript/blob/master/docs/out.md).
 * [`filesGlob`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#filesglob): To make it easier for you to just add / remove files in your project we add `filesGlob` which accepts an array of `glob / minimatch / RegExp` patterns (similar to grunt) to specify source files.
-* [`package`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#package): The path to a package.json. We can use this to generate a *.d.ts* file for your project using `name`, `main` and `typescript.definition`.
 * [`formatCodeOptions`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#formatcodeoptions) : Code formatting options
 * [`compileOnSave`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#compileonsave) : Should AtomTS compile on save
 * [`version`](https://github.com/TypeStrong/atom-typescript/blob/master/docs/tsconfig.md#version): The TypeScript version
@@ -50,29 +49,6 @@ Note: `files` is kept up to date by expansion of `filesGlob`.
 }
 ```
 
-### package
-
-```json
-{
-    "package": "./package.json"
-}
-```
-
-Where a sample package.json looks like:
-```json
-{
-    "name": "awesome",
-    "main": "./dist/foo.js",
-    "typescript": {
-        "definition": "./definition/awesome.d.ts"
-    }
-}
-```
-
-We would generate a `definition/awesome.d.ts` file for you so that other TypeScript projects can do a simple `require('awesome')`.
-
-Also note that any node modules that ship with `typescript.definition` that you import will automatically get type inference / completion.
-
 ### formatCodeOptions
 These are used when you request the IDE to format TypeScript code.
 

lib/main/tsconfig/tsconfig.ts

@@ -76,7 +76,6 @@ interface TypeScriptProjectRawSpecification {
     filesGlob?: string[];                               // optional: An array of 'glob / minimatch / RegExp' patterns to specify source files
     formatCodeOptions?: formatting.FormatCodeOptions;   // optional: formatting options
     compileOnSave?: boolean;                            // optional: compile on save. Ignored to build tools. Used by IDEs
-    package?: string;                                   // optional: Path to your package.json. If you specify this we can do some cool stuff like generate a .d.ts for you.
 }
 
 interface UsefulFromPackageJson {
@@ -345,17 +344,22 @@ export function getProjectSync(pathOrSrcFile: string): TypeScriptProjectFileDeta
     // Remove all relativeness
     projectSpec.files = projectSpec.files.map((file) => path.resolve(projectFileDirectory, file));
 
-    var packagePath = projectSpec.package;
     var package: UsefulFromPackageJson = null;
-    if (packagePath) {
-        let packageJSONPath = getPotentiallyRelativeFile(projectFileDirectory, packagePath);
-        let parsedPackage = JSON.parse(fs.readFileSync(packageJSONPath).toString());
-        package = {
-            main: parsedPackage.main,
-            name: parsedPackage.name,
-            directory: path.dirname(packageJSONPath),
-            definition: parsedPackage.typescript && parsedPackage.typescript.definition
-        };
+    try {
+        var packagePath = travelUpTheDirectoryTreeTillYouFind(projectFileDirectory, 'package.json');
+        if (packagePath) {
+            let packageJSONPath = getPotentiallyRelativeFile(projectFileDirectory, packagePath);
+            let parsedPackage = JSON.parse(fs.readFileSync(packageJSONPath).toString());
+            package = {
+                main: parsedPackage.main,
+                name: parsedPackage.name,
+                directory: path.dirname(packageJSONPath),
+                definition: parsedPackage.typescript && parsedPackage.typescript.definition
+            };
+        }
+    }
+    catch (ex) {
+        // Don't care :)
     }
 
     var project: TypeScriptProjectSpecification = {
@@ -604,7 +608,9 @@ export function removeTrailingSlash(filePath: string) {
     return filePath;
 }
 
-/** returns the path if found or throws an error "not found" if not found */
+/**
+  * returns the path if found
+  * @throws an error "not found" if not found */
 export function travelUpTheDirectoryTreeTillYouFind(dir: string, fileOrDirectory: string,
     /** This is useful if we don't want to file `node_modules from inside node_modules` */
     abortIfInside = false): string {