Skip to content
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.

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

Resolve all the issues causing the docusaurus build to fail. #1927

Merged
merged 7 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/API-Reference/JSUtils/ScopeManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Marks the file as being dirty.

| Param | Type | Description |
| --- | --- | --- |
| changeList | <code>Object</code> | {from: {line:number, ch: number}, to: {line:number, ch:number}} |
| changeList | <code>Object</code> | An object representing the change range with `from` and `to` properties, each containing `line` and `ch` numbers. |

<a name="handleEditorChange"></a>

Expand Down
15 changes: 8 additions & 7 deletions docs/API-Reference/command/KeyBindingManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,10 @@ Remove a key binding from _keymap

<a name="getKeymap"></a>

## getKeymap([defaults]) ⇒ <code>Object.&lt;string, {commandID: string, key: string, displayKey: string}&gt;</code>
## getKeymap([defaults]) ⇒ <code>Object</code>
Returns a copy of the current key map. If the optional 'defaults' parameter is true,
then a copy of the default key map is returned.
In the default keymap each key is associated with an object containing `commandID`, `key`, and `displayKey`.

**Kind**: global function

Expand All @@ -80,27 +81,27 @@ then a copy of the default key map is returned.

<a name="addBinding"></a>

## addBinding(command, keyBindings, platform, options) ⇒ <code>Object</code> \| <code>Array.&lt;{key: string, displayKey:String}&gt;</code>
## addBinding(command, keyBindings, platform, options) ⇒ <code>Object</code>
Add one or more key bindings to a particular Command.
Returns record(s) for valid key binding(s).

**Kind**: global function
**Returns**: <code>Object</code> \| <code>Array.&lt;{key: string, displayKey:String}&gt;</code> - Returns record(s) for valid key binding(s)

| Param | Type | Description |
| --- | --- | --- |
| command | <code>string</code> \| <code>Command</code> | A command ID or command object |
| keyBindings | <code>Object</code> \| <code>Array.&lt;{key: string, displayKey: string, platform: string}&gt;</code> | A single key binding or an array of keybindings. Example: "Shift-Cmd-F". Mac and Win key equivalents are automatically mapped to each other. Use displayKey property to display a different string (e.g. "CMD+" instead of "CMD="). |
| keyBindings | <code>Object</code> | A single key binding or an array of keybindings. In an array of keybinding `platform` property is also available. Example: "Shift-Cmd-F". Mac and Win key equivalents are automatically mapped to each other. Use displayKey property to display a different string (e.g. "CMD+" instead of "CMD="). |
| platform | <code>string</code> | The target OS of the keyBindings either "mac", "win" or "linux". If undefined, all platforms not explicitly defined will use the key binding. NOTE: If platform is not specified, Ctrl will be replaced by Cmd for "mac" platform |
| options | <code>object</code> | |
| options.isMenuShortcut | <code>boolean</code> | this allows alt-key shortcuts to be registered. |

<a name="getKeyBindings"></a>

## getKeyBindings(command) ⇒ <code>Array.&lt;{{key: string, displayKey: string}}&gt;</code>
## getKeyBindings(command) ⇒ <code>Array.&lt;Object&gt;</code>
Retrieve key bindings currently associated with a command

**Kind**: global function
**Returns**: <code>Array.&lt;{{key: string, displayKey: string}}&gt;</code> - An array of associated key bindings.
**Returns**: <code>Array.&lt;Object&gt;</code> - The object has two properties `key` and `displayKey`

| Param | Type | Description |
| --- | --- | --- |
Expand Down Expand Up @@ -179,7 +180,7 @@ under use preset dropdown. For EG. distribute a `netbeans editor` shortcuts pack
| --- | --- | --- |
| packID | <code>string</code> | A unique ID for the pack. Use `extensionID.name` format to avoid collisions. |
| packName | <code>string</code> | A name for the pack. |
| keyMap | <code>Object</code> | a keymap of the format {`Ctrl-Alt-L`: `file.liveFilePreview`} depending on the platform. The extension should decide the correct keymap based on the platform before calling this function. |
| keyMap | <code>Object</code> | a keymap of the format `{'Ctrl-Alt-L': 'file.liveFilePreview'}` depending on the platform. The extension should decide the correct keymap based on the platform before calling this function. |

<a name="getAllCustomKeymapPacks"></a>

Expand Down
5 changes: 5 additions & 0 deletions docs/API-Reference/features/PriorityBasedRegistration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Import :
```js
const PriorityBasedRegistration = brackets.getModule("features/PriorityBasedRegistration")
```

35 changes: 35 additions & 0 deletions docs/API-Reference/filesystem/FileSystemError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### Import :
```js
const FileSystemError = brackets.getModule("filesystem/FileSystemError")
```

<a name="module_FileSystemError"></a>

## FileSystemError
FileSystemError describes the errors that can occur when using the FileSystem, File,
and Directory modules.

Error values are strings. Any "falsy" value: null, undefined or "" means "no error".

Enumerated File System Errors

```js
UNKNOWN: "Unknown",
INVALID_PARAMS: "InvalidParams",
NOT_FOUND: "NotFound",
NOT_READABLE: "NotReadable",
UNSUPPORTED_ENCODING: "UnsupportedEncoding",
NOT_SUPPORTED: "NotSupported",
NOT_WRITABLE: "NotWritable",
OUT_OF_SPACE: "OutOfSpace",
TOO_MANY_ENTRIES: "TooManyEntries",
ALREADY_EXISTS: "AlreadyExists",
CONTENTS_MODIFIED: "ContentsModified",
ROOT_NOT_WATCHED: "RootNotBeingWatched",
EXCEEDS_MAX_FILE_SIZE: "ExceedsMaxFileSize",
NETWORK_DRIVE_NOT_SUPPORTED: "NetworkDriveNotSupported",
ENCODE_FILE_FAILED: "EncodeFileFailed",
DECODE_FILE_FAILED: "DecodeFileFailed",
UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
```

50 changes: 50 additions & 0 deletions docs/API-Reference/filesystem/FileSystemStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
### Import :
```js
const FileSystemStats = brackets.getModule("filesystem/FileSystemStats")
```

<a name="FileSystemStats"></a>

## FileSystemStats
**Kind**: global class
<a name="new_FileSystemStats_new"></a>

### new FileSystemStats(options)
The FileSystemStats represents a particular FileSystemEntry's stats.


| Param | Type |
| --- | --- |
| options | <code>Object</code> |

<a name="isFile"></a>

## isFile : <code>boolean</code>
Whether or not this is a stats object for a file

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

## isDirectory : <code>boolean</code>
Whether or not this is a stats object for a directory

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

## mtime : <code>Date</code>
Modification time for a file

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

## size : <code>Number</code>
Size in bytes of a file

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

## realPath : <code>string</code>
The canonical path of this file or directory ONLY if it is a symbolic link,
and null otherwise.

**Kind**: global variable
122 changes: 122 additions & 0 deletions docs/API-Reference/filesystem/RemoteFile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
### Import :
```js
const RemoteFile = brackets.getModule("filesystem/RemoteFile")
```

<a name="RemoteFile"></a>

## RemoteFile
**Kind**: global class

* [RemoteFile](#RemoteFile)
* [new RemoteFile(fullPath, fileSystem)](#new_RemoteFile_new)
* [.toString()](#RemoteFile+toString)
* [.stat(callback)](#RemoteFile+stat)
* [.read([options], callback)](#RemoteFile+read)
* [.write(data, [options], [callback])](#RemoteFile+write)
* [.exists(callback)](#RemoteFile+exists)
* [.unlink(callback)](#RemoteFile+unlink)
* [.rename(callback)](#RemoteFile+rename)
* [.moveToTrash(callback)](#RemoteFile+moveToTrash)

<a name="new_RemoteFile_new"></a>

### new RemoteFile(fullPath, fileSystem)
Model for a RemoteFile.

This class should *not* be instantiated directly. Use FileSystem.getFileForPath

See the FileSystem class for more details.


| Param | Type | Description |
| --- | --- | --- |
| fullPath | <code>string</code> | The full path for this File. |
| fileSystem | <code>FileSystem</code> | The file system associated with this File. |

<a name="RemoteFile+toString"></a>

### remoteFile.toString()
Helpful toString for debugging and equality check purposes

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)
<a name="RemoteFile+stat"></a>

### remoteFile.stat(callback)
Returns the stats for the remote entry.

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | Callback with a FileSystemError string or FileSystemStats object. |

<a name="RemoteFile+read"></a>

### remoteFile.read([options], callback)
Reads a remote file.

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type | Description |
| --- | --- | --- |
| [options] | <code>Object</code> | Currently unused. |
| callback | <code>function</code> | Callback that is passed the FileSystemError string or the file's contents and its stats. |

<a name="RemoteFile+write"></a>

### remoteFile.write(data, [options], [callback])
Write a file.

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type | Description |
| --- | --- | --- |
| data | <code>string</code> | Data to write. |
| [options] | <code>object</code> | Currently unused. |
| [callback] | <code>function</code> | Callback that is passed the FileSystemError string or the file's new stats. |

<a name="RemoteFile+exists"></a>

### remoteFile.exists(callback)
Check if the remote file exists or not

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type |
| --- | --- |
| callback | <code>function</code> |

<a name="RemoteFile+unlink"></a>

### remoteFile.unlink(callback)
Unlink the remote file

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type |
| --- | --- |
| callback | <code>function</code> |

<a name="RemoteFile+rename"></a>

### remoteFile.rename(callback)
Rename the remote file

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type |
| --- | --- |
| callback | <code>function</code> |

<a name="RemoteFile+moveToTrash"></a>

### remoteFile.moveToTrash(callback)
Move the remote file to trash

**Kind**: instance method of [<code>RemoteFile</code>](#RemoteFile)

| Param | Type |
| --- | --- |
| callback | <code>function</code> |

75 changes: 75 additions & 0 deletions docs/API-Reference/filesystem/WatchedRoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
### Import :
```js
const WatchedRoot = brackets.getModule("filesystem/WatchedRoot")
```

<a name="WatchedRoot"></a>

## WatchedRoot
**Kind**: global class

* [WatchedRoot](#WatchedRoot)
* [new WatchedRoot(entry, filter, filterGitIgnore)](#new_WatchedRoot_new)
* _instance_
* [.entry](#WatchedRoot+entry) : <code>File</code> \| <code>Directory</code>
* [.filter](#WatchedRoot+filter) : <code>function</code>
* [.filterGitIgnore](#WatchedRoot+filterGitIgnore) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
* [.status](#WatchedRoot+status) : <code>number</code>
* _static_
* [.INACTIVE](#WatchedRoot.INACTIVE) : <code>number</code>
* [.STARTING](#WatchedRoot.STARTING) : <code>number</code>
* [.ACTIVE](#WatchedRoot.ACTIVE) : <code>number</code>

<a name="new_WatchedRoot_new"></a>

### new WatchedRoot(entry, filter, filterGitIgnore)
Represents file or directory structure watched by the FileSystem. If the
entry is a directory, all children (that pass the supplied filter function)
are also watched. A WatchedRoot object begins and ends its life in the
INACTIVE state. While in the process of starting up watchers, the WatchedRoot
is in the STARTING state. When watchers are ready, the WatchedRoot enters
the ACTIVE state.

See the FileSystem class for more details.


| Param | Type |
| --- | --- |
| entry | <code>File</code> \| <code>Directory</code> |
| filter | <code>function</code> |
| filterGitIgnore | <code>string</code> \| <code>Array.&lt;string&gt;</code> |

<a name="WatchedRoot+entry"></a>

### watchedRoot.entry : <code>File</code> \| <code>Directory</code>
**Kind**: instance property of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot+filter"></a>

### watchedRoot.filter : <code>function</code>
**Kind**: instance property of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot+filterGitIgnore"></a>

### watchedRoot.filterGitIgnore : <code>string</code> \| <code>Array.&lt;string&gt;</code>
**Kind**: instance property of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot+status"></a>

### watchedRoot.status : <code>number</code>
**Kind**: instance property of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot.INACTIVE"></a>

### WatchedRoot.INACTIVE : <code>number</code>
WatchedRoot inactive

**Kind**: static constant of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot.STARTING"></a>

### WatchedRoot.STARTING : <code>number</code>
WatchedRoot starting

**Kind**: static constant of [<code>WatchedRoot</code>](#WatchedRoot)
<a name="WatchedRoot.ACTIVE"></a>

### WatchedRoot.ACTIVE : <code>number</code>
WatchedRoot active

**Kind**: static constant of [<code>WatchedRoot</code>](#WatchedRoot)
6 changes: 3 additions & 3 deletions docs/API-Reference/widgets/Dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The template can either be a string or a jQuery object representing a DOM node t

<a name="showModalDialog"></a>

## showModalDialog(dlgClass, [title], [message], [buttons], [autoDismiss]) ⇒ [<code>Dialog</code>](#new_Dialog_new)
## showModalDialog(dlgClass, [title], [message], buttons, [autoDismiss]) ⇒ [<code>Dialog</code>](#new_Dialog_new)
Creates a new general purpose modal dialog using the default template and the template variables given
as parameters as described.

Expand All @@ -83,7 +83,7 @@ as parameters as described.
| dlgClass | <code>string</code> | A class name identifier for the dialog. Typically one of DefaultDialogs.* |
| [title] | <code>string</code> | The title of the dialog. Can contain HTML markup. Defaults to "". |
| [message] | <code>string</code> | The message to display in the dialog. Can contain HTML markup. Defaults to "". |
| [buttons] | <code>Array.&lt;{className: string, id: string, text: string, tooltip:string}&gt;</code> | An array of buttons where each button has a class, id tooltip, and text property. The id is used in "data-button-id". Defaults to a single Ok button. Typically className is one of DIALOG_BTN_CLASS_*, id is one of DIALOG_BTN_* |
| buttons | <code>Array.&lt;Object&gt;</code> | An array of buttons where each button has a class, id tooltip, and text property. The id is used in "data-button-id". Defaults to a single Ok button. Typically className is one of DIALOG_BTN_CLASS_*, id is one of DIALOG_BTN_* |
| [autoDismiss] | <code>boolean</code> | Whether to automatically dismiss the dialog when one of the buttons is clicked. Default true. If false, you'll need to manually handle button clicks and the Esc key, and dismiss the dialog yourself when ready by calling `close()` on the returned dialog. |

<a name="showConfirmDialog"></a>
Expand Down Expand Up @@ -144,7 +144,7 @@ be called with the special buttonId DIALOG_CANCELED (note: callback is run async
<a name="addLinkTooltips"></a>

## addLinkTooltips(elementOrDialog)
Ensures that all <a> tags with a URL have a tooltip showing the same URL
Ensures that all anchor tags with a URL have a tooltip showing the same URL

**Kind**: global function

Expand Down
3 changes: 1 addition & 2 deletions src/JSUtils/ScopeManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -1511,8 +1511,7 @@ define(function (require, exports, module) {
/**
* Called each time the file associated with the active editor changes.
* Marks the file as being dirty.
*
* @param {{line:number, ch: number}} changeList {from: {line:number, ch: number}, to: {line:number, ch:number}}
* @param {{line:number, ch: number}} changeList - An object representing the change range with `from` and `to` properties, each containing `line` and `ch` numbers.
*/
function handleFileChange(changeList) {
isDocumentDirty = true;
Expand Down
Loading
Loading