Emacs tools for working with the Flutter SDK

Flutter.el helps you run the flutter binary interactively as an inferior process. It's designed to work together with dart-mode: for instance the example configuration below binds flutter-run-or-hot-reload to C-M-x in dart-mode. While editing your Dart code, just hit C-M-x to either run your app, or if it's already running, to hot-reload it.

Any non-trivial app will require localization, but if you're like me you probably write your code first and worry about externalizing your strings (moving their definitions to a separate file) later.

Flutter.el comes with some helpful features to make externalizing strings easier, assuming you are following best practices:

• flutter-l10n-externalize-all: A function that interactively does the following for each string literal in the current buffer:

  1. Prompts you to give an ID (class property name) to the string, e.g. myString
  2. Replaces the string literal with a reference to the localizations class, e.g. MyLocalizations.of(context).myString
  3. Deletes any const keywords that apply to the reference
  4. Appends the original string content as an end-of-line comment
  5. Appends a definition for the string to the localizations class, e.g.

  String get myString => Intl.message('Hello, world!', name: 'myString');
  

• flutter-l10n-externalize-at-point: Does all of the above but for the string literal at point only; kills the definition instead of adding it to the localizations class.

A Flycheck checker calling intl_translation:extract_to_arb from the intl_translation package is available for making sure your strings are defined in the correct way. This is published as a separate, optional package: flutter-l10n-flycheck.

Flutter.el helps you run tests of your flutter application. There are 3 commands available:

• flutter-test-all - run all tests from a flutter project.
• flutter-test-current-file - run all tests inside the current file.
• flutter-test-at-point - run single test or group of tests at point.

Easily activate keybindings for these with the flutter-test-mode minor mode.

You can install from MELPA with package.el:

M-x package-install flutter

and, optionally

M-x package-install flutter-l10n-flycheck

Set flutter-sdk-path to the location of your Flutter SDK. This isn't even necessary if the flutter binary is on your PATH.

To use the localization tools you will want to customize these variables for your project:

• flutter-l10n-classname: The name of the localizations class where strings are defined
• flutter-l10n-file: The relative path from project root to the file that defines the localizations class. Should include the leading lib/.

If using flutter-l10n-flycheck be sure to call flutter-l10n-flycheck-setup and set your L10N file (the one specified in flutter-l10n-file) to use the checker: M-x add-file-local-variable-prop-line flycheck-checker intl_translation

Using use-package and assuming you put the Flutter SDK in /Applications/flutter:

;; Assuming usage with dart-mode
(use-package dart-mode
  ;; Optional
  :hook (dart-mode . flutter-test-mode))

(use-package flutter
  :after dart-mode
  :bind (:map dart-mode-map
              ("C-M-x" . #'flutter-run-or-hot-reload))
  :custom
  (flutter-sdk-path "/Applications/flutter/"))

;; Optional
(use-package flutter-l10n-flycheck
  :after flutter
  :config
  (flutter-l10n-flycheck-setup))

A sample .dir-locals.el to go in your project root:

((dart-mode
  (flutter-l10n-classname . "AppLocalizations")
  (flutter-l10n-file . "lib/app_l10n.dart")))

The propline for your L10N file:

// -*- flycheck-checker: intl_translation; -*-

GPL-3