Release Notes: Sprint 34

Peter Flynn edited this page Feb 7, 2014 · 21 revisions
Clone this wiki locally


This release was superseded by Sprint 34.1, which contains two important bug fixes.

What's New in Sprint 34

  • Installation
    • Automatically replace older versions: The Brackets installer on Windows now automatically overwrites previous versions, with no need to manually uninstall them. On all platforms, the app name no longer contains the sprint number. If you have manually assigned Brackets to any file associations, they will no longer need to be reassigned for each new build. (Note: these changes will not be evident until the first update, i.e. next sprint - Sprint 35).
  • Overall UI
  • Image Preview
    • Pixel coordinates guide: When viewing an image file, a crosshair and tooltip indicate the pixel coordinates of your mouse cursor.
  • Code Hints
    • Improved JavaScript code hints accuracy: More code hints provided for APIs in medium-sized files (500-2000 lines) and in cases where a module's exports have recently been updated.
  • Files & Folders
  • Extensions
  • Under the hood
  • Localization
    • New translations added: Persian-Farsi, Dutch and Romanian
    • Updated translations: Brazilian Portuguese, Czech, Finnish, French, German, Japanese, Spanish, Swedish

Full change logs: brackets and brackets-shell

UI Changes

Dark-themed window chrome on Mac - the Mac shell now has a dark window chrome that visually complements the Brackets UI. (The Windows shell received a similar update in Sprint 31).

Installation - see above. Starting next sprint, newer versions of Brackets will overwrite previously installed versions.

You can preserve an already installed version of Brackets to keep multiple versions of Brackets on your system at once. Simply copy it to a different location before installing the new release. For example, on Mac, just rename to Brackets Sprint and then install the new release from the .dmg. On Windows, copy the \Program Files (x86)\Bracks folder Brackets Sprint 34, and then install the new release from the .msi. File associations will remain with the newer version that overwrites the original location.

Extensions - the Extension Manager 'Available' and 'Installed' tabs have switched places.

Search - Find in Files and Quick Open now include files you have opened that lie outside the root folder of your project.

API Changes

File APIs - Sprint 34 introduces a new FileSystem API that replaces NativeFileSystem and FileIndexManager. Some of the old APIs are removed immediately; others are deprecated and will be removed later. See the API migration guide and discussion thread for details.

FileUtils.getFilenameExtension(), which was already deprecated, is now removed. Use getFileExtension() instead (note that it excludes the leading ".").

New/Improved Extensibility APIs

Documents - New DocumentManager.getDocumentText() API can be significantly faster than using getDocumentForPath() if all you need to do is call getText() on it. Especially beneficial for bulk operations such as Find in Files.

Quick Open - QuickOpen providers can now specify a label property that is shown in the search bar when that provider is active. Also, some previously required properties are now optional.

CodeMirror modes - Brackets can now load CodeMirror modes that use the multiplex or overlay addon utilities.

Known Issues

  • Mountain Lion (OS X 10.8) by default will not allow Brackets to run since it's not digitally signed yet. To work around this, right click the Brackets app and choose Open. You only need to do that once -- afterward, launching Brackets the normal way will work also.
  • Brackets may freeze when opening a JS file whose siblings contain certain non-JS text, or whose siblings are large binary files. Workaround: move those non-source-code files into a different folder. See #6067. This is fixed in the Sprint 34.1 update.
  • Editor renders incorrectly (missing text / wrong height) after opening a LESS file that begins in a tag selector (with no header comment, etc. before it). Workaround: add a comment to top of each LESS file. See #6057. This is fixed in the Sprint 34.1 update.
  • A few extensions are incompatible with the file system API change. Most have updates available already; until you have updated, disable or remove the extension to avoid problems.
  • #2272: Windows Vista may not allow the Brackets installer to run (you may not see any error message). To work around this, right-click the installer file, choose Properties, and click the Unblock button.
  • #4362: Slow startup of Brackets and Live Preview on Windows due to Chrome proxy settings. See workaround.
  • Debug > Run Tests is disabled in the installer/DMG distributions of Brackets, because the unit test code is not included. To run unit tests, pull Brackets from GitHub instead.

Community contributions to Brackets

Pulling source code from Git

  • A new brackets-shell build is required for this sprint. Be sure to rerun grunt setup before building.
  • A submodule was added this sprint. Run git submodule update --init to ensure your source tree is fully up to date.
  • A submodule was also deleted this sprint. You may delete the src/thirdparty/smart-auto-complete folder after syncing (Git will not automatically clean it up).

Bugs fixed in Sprint 34

For details on the bugs addressed, please refer to closed sprint 34 bugs. A few of the fixed bugs might not be caught by this search query, however.