Skip to content

Commit

Permalink
released 0.21.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bsutton committed Aug 25, 2020
1 parent 8ae4869 commit 7c5a17f
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 18 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ lcov.info
dcli.code-workspace
.release.notes.tmp.swp
release.notes.tmp
github_credentials.yaml
21 changes: 13 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@


# 0.21.0

Breaking changes:
Refactored methods names related to paths. They now all start with a pathTo prefix.
The aim is to make it easier to find the methods and for ide auto-completion to be more useful.

All methods that refer to the PATH environment variable now use the capitalised word PATH in the method name.


# 0.20.2
Added support for fetching a list of executables.
Pubspec - Added support for fetching a list of executables.

# 0.20.0
Renamed dcli to dcli to better reflect its functionality and improve its discoverability on the pub.dev store.
Renamed dshell to dcli to better reflect its functionality and improve its discoverability on the pub.dev store.

Also took the opportunity to change the version no. to 0.x to reflect the fact that the api is still in flux.



# 0.11.1
Merge branch 'master' of https://github.com/bsutton/dcli into master
dart_install.exe for windows
dart_install for linux

# 1.11.1
Changed how we determine the packages path as a work around for #95
reduce logging for start method.
Expand Down
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1011,31 +1011,43 @@ See the section on [Customising Depenendency Injection](#customising-dependancy-
# Pubspec Management
The `pubspec.yaml` file is Dart's equivalent of a `makefile`, `pom.xml`, `build.gradle` or `package.json`.
You can see additional details on Dart's pubspec here:
https://dart.dev/tools/pub/pubspec
DCli aims to make creating a script as simple as possible and with that in mind we provide a number of ways of creating and managing your pubspec.yaml.
By default you do NOT need a pubspec.yaml when using DCli.
By default you do NOT need a pubspec.yaml when using DCli but its generally easier if you do create one as your dev tools (vscode android studio) expect to find one.
NOTE: if you change the structure of your DCli script you need to run a `dcli clean`. Simple edits to you DCli script do NOT require a `clean` to be run.
## Supported pubspec locations
DCli allows you to place your pubspec in the following locations:
* Standard pubspec.yaml - you use the standard dart package structure with the pubspec.yaml in the root of your project.
* Local pubspec - you place a pubspec.yaml file in the same directory as your script.
* No pubspec - we create a virtual pubsec for you.
* @pubspec annotation - the pubspec lives in your script in the form of an annotation.
* Local pubspec - you place a pubspec.yaml file in the same directory as your script.
* Traditional pubspec.yaml - you use the standard dart package structure with the pubspec.yaml in the root of your project.
## How we locate your pubspec
Its important to understand that DCli follows the same rules as dart does for locating a pubspec.yaml, with a few additions.
By following the same rules as dart does DCli makes it possible for DCli scripts to work seamless with your current development tools.
There are some exceptions.
## No pubsec
If DCli doesn't find a pubspec then it will automatically create a default pubspec for you.
The default pubspec is stored in the script's Virtual Project cache (under `~/.dcli/cache/<path_to_script>.project`).
If DCli doesn't find a pubspec then it will automatically create a default pubspec.yaml for you.
The default pubspec.yaml is stored in the script's Virtual Project cache (under `~/.dcli/cache/<path_to_script>.project`).
We refer to this as a 'virtual pubspec'.
Expand Down
2 changes: 1 addition & 1 deletion lib/src/version/version.g.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/// GENERATED BY pub_release do not modify.
/// dcli version
String packageVersion = '0.20.5';
String packageVersion = '0.21.0';
6 changes: 3 additions & 3 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: dcli
version: 0.20.2
version: 0.21.0
homepage: https://github.com/bsutton/dcli
description: An API and dev environment for writing console (cli) apps/scripts using dart. e.g. allows you to build bash style scripts with dart.
environment:
Expand All @@ -25,13 +25,13 @@ dependencies:
uuid: ^2.0.4
validators: ^2.0.0+1
yaml: ^2.2.0
pubspec:
git: https://github.com/bsutton/pubspec.git
pubspec: ^0.1.4
dev_dependencies:
test: ^1.6.0
effective_dart: ^1.0.0
mockito: ^4.0.0
test_coverage: ^0.4.2
settings_yaml: ^2.1.0
executables:
dcli: dcli
dcli_complete: dcli_complete
Expand Down

0 comments on commit 7c5a17f

Please sign in to comment.