Skip to content

fix: prevent OOM crash from file indexing on large projects #2801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abose merged 1 commit into from
Apr 8, 2026
Merged

fix: prevent OOM crash from file indexing on large projects #2801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
263 changes: 135 additions & 128 deletions docs/API-Reference/view/PanelView.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,144 @@
const PanelView = brackets.getModule("view/PanelView")
```

<a name="_panelMap"></a>

## \_panelMap : <code>Object.&lt;string, Panel&gt;</code>
Maps panel ID to Panel instance

**Kind**: global variable
<a name="_$container"></a>

## \_$container : <code>jQueryObject</code>
The single container wrapping all bottom panels

**Kind**: global variable
<a name="_$tabBar"></a>

## \_$tabBar : <code>jQueryObject</code>
The tab bar inside the container

**Kind**: global variable
<a name="_$tabsOverflow"></a>

## \_$tabsOverflow : <code>jQueryObject</code>
Scrollable area holding the tab elements

**Kind**: global variable
<a name="_openIds"></a>

## \_openIds : <code>Array.&lt;string&gt;</code>
Ordered list of currently open (tabbed) panel IDs

**Kind**: global variable
<a name="_activeId"></a>

## \_activeId : <code>string</code> \| <code>null</code>
The panel ID of the currently visible (active) tab

**Kind**: global variable
<a name="_isMaximized"></a>

## \_isMaximized : <code>boolean</code>
Whether the bottom panel is currently maximized

**Kind**: global variable
<a name="_preMaximizeHeight"></a>

## \_preMaximizeHeight : <code>number</code> \| <code>null</code>
The panel height before maximize, for restore

**Kind**: global variable
<a name="_$editorHolder"></a>

## \_$editorHolder : <code>jQueryObject</code>
The editor holder element, passed from WorkspaceManager

**Kind**: global variable
<a name="_recomputeLayout"></a>

## \_recomputeLayout : <code>function</code>
recomputeLayout callback from WorkspaceManager

**Kind**: global variable
<a name="_defaultPanelId"></a>

## \_defaultPanelId : <code>string</code> \| <code>null</code>
The default/quick-access panel ID

**Kind**: global variable
<a name="_$addBtn"></a>

## \_$addBtn : <code>jQueryObject</code>
The "+" button inside the tab overflow area

**Kind**: global variable
<a name="_$overflowBtn"></a>

## \_$overflowBtn : <code>jQueryObject</code>
Overflow dropdown button

**Kind**: global variable
<a name="_overflowDropdown"></a>

## \_overflowDropdown : <code>DropdownButton.DropdownButton</code>
**Kind**: global variable
<a name="EVENT_PANEL_HIDDEN"></a>

## EVENT\_PANEL\_HIDDEN : <code>string</code>
Event when panel is hidden

**Kind**: global constant
<a name="EVENT_PANEL_SHOWN"></a>

## EVENT\_PANEL\_SHOWN : <code>string</code>
Event when panel is shown

**Kind**: global constant
<a name="PANEL_TYPE_BOTTOM_PANEL"></a>

## PANEL\_TYPE\_BOTTOM\_PANEL : <code>string</code>
type for bottom panel

**Kind**: global constant
<a name="MAXIMIZE_THRESHOLD"></a>

## MAXIMIZE\_THRESHOLD : <code>number</code>
Pixel threshold for detecting near-maximize state during resize.
If the editor holder height is within this many pixels of zero, the
panel is treated as maximized. Keeps the maximize icon responsive
during drag without being overly sensitive.

**Kind**: global constant
<a name="MIN_PANEL_HEIGHT"></a>

## MIN\_PANEL\_HEIGHT : <code>number</code>
Minimum panel height (matches Resizer minSize) used as a floor
when computing a sensible restore height.

**Kind**: global constant
<a name="PREF_BOTTOM_PANEL_MAXIMIZED"></a>

## PREF\_BOTTOM\_PANEL\_MAXIMIZED
Preference key for persisting the maximize state across reloads.

**Kind**: global constant
<a name="Panel"></a>

## Panel
**Kind**: global class
## Panel($panel, id, [title], [options])
**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| $panel | <code>jQueryObject</code> | |
| id | <code>string</code> | |
| [title] | <code>string</code> | |
| [options] | <code>Object</code> | |
| [options.iconClass] | <code>string</code> | FontAwesome class string (e.g. "fa-solid fa-terminal"). |
| [options.iconSvg] | <code>string</code> | Path to an SVG icon (e.g. "styles/images/icon.svg"). |


* [Panel](#Panel)
* [new Panel($panel, id, [title])](#new_Panel_new)
* [Panel($panel, id, [title], [options])](#Panel)
* [.$panel](#Panel+$panel) : <code>jQueryObject</code>
* [.isVisible()](#Panel+isVisible) ⇒ <code>boolean</code>
* [.registerCanBeShownHandler(canShowHandlerFn)](#Panel+registerCanBeShownHandler) ⇒ <code>boolean</code>
Expand All @@ -24,18 +155,6 @@ const PanelView = brackets.getModule("view/PanelView")
* [.destroy()](#Panel+destroy)
* [.getPanelType()](#Panel+getPanelType) ⇒ <code>string</code>

<a name="new_Panel_new"></a>

### new Panel($panel, id, [title])
Represents a panel below the editor area (a child of ".content").


| Param | Type | Description |
| --- | --- | --- |
| $panel | <code>jQueryObject</code> | The entire panel, including any chrome, already in the DOM. |
| id | <code>string</code> | Unique panel identifier. |
| [title] | <code>string</code> | Optional display title for the tab bar. |

<a name="Panel+$panel"></a>

### panel.$panel : <code>jQueryObject</code>
Expand Down Expand Up @@ -144,118 +263,6 @@ After calling this, the Panel instance should not be reused.
gets the Panel's type

**Kind**: instance method of [<code>Panel</code>](#Panel)
<a name="_panelMap"></a>

## \_panelMap : <code>Object.&lt;string, Panel&gt;</code>
Maps panel ID to Panel instance

**Kind**: global variable
<a name="_$container"></a>

## \_$container : <code>jQueryObject</code>
The single container wrapping all bottom panels

**Kind**: global variable
<a name="_$tabBar"></a>

## \_$tabBar : <code>jQueryObject</code>
The tab bar inside the container

**Kind**: global variable
<a name="_$tabsOverflow"></a>

## \_$tabsOverflow : <code>jQueryObject</code>
Scrollable area holding the tab elements

**Kind**: global variable
<a name="_openIds"></a>

## \_openIds : <code>Array.&lt;string&gt;</code>
Ordered list of currently open (tabbed) panel IDs

**Kind**: global variable
<a name="_activeId"></a>

## \_activeId : <code>string</code> \| <code>null</code>
The panel ID of the currently visible (active) tab

**Kind**: global variable
<a name="_isMaximized"></a>

## \_isMaximized : <code>boolean</code>
Whether the bottom panel is currently maximized

**Kind**: global variable
<a name="_preMaximizeHeight"></a>

## \_preMaximizeHeight : <code>number</code> \| <code>null</code>
The panel height before maximize, for restore

**Kind**: global variable
<a name="_$editorHolder"></a>

## \_$editorHolder : <code>jQueryObject</code>
The editor holder element, passed from WorkspaceManager

**Kind**: global variable
<a name="_recomputeLayout"></a>

## \_recomputeLayout : <code>function</code>
recomputeLayout callback from WorkspaceManager

**Kind**: global variable
<a name="_defaultPanelId"></a>

## \_defaultPanelId : <code>string</code> \| <code>null</code>
The default/quick-access panel ID

**Kind**: global variable
<a name="_$addBtn"></a>

## \_$addBtn : <code>jQueryObject</code>
The "+" button inside the tab overflow area

**Kind**: global variable
<a name="EVENT_PANEL_HIDDEN"></a>

## EVENT\_PANEL\_HIDDEN : <code>string</code>
Event when panel is hidden

**Kind**: global constant
<a name="EVENT_PANEL_SHOWN"></a>

## EVENT\_PANEL\_SHOWN : <code>string</code>
Event when panel is shown

**Kind**: global constant
<a name="PANEL_TYPE_BOTTOM_PANEL"></a>

## PANEL\_TYPE\_BOTTOM\_PANEL : <code>string</code>
type for bottom panel

**Kind**: global constant
<a name="MAXIMIZE_THRESHOLD"></a>

## MAXIMIZE\_THRESHOLD : <code>number</code>
Pixel threshold for detecting near-maximize state during resize.
If the editor holder height is within this many pixels of zero, the
panel is treated as maximized. Keeps the maximize icon responsive
during drag without being overly sensitive.

**Kind**: global constant
<a name="MIN_PANEL_HEIGHT"></a>

## MIN\_PANEL\_HEIGHT : <code>number</code>
Minimum panel height (matches Resizer minSize) used as a floor
when computing a sensible restore height.

**Kind**: global constant
<a name="PREF_BOTTOM_PANEL_MAXIMIZED"></a>

## PREF\_BOTTOM\_PANEL\_MAXIMIZED
Preference key for persisting the maximize state across reloads.

**Kind**: global constant
<a name="init"></a>

## init($container, $tabBar, $tabsOverflow, $editorHolder, recomputeLayoutFn, defaultPanelId)
Expand Down
5 changes: 3 additions & 2 deletions docs/API-Reference/view/WorkspaceManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Events:
* [.EVENT_WORKSPACE_UPDATE_LAYOUT](#module_view/WorkspaceManager..EVENT_WORKSPACE_UPDATE_LAYOUT)
* [.EVENT_WORKSPACE_PANEL_SHOWN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_SHOWN)
* [.EVENT_WORKSPACE_PANEL_HIDDEN](#module_view/WorkspaceManager..EVENT_WORKSPACE_PANEL_HIDDEN)
* [.createBottomPanel(id, $panel, [minSize], [title])](#module_view/WorkspaceManager..createBottomPanel) ⇒ <code>Panel</code>
* [.createBottomPanel(id, $panel, [minSize], [title], [options])](#module_view/WorkspaceManager..createBottomPanel) ⇒ <code>Panel</code>
* [.destroyBottomPanel(id)](#module_view/WorkspaceManager..destroyBottomPanel)
* [.createPluginPanel(id, $panel, [minSize], $toolbarIcon, [initialSize])](#module_view/WorkspaceManager..createPluginPanel) ⇒ <code>Panel</code>
* [.getAllPanelIDs()](#module_view/WorkspaceManager..getAllPanelIDs) ⇒ <code>Array</code>
Expand Down Expand Up @@ -89,7 +89,7 @@ Event triggered when a panel is hidden.
**Kind**: inner constant of [<code>view/WorkspaceManager</code>](#module_view/WorkspaceManager)
<a name="module_view/WorkspaceManager..createBottomPanel"></a>

### view/WorkspaceManager.createBottomPanel(id, $panel, [minSize], [title]) ⇒ <code>Panel</code>
### view/WorkspaceManager.createBottomPanel(id, $panel, [minSize], [title], [options]) ⇒ <code>Panel</code>
Creates a new resizable panel beneath the editor area and above the status bar footer. Panel is initially invisible.
The panel's size & visibility are automatically saved & restored as a view-state preference.

Expand All @@ -101,6 +101,7 @@ The panel's size & visibility are automatically saved & restored as a view-state
| $panel | <code>jQueryObject</code> | DOM content to use as the panel. Need not be in the document yet. Must have an id attribute, for use as a preferences key. |
| [minSize] | <code>number</code> | @deprecated No longer used. Pass `undefined`. |
| [title] | <code>string</code> | Display title shown in the bottom panel tab bar. |
| [options] | <code>Object</code> | Optional settings: - {string} iconClass FontAwesome class string (e.g. "fa-solid fa-terminal"). - {string} iconSvg Path to an SVG icon (e.g. "styles/images/icon.svg"). |

<a name="module_view/WorkspaceManager..destroyBottomPanel"></a>

Expand Down
3 changes: 3 additions & 0 deletions src/nls/root/strings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,9 @@ define({
"FIND_IN_FILES_SEARCHING": "Searching Files\u2026",
"FIND_IN_FILES_SEARCHING_IN": "In {0}",
"FIND_IN_FILES_INDEXING_PROGRESS": "Indexing {0} of {1} files for Instant Search\u2026",
"FIND_IN_FILES_CACHE_LIMIT_TITLE": "File Indexing Suspended",
"FIND_IN_FILES_CACHE_LIMIT_MSG": "The project file cache has reached {0} MB. Indexing has been suspended to prevent high memory usage. Find in Files is disabled for this project. To reduce indexing size, add folders with large or generated files to .gitignore.",
"DESCRIPTION_MAX_FILE_CACHE_SIZE_MB": "Maximum size in MB for the instant search file cache.",
"REPLACE_IN_FILES_ERRORS_TITLE": "Replace Errors",
"REPLACE_IN_FILES_ERRORS": "The following files weren't modified because they changed after the search or couldn't be written.",

Expand Down
Loading
Loading