Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Release Notes: Sprint 33

Jump to bottom
Randy Edmunds edited this page Oct 28, 2013 · 34 revisions

This is a draft!

This document will not be finalized until the end of Sprint 33 -- approximately October 29.

What's New in Sprint 33

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).

Dialogs - Modal Dialogs are now auto-centered both horizontally and vertically over the Brackets Window.

API Changes

Lo-Dash - added as a third-party dependency. The following conversions and deprecations were made:

  • Converted Array.slice(0) to _.clone()
  • Converted Async.whenIdle to _.debounce.
  • Converted NumberUtils.getRandomNumber() to _.random and removed NumberUtils.js
  • Converted StringUtils.htmlEscape to ._escape and deprecated it.
  • Converted CollectionUtils.indexOf to _.findIndex and deprecated it.
  • Converted CollectionUtils.forEach to _.forEach and deprecated it.
  • Converted CollectionUtils.some to _.some and deprecated it.
  • Converted CollectionUtils.hasProperty to _.has and deprecated it.

Functions are deprecated by adding a @deprecated annotation, and by replacing their implementation with the corresponding Lo-Dash function and a console.warn message.

Image files - The Preview Images Spec describes the API changes for the new Preview Images feature.

Inline editors - TODO: automatically-created close button; InlineTextEditor.editors removal

Files - usage of trailing-"/" was cleaned up.

The "canonical" folder path format used in DirectoryEntry.fullPath includes a trailing "/". However, we have some Brackets code that requires or generates paths in the opposite format. Several of those cases were cleaned up:

  • Renamed FileUtils.canonicalizeFolderPath() to stripTrailingSlash() since it actually makes paths not canonical. Old API was deprecated since it's still used by several extensions.
  • Added warning to docs for these APIs that return non-canonical paths: FileUtils.getNativeBracketsDirectoryPath() and FileUtils.getNativeModuleDirectoryPath().
  • Documented that ProjectManager._loadProject() and openProject() support receiving non-canonical paths
  • Fixed several ProjectManager APIs that used to return and/or receive non-canonical paths: getInitialProjectPath(), _getWelcomeProjectPath(), and updateWelcomeProjectPath(). No extensions were found that use these APIs.

New/Improved Extensibility APIs

Lo-Dash - utility library is now available in Brackets.

Closing files - TODO: new DocumentCommandHandlers API for closing multiple files in a batch

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.
  • #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 (due to new CEF libraries, Dark Shell changes on Mac and Win). Be sure to rerun grunt setup before building.
  • Some submodules were updated this sprint. Run git submodule update to ensure your source tree is fully up to date.

Bugs fixed in Sprint 33

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

Clone this wiki locally