dcli

• performance improvements for unit tests.
• restricted the privileged requirements on install to windows.
• Merge branch 'master' of https://github.com/bsutton/dcli
• GitBook: [master] 67 pages modified
• Fixed the named lock trash test so it shuts down cleanly.

Added

• Added working directory option to DartScript.compile.
• Added method to instantiate a DartProject from .pub-cache.

Fixed

• a bug were we throw if the template folder doesn't exist. We now print a message asking the user to install dcli.

Removed the call to globally activate dcli. We are not currently supporting the standalone dcli_install exe and there appears to be a bug in dart that stops us form do a global activate whilst running under sudo. https://github.com/dart-lang/sdk/issues/46255

Change the arguments to DartScript.run so that 'args' is an optional name paramter. I don't think this is in regular usage as yet so shouldn't cause too many issues and it will result in a compile error which is easy to fix.

Deprecated DartProject.current in favour of DartProject.self and DartScript.current in favour of DartScript.self. Current was ambigous; for a project was it the current running project or the one in the current directory. Change DartScript to self for consistency.

Fixed a bug caused by the dart_console. If you try to get the screen dimensions when no terminal is attached it causes the app to hang.

Changed the rootPath so it returns 'C:' on windows.

This release largely focuses on fixes for Windows.

Changes:

• update dart version to 2.13 so we can use the latest win32.
• dcli install now updates the PATH registry settings and notifies all top level windows.

Added:

• A set of registry functions to set/get registry keys.
• Added method loggedInUsersHome for WindowsMixin
• Added new methods to Terminal()
• writeline with text alignment.
• cursorUp/Down/Left/Right
• get/set current column/row cursor position.
• support for running .dart scripts from the command and power shell prompts. You can now rung hello.dart rather than dart hello.dart
• Created new function withOpenFile that opens a file for the duration of a callback.
• Created new function fileLength that returns the length of a file.

Deprecated:

• Deprecated methods in Terminal
  • previousUp in favor of cursorUp
  • lines in favour of rows.

Fixes:

• numerous issues with ansi/terminal under windows. Now use the dart_console package to handle the windows setup.
• Stopped the terminal trying to get the cursor position when we don't have a terminal as this just caused the app to hang.
• a bug in Ansi.isSupported which was testing stdin for ansi support when we should have tested stdout. Ansi colors now work on windows.
• the uri construction for accessing assets so it works under windows.
• a bug in sleep function. Was using microseconds when milliseconds was passed.
• detection of pub_cache location. Should now work on all versions of windows.
• the root prefix when privatising paths on windows.
• bug where dcli doctor wasn't finding the dcli path as we were searching for the wrong name.
• the cmd shell was incorrectly reporting that it had privileges.
• Attempt to fix the problem with DartScript.scriptName when running globally activated. We have been getting a dart version no. in the scriptName which I'm now stripping out. Hopefully this is the correct action.
• fixed path building so that createTempDir now works correctly on windows.

Added new methods

• withFileProtection. Allows you to back a collection of files/directories run an action and then restore any changes to those files/directories. Handy when implementing dry run type features.
• restorePrivileges. Implemented to complement restorePrivileges
• calculateHash. Generates an sha256 checksum on a file.

Changes

• all internall calls to Settings().verbose have been changed to verbose to reduce logging overheads.
• Upgraded to dart 2.13 - google tells me that this still allows older packages to work with dcli.
• Added keep arguments to withTempFile and withTempDir to preseve the temp directories. Handy for examining problems with unit tests.
• Changed truepath to call normalize rather than canonicalize as canonicalize changes the case of paths on Windows. I believe this should be non-breaking.
• Added support for windows \ path separator in the find function.

Fixes:

• Fixed a bug where find failed if an absolute path was prepended to the pattern. Now works for no path, a relative path and an absolute path prefixed to the pattern.
• Improvements to the DartProject and DartScript path detection when running unit tests under windows.

Known Problems:

Note we have found a problem using forEach with the start function.

start('ls *.txt').forEach( print);

Currently this works and look like it is going to have to be part of the process re-org we are working through. In the mean time you can use:

for (final line in start('ls *.txt', progress: Progress.capture().lines) {print(line);}

Added new methods:

• withTempDir - Allows you to run a callback with access to a temporary directory which is automatically cleaned up when the callback completes.
• withTempFile - Allows you to run a callback with access to a temporary file which is automatically cleaned up when the callback completes.
• createTempFilename

Changes:

• Deprecated FileSync.tempFile in favour of createTempFilename
• updated unit tests to reduce reliance of TestFileSystem to speed up the unit tests.
• depcrecated FileSync.tempFile in favour of creaeTempFilename updated to use teh new createTempFilename
• Added ignoreMissing arg to backupFile. Now throws a BackupFileException if the backup file is missing and ignoreMissing is not set.

Fixes:

• Fixed the Ansi.strip command as the unit tests were falely reporting that they worked.

Experimental:

• Added method to ProcessHelper to obtain a complete list of running processes. Not currently supported on osx.

Reverted method names on DartScript from pathToDartScript to pathToScript and similar to reduce api breakage.

• Fixed accidentail breakage. renamed some methods to use 'library' rather than 'script'.
• Changed Ansi.strip to a static method to match convention used for other Ansi methods.
• Added overwriteLine to Terminal class. Added Ansi().strip method to stripout ansi escape sequences from a string.
• Changed run to print stdout and stderr to the console rather than devNull so it was consistent with other functions.
• Added run method to make it easy to run the dart exe. Change runPub to print stderr and stdout to the console rather than supress it.
• Changed startFromArgs to print stderr and stdout by default so it is consistent with outer functions.
• formatting.

Breaking Change:

• Renamed Script to DartScript to make way for integration with cli_script.

• As Script was labelled as an internal class this hopefully shouldn't be too disruptive.

• DartScript is now part of the public api.

• Code changes should simply required changing Script to DartScript as the api is identical.

• Progress ctor now setting _includedStd(out, err) based on whether devNull is passed as the relevant LineAction. Previously _includeStderr wasn't being enabled if a LineAction was passed.

• Improvements to processing of 'detached' processes.

• Added sudo tag to tests so these can be run separately.

• Fixed a bug where nothrow was not being passed down pubRun.

• Improved doco on detached argument to start.

• Changed the installer (yet again) to require privileges to be run. We now releasePrivileges to and withPrivileges to provide more precise control over what we execute with privileges.

Fixed a bug in the menu function when the passed 'limit' argument is greater than the no. of options.

Breaking Change: Change the 'search' argument on DartProject.fromPath to default to true rather than false.
On looking at the documentation and the common usages the search logic is assumed to be on. This should only affect a small no. of people as you would only want search off if you are creating a dart project from scratch.

New:

• simple backup and restore methods backupFile and restoreFile.
• getters in DartProject for the common paths in a dart project folder.
• Added columns and lines methods to Terminal
• Unit tests for copy function.

Changes:

• Improved the exception messages for the copy function when things go bad as the OS errors are ambiguous.
• Documentation improvements.

Fixed a bug in the createTempDir method and added unit test for same.

Exposed method createTempDir.

BUG: runPubGet was not passing down the Progress so you couldn't dump the output if so desired.

Updated readme.

Deprecated ProgressWithCapture and moved the capture logic into the base Progress class. Use Progress.capture() instead.

• Modified startFromArgs to NOT print any output by default.
• This is to bring it in line with start.
• If you currently use startFromArgs and want to continue with the original behaviour you will need to change how you call startFromArgs

startFromArgs('ls', ['-la']);

becomes

startFromArgs('ls', ['-la'], progress: Progress.print);

This change is in response to issue #134

• Switched to using critical_test package for running unit tests.
• Added method runPub to DartSdk.
• Improved the code doco for find
• Added unit tests for progress methods toList and forEach

Update README.md

Enhancements:

• Added method isPrivilegedPasswordRequired to test if the sudo password is currently cached.
• For the installer added logic to suppress the sudo requirement if the link path is already writable or we are already privileged. If we are going to prompt - for the password we now warn the user.

Fixed a bug in the shell detection logic.

Replace now takes a Pattern so you can do a Regx replacement as well as a simple string replacement.

No major changes. The api is now stable enough for us to consider this a 1.0 release :) upgraded to release versions os csv, equatable and ini package.

Fixed a bug ith the install when 'pub' command is not on the path. Now correctly uses dart pub.

• Added createTempDir.
• Added a regex validator.

• Added class ProgessWithCapture thanks to @passsy for the contribution and suggestions.
• You can now use the start function and capture the output with a simple progress.
• Allowed the priviliged flag to work on osx as well as linux for the start function.
• Improvements to documenation.
• Fixed the import path for dcli on the templates which I broke when fixing lints.

Added work around for "Invalid Argument' when using the find command over a steam directory tree. We just log the path and keep on trucking.

Added code to return the exit code even when running a process in a terminal. This is to resolve #100. However I'm not certain if the exit code will be meaningful as it might just be the terminals exit code.

• Added new createTempDir thanks to @Reductions

• Moved to only support 2.12 and not the beta.

• tweaked the template expander to remove any lint warnings. Updated the expander so that it updates the dcli and package versions.

• Remove the lock logic around creating as testfile system as its no longer needed and greatly slows down testing.

• Change default shell detection expected as mostly we run it from the cli.

• Added logic so that the template builder updates the dcli and dependency versions to match the current versions used by dcli.

• Migrated to full set of lint rules in lint package. First pass revert to 80chars.

• moved back to using pubspec now that nnbd version has been released.

• moved to official validators library.

Hack to get around getIsolateID nndb bug.

• Updated to latest readme content from gitbooks
• Improved the Env documentation.

Updated template pubspec.yaml to have the correct args package. Updated the installer so that it replaces the templates when a new version of dcli is installed.

removed hard coded verbose:true statement

Fixed the toList String extensions so that it never returns nulls.

Extended version ranges for ini.

re-added ini support. Upgraded to latest packages.

re-added args as a transitive dependency. I'm still uncertain if this is a good idea.

First full nnbd release.

• Removed support for 32bit installs until system_info releases a nnbd version.
• Changed to pubspec2 until pubspec is released with nnpd.
• changed createScript to expect a script name not a full path.
• Fixed the exception handling for dcli exceptions that I screwed up.
• Moved to using posix to get parent pid. Impoved exception handling.
• Used late final to do delayed initialisation. Added exceptions when pub get or dart not installed.
• updated doco
• removed ini support as the upstream package doesn't appear to be maintained.
• Finalised nnbd migration by bringing the validators class into the project.
• Fixed bug in version if dart not installed.

• First pass at nullsaftey.
• removed suffix as no longer supported.

Reverted posix and intl upgrades as they required 2.12.

upgraded intl.

• Added logging for symlink related funcitons.
• Improvements to documentation.

Added verbose output when setting environment vars.

Exposed isXXX members that were being hidden for no good reason.

• Improved the move error message when the target directory doesn't exist.
• grammar improvements in script.dart's doco.

Removed code in env which tried to update the platform.environment settings which of course is impossible.

• Added documentation for compile method.
• Added version to help message.

Release due to bug in pub_release that was not updating the 'latest' tag

Fixed bug in getlogin (Shell.loggedInUser) when running in docker. Now corretly returns 'root' as before it was seg faulting in the posix code.

With pub_release fixed so it can upload assets this release is to take advantage of that

Testing of pub_release uploading exes.

• Improved documentation around waitForEx stack traces and added a test for same.
• Added test for wait_for_ex exceptions.
• Added cause to dcliexception.

• BREAKING CHANGE: renamed the find argument 'root' to ' workingDirectory'. As I'm using the api I've found that I naturally go to use workingDirectory as its used everywhere else. So this feels more consistent.
• Implemented chown using the posix api via ffi.
• Added protection for a number of anomalies that can occur when scanning a full file system.

• Added release hook to activate published version of dcli.
• sorted dependencies.
• Fixed the isReadyToRun method as it was looking for .dart_code rather than .dart_tool

• exposed the PosixShell.
• Added tests for loggedInUsersHome.

• reverted to returning null for a non-existing key as the changes were too destructive and end up with rather ugly code.
• Added logging of the pub-cache path.

Minor changes to progress messages.

Introduced isPrivilegedProcess so we can always tell if we started with privilegese. Changed isPrivilegedUser back to its original semantics in that it reflects the current effective user id. Fixed withPrivileges so it uses isPriviliegedProcess to correctly determine if privileges exist. Fix the 'start' function so that it interats correctly with wiithPrivileges and releasePrivileges.

• BREAKING CHANGE: Accessing an environment key which doesn't exists now throws EnvironmentKeyNotFound rather than returning a null. This is in prepare for nnbd.
• Updated doco for Env.
• Changed from using whoami to to using getuid for posix systems.