This release is necessary for future support for Dart 3.0. Please do update to this version, before upgrading to sidekick_core: ^2.0.0 with Dart 3.0 support.

Fix <cli> sidekick update and only suggest compatible Dart SDK / sidekick_core combinations #229 https://github.com/phntmxyz/sidekick/commit/bd1121cc99f72173d474dfebd95ffb877c402121
Move to branch main-1.X for 1.X.X releases #230 https://github.com/phntmxyz/sidekick/commit/c03f9fcb1f116e297e1f1849dc63f4e8b9c8ad86

1.2.0 (2023-5-11) #

Add topics to pubspec.yaml
Add CreateCommand (register and generate a command) #226 https://github.com/phntmxyz/sidekick/commit/74771b8508e24804826bad4e40a7a80531ded8e3
Add migration to install FormatCommand on update #225 https://github.com/phntmxyz/sidekick/commit/a8bd02510f1a9acbaca9e868a2e43cb0ffdf5cb1
Fix FormatCommand --verify exception message, print unformatted files #224 https://github.com/phntmxyz/sidekick/commit/b30030c11731f8b39e31884fb57a8c1d751384c0
FormatCommand.formatGenerated allows ignoring generated files (.g.dart) #223 https://github.com/phntmxyz/sidekick/commit/46b4a64cafafa83cfa62623fb1c986691e18b202

1.1.0 (2023-2-3) #

New: FormatCommand (<cli> format) to format all your project dart code #192
Fix: plugin install with Dart 2.19 (default pub hosted url changed) #221
install script does major dependency update #220

1.0.2 (2023-1-25) #

Update templates to sidekick_core: ^1.0.0 and sidekick_plugin_installer: ^0.3.0 #214
Don't show a warning when flutterSdkPath or dartSdkPath is an absolute path. #214

1.0.1 (2023-1-25) #

Support for sidekick_plugin_installer:3.0.0 #213

1.0.0 (2023-1-25) #

Breaking API & Behaviour Changes #

Sidekick CLIs now works without a git repository. The projectRoot is defined where the shell entryPoint is located.
New SidekickContext with getters for sidekickPackage, cliName, projectRoot, entryPoint and repository #178
Deprecation of Repository and top-level repository #178
Behaviour: paths for initializeSidekick() are now relative to projectRoot, not repository. Sidekick will print warnings when you're using wrong paths #178
Removal of git(). It was unused. Since sidekick doesn't require git anymore it was removed. #208
Behaviour: flutter and dart throw by default when failing. Use nothrow: true to ignore errors (exitCode != 0) #206
Behaviour: flutter and dart default to Directory.current, not entryWorkingDirectory #206
Removal of flutterw(). flutter and dart do not fall back to flutterw(). It is now available as plugin https://github.com/passsy/flutterw_sidekick_plugin #208
Deprecate top-level cliName/cliNameOrNull in favor of SidekickContext.cliName #208
Deprecate name of initializeSidekick(). The name is now inferred from the pubspec.yaml from the package name (<name>_sidekick). #209
Deprecate findRepository() in favor of SidekickContext.repository or SidekickContext.projectRoot #178
Removal of deinitializeSidekick() #208

Other Changes #

New List<DartPackage> findAllPackages(Directory) function to find packages in directories such as SidekickContext.projectRoot or SidekickContext.repository #178
Require latest dartx version 1.1.0 #208
Update template to use Dart 2.18.6 #195
Show the exact version of the plugin during install #203
Print pub get errors when installing plugin #203
Fix misleading update message #210

0.15.1 (2023-1-18) #

bugfix: sidekick update - Ignore insignificant pub get errors #190

0.15.0 (2023-1-18) #

Changes to your sidekick CLI #

<cli> <command> Sidekick CLIs now automatically check for updates after executing a command. Disable with export SIDEKICK_ENABLE_UPDATE_CHECK=false #177 #171
<cli> sidekick update now updates to the latest stable Dart SDK #167
Automatic pub upgrade when CLI compilation fails (due to Dart SDK upgrade) #166

New APIs #

New: BashCommand to simplify converting bash scripts to commands in dart #168

BashCommand(
  name: 'codegen',
  description: 'Runs build runner',
  workingDirectory: runner.mainProject?.root,
  script: () => '''
${systemFlutterSdkPath()}/bin/flutter pub run build_runner build --delete-conflicting-outputs
''',
),

Bugfixes and improvements #

DepsCommand now ignores sidekick packages, which pull deps automatically with embedded Dart SDK #184
Fix: DepsCommand.excludeGlob now starts matching at repo root, not CWD #183
sidekick update now handles path and git dependencies when updating sidekick_core #180
DartPackage.fromDirectory() Simplify detection of Flutter packages #182

0.14.0 (2023-1-6) #

Template Changes #

CLI template now does not generate a <cli>_project.dart file. You can continue to use yours but we found most people didn't need it. (#156)
UsageException is now correctly printed (#157) (with <cli> sidekick update migration)
Calling the CLI with zero arguments now also checks for sidekick updates (#157) (with <cli> sidekick update migration)
Fix unnecessary CLI recompilation in run.sh (#152)

API Changes #

New DartPackage.lockfile getter (#159)
New DartPackage.fromArgResults constructor for Commands that take a package as only argument. Parses rest and cwd. (#160)
SidekickTemplateProperties now has optional properties. Caller has to decide what to inject for each template. (#161)

0.13.1 #

Fix sidekick plugins install for git and local sources #144

0.13.0 #

New sidekick update command for updating your sidekick CLI (#111)
Add excludeGlob parameter to DepsCommand (#125)
Add --version flag to sidekick command
Support FLUTTER_ROOT environment variable for local Flutter SDK (#123)
Update templates (#132, #126)
Installing sidekick plugins from git is now possible (#126)
Experimental: Automatic sidekick update check when setting SIDEKICK_ENABLE_UPDATE_CHECK environment variable to true

0.12.0 #

New: version getter mirroring the sidekick_core version in pubspec.yaml
Analyzer now ignores the build folder. Previously, the embedded dart sdk was accidentally analyzed #107
Reduce stdout noise when installing a plugin from pub (sidekick plugin install) #109
Reduce stdout when compiling the cli (not showing dart pub get stdout) #109
Allow cli names to include underscores (sidekick init) #112
DepsCommand now accounts for the exclude parameter, not loading dependencies for those packages #118

0.11.1 #

New: <FileSystemEntity>.makeExecutable() extension method
Update repository URL in pubspec.yaml
Move cli template into sidekick_core

0.11.0 #

New: addFlutterSdkInitilizer method to allow plugins downloading the Flutter SDK before flutter is called #99
Widen dcli version range

0.10.1 #

Fix install-global command which crashed in some cases (#94)

0.10.0 #

Template shared-command and shared-code now use the library keyword #87
findAllPackages works now outside of the SidekickCommandRunner
New OutOfCommandRunnerScopeException when accessing cliName and friends outside of a Command #88
Allow execution of PluginCommand from our sidekick cli using the system dart sdk #91
New SidekickCommand that bundles now plugins, recompile and install-global #89

0.9.0 #

Fix: Setting flutterSdkPath and dartSdkPath in initializeSidekick now works with relative paths from anywhere as well.
Relative paths are resolved relative to the project root.
New: The plugins create command now also generates a README.md, .gitignore, and analysis_options.yaml
New: DepsCommand (previously was in sidekick)
New: RecompileCommand (previously was in sidekick)
New: Functions returning system Dart/Flutter SDKs (systemDartSdk, systemDartSdkPath, systemFlutterSdk, systemFlutterSdkPath)

0.8.0 #

DartCommand and FlutterCommand now require the SDKs to be set in initializeSidekick(flutterSdkPath: ..., dartSdkPath: ...).). This is a non-breaking change, falling back to flutter_wrapper`.
Breaking: Plugins now use a zero argument main function. All information during install is injected via env, accessible with PluginContext #72
New: DartPackage doesn't require a lib directory anymore #63
Add: SidekickPackage.cliMainFile location where plugins are registered

0.7.1 #

New: plugins create now generates plugins from templates
Fix: plugins install now uses a temp working directory instead of manipulating the pub cache during install
New: isValidPubPackageName(String name) returns true when the name is a valid pub package name according to https://dart.dev/tools/pub/pubspec#name

0.7.0 #

New: PluginsCommand to automatically install plugins to easily extend sidekick CLIs
New: SidekickDartRuntime sidekickDartRuntime that points to the dart sdk bundled with the CLI
New: Repository.sidekickPackage which returns Repository.cliPackageDir as SidekickPackage object.

0.6.0 #

Breaking initializeSidekick() now returns a SidekickCommandRunner instance (was void). You have to use this runner to access the global sidekick variables cliName, mainProject,repository
Regenerate your cli with sidekick: 0.6.0 to migrate

0.5.2 #

constrain dcli, new versions are not compatible with Dart 2.15 and below

0.5.1 #

Print script + stderr when execution of an inline script (writeAndRunShellScript(script)) fails

0.5.0 #

Breaking This update requires the sidekick project to be initialized again with sidekick: 0.4.0

New InstallGlobalCommand (links binaries in $HOME/.sidekick/bin)
Simplified repository detection (breaking)
error now support errorCode

0.4.1 #

Require Dart 2.14

0.4.0 #

flutterw() is now windows compatible
dart() is now windows compatible
DartPackage detection prints a warning for packages without a lib/ dir

0.3.3 #

Update dcli to 1.15.0 due to breaking change

0.3.2 #

Update dcli
Widen dartx version range

0.3.1 #

AnalyzeCommand now fails with correct exit code

0.3.0 #

Include ForwardCommand and add flutterw, dart and analyze subcommands

0.2.0 #

Add initializeSidekick()
Add repository, cliName and mainProject
Add util files

sidekick_core 2.1.2 sidekick_core: ^2.1.2 copied to clipboard

Metadata

Changelog #

2.1.2 (2024-4-5) #

2.1.1 (2024-4-5) #

2.1.0 (2023-9-26) #

2.0.6 (2023-8-22) #

2.0.5 (2023-7-6) #

2.0.4 (2023-7-2) #

2.0.3 (2023-6-30) #

2.0.2 (2023-6-5) #

2.0.1 (2023-6-5) #

2.0.0 (2023-6-5) #

2.0.0-preview.2 (2023-5-30) #

2.0.0-preview.1 (2023-5-30) #

1.3.0 (2023-5-24) #