Run dartfmt when invoking git cl format.

git_cl.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 # Copyright (C) 2008 Evan Martin <martine@danga.com>
 
 """A git-command for integrating reviews on Rietveld."""
 
 from distutils.version import LooseVersion
@@ skipping 18 matching lines @@
 try:
   import readline  # pylint: disable=F0401,W0611
 except ImportError:
   pass
 
 
 from third_party import colorama
 from third_party import upload
 import breakpad  # pylint: disable=W0611
 import clang_format
+import dart_format
 import fix_encoding
 import gclient_utils
 import git_common
 import owners
 import owners_finder
 import presubmit_support
 import rietveld
 import scm
 import subcommand
 import subprocess2
@@ skipping 2837 matching lines @@
     base_branch = cl.GetCommonAncestorWithUpstream()
 
   change = cl.GetChange(base_branch, None)
   return owners_finder.OwnersFinder(
       [f.LocalPath() for f in
           cl.GetChange(base_branch, None).AffectedFiles()],
       change.RepositoryRoot(), author,
       fopen=file, os_path=os.path, glob=glob.glob,
       disable_color=options.no_color).run()
 
+def BuildGitDiffCmd(diff_type, upstream_commit, args, extensions):
+  """Generates a diff command."""
+  # Generate diff for the current branch's changes.
+  diff_cmd = ['diff', '--no-ext-diff', '--no-prefix', diff_type,
+              upstream_commit, '--' ]
+
+  if args:
+    for arg in args:
+      if os.path.isdir(arg):
+        diff_cmd += [os.path.join(arg, '*' + ext) for ext in extensions]
+      elif os.path.isfile(arg):
+        diff_cmd.append(arg)
+      else:
+        DieWithError('Argument "%s" is not a file or a directory' % arg)
+  else:
+    diff_cmd += ['*' + ext for ext in extensions]
+
+  return diff_cmd
 
 @subcommand.usage('[files or directories to diff]')
 def CMDformat(parser, args):
   """Runs clang-format on the diff."""
   CLANG_EXTS = ['.cc', '.cpp', '.h', '.mm', '.proto', '.java']
   parser.add_option('--full', action='store_true',
                     help='Reformat the full content of all touched files')
   parser.add_option('--dry-run', action='store_true',
                     help='Don\'t modify any file on disk.')
   parser.add_option('--diff', action='store_true',
                     help='Print diff to stdout rather than modifying files.')
   opts, args = parser.parse_args(args)
 
   # git diff generates paths against the root of the repository.  Change
   # to that directory so clang-format can find files even within subdirs.
   rel_base_path = settings.GetRelativeRoot()
   if rel_base_path:
     os.chdir(rel_base_path)
 
-  # Generate diff for the current branch's changes.
-  diff_cmd = ['diff', '--no-ext-diff', '--no-prefix']
-  if opts.full:
-    # Only list the names of modified files.
-    diff_cmd.append('--name-only')
-  else:
-    # Only generate context-less patches.
-    diff_cmd.append('-U0')
-
   # Grab the merge-base commit, i.e. the upstream commit of the current
   # branch when it was created or the last time it was rebased. This is
   # to cover the case where the user may have called "git fetch origin",
   # moving the origin branch to a newer commit, but hasn't rebased yet.
   upstream_commit = None
   cl = Changelist()
   upstream_branch = cl.GetUpstreamBranch()
   if upstream_branch:
     upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
     upstream_commit = upstream_commit.strip()
 
   if not upstream_commit:
     DieWithError('Could not find base commit for this branch. '
                  'Are you in detached state?')
 
-  diff_cmd.append(upstream_commit)
+  if opts.full:
+    # Only list the names of modified files.
+    clang_diff_type = '--name-only'
+  else:
+    # Only generate context-less patches.
+    clang_diff_type = '-U0'
 
-  # Handle source file filtering.
-  diff_cmd.append('--')
-  if args:
-    for arg in args:
-      if os.path.isdir(arg):
-        diff_cmd += [os.path.join(arg, '*' + ext) for ext in CLANG_EXTS]
-      elif os.path.isfile(arg):
-        diff_cmd.append(arg)
-      else:
-        DieWithError('Argument "%s" is not a file or a directory' % arg)
-  else:
-    diff_cmd += ['*' + ext for ext in CLANG_EXTS]
+  diff_cmd = BuildGitDiffCmd(clang_diff_type, upstream_commit, args, CLANG_EXTS)
   diff_output = RunGit(diff_cmd)
 
   top_dir = os.path.normpath(
       RunGit(["rev-parse", "--show-toplevel"]).rstrip('\n'))
 
   # Locate the clang-format binary in the checkout
   try:
     clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
   except clang_format.NotFoundError, e:
     DieWithError(e)
 
   if opts.full:
     # diff_output is a list of files to send to clang-format.
     files = diff_output.splitlines()
-    if not files:
-      print "Nothing to format."
-      return 0
-    cmd = [clang_format_tool]
-    if not opts.dry_run and not opts.diff:
-      cmd.append('-i')
-    stdout = RunCommand(cmd + files, cwd=top_dir)
-    if opts.diff:
-      sys.stdout.write(stdout)
+    if files:
+      cmd = [clang_format_tool]
+      if not opts.dry_run and not opts.diff:
+        cmd.append('-i')
+      stdout = RunCommand(cmd + files, cwd=top_dir)
+      if opts.diff:
+        sys.stdout.write(stdout)
   else:
     env = os.environ.copy()
     env['PATH'] = str(os.path.dirname(clang_format_tool))
     # diff_output is a patch to send to clang-format-diff.py
     try:
       script = clang_format.FindClangFormatScriptInChromiumTree(
           'clang-format-diff.py')
     except clang_format.NotFoundError, e:
       DieWithError(e)
 
     cmd = [sys.executable, script, '-p0']
     if not opts.dry_run and not opts.diff:
       cmd.append('-i')
 
     stdout = RunCommand(cmd, stdin=diff_output, cwd=top_dir, env=env)
     if opts.diff:
       sys.stdout.write(stdout)
+    # TODO(erg): Deal with this.
     if opts.dry_run and len(stdout) > 0:
       return 2

[Elliot Glaysher, 2015/02/18 20:41:42]

enne: you added the above two lines to return a value to the cmd prompt when a
dry run is done and there's output. What motivated this? Should I do something
analogous in the block below?

[enne (OOO), 2015/02/18 20:56:46]

Yeah, the "return 2" is to indicate to CheckPatchFormatted that "git cl format"
was not a no-op and that there were formatting changes.

See:
https://code.google.com/p/chromium/codesearch#chromium/tools/depot_tools/pres...

[Elliot Glaysher, 2015/02/18 21:16:17]

TYVM. I've modified this so that unformatted dart files cause this function to
return 2, and I've modified the mojo repository's presubmit scripts to run
CheckPatchFormatted, verifying that this works. (That will be landed
separately.)

 
+  # Build a diff command that only operates on dart files. dart's formatter
+  # does not have the nice property of only operating on modified chunks, so
+  # hard code full.
+  dart_diff_cmd = BuildGitDiffCmd('--name-only', upstream_commit,
+                                  args, ['.dart'])
+  dart_diff_output = RunGit(dart_diff_cmd)
+  if dart_diff_output:
+    try:
+      dartfmt = dart_format.FindDartFmtToolInChromiumTree()
+    except dart_format.NotFoundError, e:
+      DieWithError(e)
+
+    command = [dartfmt]
+    if not opts.dry_run and not opts.diff:
+      command.append('-w')
+    files = dart_diff_output.splitlines()
+    command.extend(files)
+
+    stdout = RunCommand(command, cwd=top_dir, env=env)
+    if opts.dry_run:
+      sys.stdout.write(stdout)
+
   return 0
 
 
 def CMDlol(parser, args):
   # This command is intentionally undocumented.
   print zlib.decompress(base64.b64decode(
       'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
       'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
       'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
       'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY'))
@@ skipping 38 matching lines @@
         ('AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
           'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
 
 
 if __name__ == '__main__':
   # These affect sys.stdout so do it outside of main() to simplify mocks in
   # unit testing.
   fix_encoding.fix_encoding()
   colorama.init()
   sys.exit(main(sys.argv[1:]))