How to check flutter application is running in debug?

Question

I have a short question. I'm looking for a way to execute code in Flutter when the app is in Debug mode. Is that possible in Flutter? I can't seem to find it anywhere in the documentation.

Something like this

If(app.inDebugMode) {
   print("Print only in debug mode");
}

How to check if the flutter application is running in debug or release mode?

Answer 1

---

While this works, using constants kReleaseMode or kDebugMode is preferable. See Rémi's answer below for a full explanation, which should probably be the accepted question.

---

The easiest way is to use assert as it only runs in debug mode.

Here's an example from Flutter's Navigator source code:

assert(() {
  if (navigator == null && !nullOk) {
    throw new FlutterError(
      'Navigator operation requested with a context that does not include a Navigator.\n'
      'The context used to push or pop routes from the Navigator must be that of a '
      'widget that is a descendant of a Navigator widget.'
    );
  }
  return true;
}());

Note in particular the () at the end of the call - assert can only operate on a boolean, so just passing in a function doesn't work.

Answer 2

While asserts technically works, you should not use them.

Instead, use the constant kReleaseMode from package:flutter/foundation.dart

---

The difference is all about tree shaking

Tree shaking (aka the compiler removing unused code) depends on variables being constants.

The issue is, with asserts our isInReleaseMode boolean is not a constant. So when shipping our app, both the dev and release code are included.

On the other hand, kReleaseMode is a constant. Therefore the compiler is correctly able to remove unused code, and we can safely do:

if (kReleaseMode) {

} else {
  // Will be tree-shaked on release builds.
}

Answer 3

Here is a simple solution to this:

import 'package:flutter/foundation.dart';

then you can use kReleaseMode like

if(kReleaseMode){ // is Release Mode ??
    print('release mode');
} else {
    print('debug mode');
}

Answer 4

Update

Please use Remi's answer with kReleaseMode and kDebugMode or Dart compilation won't be able to tree-shake your code

---

this little snippets should do what you need

bool get isInDebugMode {
  bool inDebugMode = false;
  assert(inDebugMode = true);
  return inDebugMode;
}

if not you can configure your IDE to launch a different main.dart in debug mode where you can set a boolean.

Answer 5

kDebugMode

You can now use the kDebugMode constant.

if (kDebugMode) {
  // Code here will only be included in debug mode.
  // As kDebugMode is a constant, the tree shaker
  // will remove the code entirely from compiled code.
} else {

}

This is preferrable over !kReleaseMode as it also checks for profile mode, i.e. kDebugMode means not in release mode and not in profile mode.

kReleaseMode

If you just want to check for release mode and not for profile mode, you can use kReleaseMode instead:

if (kReleaseMode) {
  // Code here will only be run in release mode.
  // As kReleaseMode is a constant, the tree shaker
  // will remove the code entirely from other builds.
} else {

}

kProfileMode

If you just want to check for profile mode and not for release mode, you can use kProfileMode instead:

if (kProfileMode) {
  // Code here will only be run in release mode.
  // As kProfileMode is a constant, the tree shaker
  // will remove the code entirely from other builds.
} else {

}

Answer 6

Not to be picky , but the foundation package includes a kDebugMode constant; So :

import 'package:flutter/foundation.dart' as Foundation;

if(Foundation.kDebugMode) {
   print("App in debug mode");
}

Answer 7

I believe the latest way to do this is:

const bool prod = const bool.fromEnvironment('dart.vm.product');

src

Answer 8

These are the two steps to find out in which mode the application runs

1. Add the following imports for getting

   import 'package:flutter/foundation.dart' as Foundation;
   

2. And kReleaseMode check which mode the application is running

   if(Foundation.kReleaseMode){ 
     print('app release mode');
   } else {
     print('App debug mode');
   }
   

Answer 9

Extracted from Dart Documentation:

When exactly do assertions work? That depends on the tools and framework you’re using:

• Flutter enables assertions in debug mode.
• Development-only tools such as dartdevc typically enable assertions by default.
• Some tools, such as dart and dart2js, support assertions through a command-line flag: --enable-asserts.

In production code, assertions are ignored, and the arguments to assert aren’t evaluated.