macosui_tool_starter

A mason brick to create a starter Flutter tool for macOS that uses macos_ui.

What's Included ✨

Out of the box, this brick creates a Flutter application that:

• ✅ Targets macOS (support for other platforms can be added manually)
• ✅ Builds an UI based on the latest version of macos_ui
• ✅ Prepares a preferences_repository using SharedPreferences
• ✅ Prepares an AppNotifier providing an minimal AppState using SharedPreferences
• ✅ Provides a ToolBarPullDownButton in the ToolBar with two menu items
  • Choose Folder which opens a FilePicker
  • Scan Directorywhich calls a method on AppNotifier
• ✅ Reads the current version from the pubspec.yaml and provides it in the AppState
• ✅ Has these packages pre-installed
  • macos_ui
  • flutter_hooks
  • hooks_riverpod
  • shared_preferences
  • file_picker
  • pubspec_parse

Output 📦

├── README.md
├── analysis_options.yaml
├── lib
│   ├── main.dart
│   ├── pages
│   │   ├── home_page.dart
│   │   ├── main_view.dart
│   │   └── settings_page.dart
│   └── providers
│       ├── app_notifier.dart
│       ├── preferences_repository.dart
│       ├── providers.dart
│       └── settings_notifier.dart
├── macos
├── pubspec.lock
├── pubspec.yaml
└── test
    └── widget_test.dart

Don't forget to extend the entitlements on macOS

Often the tools require access to the file system or provide an HTTP server. So in such a case, update the plist dictionary in the files DebugProfile.entitlements and Release.entitlements in the macos/Runner directory. For example:

<dict>
	<key>com.apple.security.app-sandbox</key>
	<false/>
	<key>com.apple.security.cs.allow-jit</key>
	<true/>
	<key>com.apple.security.files.downloads.read-write</key>
	<true/>
	<key>com.apple.security.files.user-selected.read-write</key>
	<true/>
	<key>com.apple.security.network.server</key>
	<true/>
</dict>

Credits

If you don't need or want Riverpod, preferences and file_picker, you can also use the brick macosui_starter, which was the starting point for this brick. It has less packages but allows multiple windows and has several options to configure the window style.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add macosui_tool_starter

# Install globally
mason add -g macosui_tool_starter

Usage 🚀

mason make macosui_tool_starter

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev <0.1.0"

0.2.1

• Add section "Don't forget to extend the entitlements on macOS" to the readme

0.2.0

• Update to macos_ui 1.10.0

0.0.2

• use raw.githubusercontent.com for screenshot

0.0.1

• Initial release 🎉
  • Generate a new Flutter application that uses macos_ui
  • Adds several useful packages like file_picker, shared_preferences and fhooks_riverpod

MIT License

Copyright (c) [2023] [Alfred Schilken]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.