Merge pull request #13 from dart-lang/use_platform_resolvedExecutable

introduce a getSdkPath() API

Author: devoncarew

.gitignore

@@ -5,5 +5,7 @@
 .project
 .settings
 build/
+doc/api/
 packages
-pubspec.lock
+pubspec.lock
+.packages

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## unreleased
+
+- Use the new `Platform.resolvedExecutable` API to locate the SDK
+
 ## 0.0.1+3
 
 - Find SDK properly when invoked from inside SDK tests.

CONTRIBUTING.md

@@ -23,7 +23,7 @@ All submissions, including submissions by project members, require review.
 ### File headers
 All files in the project must start with the following header.
 
-    // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
+    // Copyright (c) 2017, the Dart project authors.  Please see the AUTHORS file
     // for details. All rights reserved. Use of this source code is governed by a
     // BSD-style license that can be found in the LICENSE file.
 

README.md

@@ -17,11 +17,11 @@ import 'package:cli_util/cli_util.dart';
 import 'package:path/path.dart' as path;
 
 main(args) {
-  // Get sdk dir from cli_util
-  Directory sdkDir = getSdkDir(args);
+  // Get sdk dir from cli_util.
+  String sdkPath = getSdkPath();
   
   // Do stuff... For example, print version string
-  File versionFile = new File(path.join(sdkDir.path, 'version'));
+  File versionFile = new File(path.join(sdkPath, 'version'));
   print(versionFile.readAsStringSync());
 }
 ```

.analysis_options renamed to analysis_options.yaml

@@ -6,11 +6,16 @@ library cli_util;
 
 import 'dart:io';
 
-import 'package:path/path.dart' as p;
-import 'package:which/which.dart';
-
-/// Return the path to the current Dart SDK. This will return `null` if we are
-/// unable to locate the Dart SDK.
+import 'package:path/path.dart' as path;
+
+/// Return the path to the current Dart SDK.
+///
+/// This first checks for an explicit SDK listed on the command-line
+/// (`--dart-sdk`). It then looks in any `DART_SDK` environment variable. Next,
+/// it looks relative to the Dart VM executable. Last, it uses the
+/// [Platform.resolvedExecutable] API.
+///
+/// Callers should generally prefer using the [getSdkPath] function.
 Directory getSdkDir([List<String> cliArgs]) {
   // Look for --dart-sdk on the command line.
   if (cliArgs != null) {
@@ -40,36 +45,15 @@ Directory getSdkDir([List<String> cliArgs]) {
   // Handle the case where Platform.executable is a sibling of the SDK directory
   // (this happens during internal testing).
   sdkDirectory =
-      new Directory(p.join(platformExecutable.parent.path, 'dart-sdk'));
+      new Directory(path.join(platformExecutable.parent.path, 'dart-sdk'));
   if (_isSdkDir(sdkDirectory)) return sdkDirectory;
 
-  // Try and locate the VM using 'which'.
-  String executable = whichSync('dart', orElse: () => null);
-
-  if (executable != null) {
-    // In case Dart is symlinked (e.g. homebrew on Mac) follow symbolic links.
-    Link link = new Link(executable);
-    if (link.existsSync()) {
-      executable = link.resolveSymbolicLinksSync();
-    }
-
-    Link parentLink = new Link(p.dirname(executable));
-    if (parentLink.existsSync()) {
-      executable = p.join(
-          parentLink.resolveSymbolicLinksSync(), p.basename(executable));
-    }
-
-    File dartVm = new File(executable);
-    Directory dir = dartVm.parent.parent;
-    if (_isSdkDir(dir)) return dir;
-  }
-
-  return null;
+  // Use `Platform.resolvedExecutable`.
+  return new Directory(getSdkPath());
 }
 
-bool _isSdkDir(Directory dir) => _joinFile(dir, ['version']).existsSync();
+/// Return the path to the current Dart SDK.
+String getSdkPath() => path.dirname(path.dirname(Platform.resolvedExecutable));
 
-File _joinFile(Directory dir, List<String> files) {
-  String pathFragment = files.join(Platform.pathSeparator);
-  return new File("${dir.path}${Platform.pathSeparator}${pathFragment}");
-}
+bool _isSdkDir(Directory dir) =>
+    FileSystemEntity.isDirectorySync(path.join(dir.path, 'version'));

lib/cli_util.dart

@@ -1,12 +1,14 @@
 name: cli_util
-version: 0.0.1+3
+version: 0.1.0-dev.1
 author: Dart Team <[email protected]>
 description: A library to help in building Dart command-line apps.
 homepage: https://github.com/dart-lang/cli_util
+
 environment:
-  sdk: '>=1.0.0 <2.0.0'
+  sdk: '>=1.11.0 <2.0.0'
+
 dependencies:
   path: '>=1.0.0 <2.0.0'
-  which: '>=0.1.2 <0.2.0'
+
 dev_dependencies:
-  unittest: '>=0.11.0 <0.12.0'
+  test: ^0.12.0

pubspec.yaml

@@ -3,22 +3,25 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:cli_util/cli_util.dart';
-import 'package:unittest/unittest.dart';
+import 'package:test/test.dart';
+
+main() => defineTests();
 
 void defineTests() {
   group('getSdkDir', () {
     test('arg parsing', () {
       expect(getSdkDir(['--dart-sdk', '/dart/sdk']).path, equals('/dart/sdk'));
       expect(getSdkDir(['--dart-sdk=/dart/sdk']).path, equals('/dart/sdk'));
     });
+
     test('finds the SDK without cli args', () {
       expect(getSdkDir(), isNotNull);
     });
   });
-}
 
-main() {
-  groupSep = ' | ';
-
-  defineTests();
+  group('getSdkPath', () {
+    test('sdkPath', () {
+      expect(getSdkPath(), isNotNull);
+    });
+  });
 }

test/cli_util_test.dart

@@ -23,4 +23,4 @@ if [ "$COVERALLS_TOKEN" ]; then
     --retry 2 \
     --exclude-test-files \
     test/cli_util_test.dart
-fi
+fi