mirror of
https://github.com/pulsar-edit/pulsar.git
synced 2024-09-11 19:17:09 +03:00
GH Action Documentation
This commit is contained in:
DeeDeeG
github-actions[bot]
parent
221fc27f6a
commit
e1a985bf1d
@ -1,150 +0,0 @@
|
||||
## Classes
|
||||
|
||||
<dl>
|
||||
<dt><a href="#AtomEnvironment">AtomEnvironment</a></dt>
|
||||
<dd><p>Pulsar global for dealing with packages, themes, menus, and the window.</p>
|
||||
<p>An instance of this class is always available as the <code>atom</code> global.</p>
|
||||
</dd>
|
||||
<dt><a href="#Clipboard">Clipboard</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<a name="AtomEnvironment"></a>
|
||||
|
||||
## AtomEnvironment
|
||||
Pulsar global for dealing with packages, themes, menus, and the window.
An instance of this class is always available as the `atom` global.
|
||||
|
||||
**Kind**: global class
|
||||
|
||||
* [AtomEnvironment](#AtomEnvironment)
|
||||
* _instance_
|
||||
* [.clipboard](#AtomEnvironment+clipboard) : [<code>Clipboard</code>](#Clipboard)
|
||||
* [.deserializers](#AtomEnvironment+deserializers) : <code>DeserializerManager</code>
|
||||
* [.views](#AtomEnvironment+views) : <code>ViewRegistry</code>
|
||||
* [.notifications](#AtomEnvironment+notifications) : <code>NotificationManager</code>
|
||||
* [.config](#AtomEnvironment+config) : <code>Config</code>
|
||||
* [.keymaps](#AtomEnvironment+keymaps) : <code>KeymapManager</code>
|
||||
* [.tooltips](#AtomEnvironment+tooltips) : <code>TooltipManager</code>
|
||||
* [.commands](#AtomEnvironment+commands) : <code>CommandRegistry</code>
|
||||
* [.grammars](#AtomEnvironment+grammars) : <code>GrammarRegistry</code>
|
||||
* [.styles](#AtomEnvironment+styles) : <code>StyleManager</code>
|
||||
* [.packages](#AtomEnvironment+packages) : <code>PackageManager</code>
|
||||
* [.themes](#AtomEnvironment+themes) : <code>ThemeManager</code>
|
||||
* [.menu](#AtomEnvironment+menu) : <code>MenuManager</code>
|
||||
* [.contextMenu](#AtomEnvironment+contextMenu) : <code>ContextMenuManager</code>
|
||||
* [.project](#AtomEnvironment+project) : <code>Project</code>
|
||||
* [.textEditors](#AtomEnvironment+textEditors) : <code>TextEditorRegistry</code>
|
||||
* [.workspace](#AtomEnvironment+workspace) : <code>Workspace</code>
|
||||
* [.history](#AtomEnvironment+history) : <code>HistoryManager</code>
|
||||
* _Messaging the User_
|
||||
* [.beep()](#AtomEnvironment+beep)
|
||||
* _static_
|
||||
* _Event Subscription_
|
||||
* [.onDidBeep(callback)](#AtomEnvironment.onDidBeep) ⇒ <code>Disposable</code>
|
||||
|
||||
<a name="AtomEnvironment+clipboard"></a>
|
||||
|
||||
### atomEnvironment.clipboard : [<code>Clipboard</code>](#Clipboard)
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+deserializers"></a>
|
||||
|
||||
### atomEnvironment.deserializers : <code>DeserializerManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+views"></a>
|
||||
|
||||
### atomEnvironment.views : <code>ViewRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+notifications"></a>
|
||||
|
||||
### atomEnvironment.notifications : <code>NotificationManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+config"></a>
|
||||
|
||||
### atomEnvironment.config : <code>Config</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+keymaps"></a>
|
||||
|
||||
### atomEnvironment.keymaps : <code>KeymapManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+tooltips"></a>
|
||||
|
||||
### atomEnvironment.tooltips : <code>TooltipManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+commands"></a>
|
||||
|
||||
### atomEnvironment.commands : <code>CommandRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+grammars"></a>
|
||||
|
||||
### atomEnvironment.grammars : <code>GrammarRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+styles"></a>
|
||||
|
||||
### atomEnvironment.styles : <code>StyleManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+packages"></a>
|
||||
|
||||
### atomEnvironment.packages : <code>PackageManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+themes"></a>
|
||||
|
||||
### atomEnvironment.themes : <code>ThemeManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+menu"></a>
|
||||
|
||||
### atomEnvironment.menu : <code>MenuManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+contextMenu"></a>
|
||||
|
||||
### atomEnvironment.contextMenu : <code>ContextMenuManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+project"></a>
|
||||
|
||||
### atomEnvironment.project : <code>Project</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+textEditors"></a>
|
||||
|
||||
### atomEnvironment.textEditors : <code>TextEditorRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+workspace"></a>
|
||||
|
||||
### atomEnvironment.workspace : <code>Workspace</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+history"></a>
|
||||
|
||||
### atomEnvironment.history : <code>HistoryManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+beep"></a>
|
||||
|
||||
### atomEnvironment.beep()
|
||||
Visually and audibly trigger a beep.
|
||||
|
||||
**Kind**: instance method of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
**Category**: Messaging the User
|
||||
**Emits**: <code>event:beep</code>
|
||||
<a name="AtomEnvironment.onDidBeep"></a>
|
||||
|
||||
### AtomEnvironment.onDidBeep(callback) ⇒ <code>Disposable</code>
|
||||
Invoke the given callback whenever [::beep](::beep) is called.
|
||||
|
||||
**Kind**: static method of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
**Returns**: <code>Disposable</code> - on which `.dispose()` can be called to unsubscribe.
|
||||
**Category**: Event Subscription
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| callback | <code>function</code> | Function to be called whenever [::beep](::beep) is called. |
|
||||
|
||||
<a name="Clipboard"></a>
|
||||
|
||||
## Clipboard
|
||||
**Kind**: global class
|
||||
<a name="new_Clipboard_new"></a>
|
||||
|
||||
### new Clipboard()
|
||||
Represents the clipboard used for copying and pasting in Pulsar.
An instance of this class is always available as the `atom.clipboard` global.
|
||||
|
||||
**Example**
|
||||
```js
|
||||
// returns 'hello'
atom.clipboard.write('hello');
console.log(atom.clipboard.read());
|
||||
```
|
||||
@ -1,158 +0,0 @@
|
||||
## Classes
|
||||
|
||||
<dl>
|
||||
<dt><a href="#AtomEnvironment">AtomEnvironment</a></dt>
|
||||
<dd><p>Pulsar global for dealing with packages, themes, menus, and the window.</p>
|
||||
<p>An instance of this class is always available as the <code>atom</code> global.</p>
|
||||
</dd>
|
||||
<dt><a href="#Clipboard">Clipboard</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<a name="AtomEnvironment"></a>
|
||||
|
||||
## AtomEnvironment
|
||||
Pulsar global for dealing with packages, themes, menus, and the window.
An instance of this class is always available as the `atom` global.
|
||||
|
||||
**Kind**: global class
|
||||
|
||||
* [AtomEnvironment](#AtomEnvironment)
|
||||
* _instance_
|
||||
* [.clipboard](#AtomEnvironment+clipboard) : [<code>Clipboard</code>](#Clipboard)
|
||||
* [.deserializers](#AtomEnvironment+deserializers) : <code>DeserializerManager</code>
|
||||
* [.views](#AtomEnvironment+views) : <code>ViewRegistry</code>
|
||||
* [.notifications](#AtomEnvironment+notifications) : <code>NotificationManager</code>
|
||||
* [.config](#AtomEnvironment+config) : <code>Config</code>
|
||||
* [.keymaps](#AtomEnvironment+keymaps) : <code>KeymapManager</code>
|
||||
* [.tooltips](#AtomEnvironment+tooltips) : <code>TooltipManager</code>
|
||||
* [.commands](#AtomEnvironment+commands) : <code>CommandRegistry</code>
|
||||
* [.grammars](#AtomEnvironment+grammars) : <code>GrammarRegistry</code>
|
||||
* [.styles](#AtomEnvironment+styles) : <code>StyleManager</code>
|
||||
* [.packages](#AtomEnvironment+packages) : <code>PackageManager</code>
|
||||
* [.themes](#AtomEnvironment+themes) : <code>ThemeManager</code>
|
||||
* [.menu](#AtomEnvironment+menu) : <code>MenuManager</code>
|
||||
* [.contextMenu](#AtomEnvironment+contextMenu) : <code>ContextMenuManager</code>
|
||||
* [.project](#AtomEnvironment+project) : <code>Project</code>
|
||||
* [.textEditors](#AtomEnvironment+textEditors) : <code>TextEditorRegistry</code>
|
||||
* [.workspace](#AtomEnvironment+workspace) : <code>Workspace</code>
|
||||
* [.history](#AtomEnvironment+history) : <code>HistoryManager</code>
|
||||
* _Messaging the User_
|
||||
* [.beep()](#AtomEnvironment+beep)
|
||||
* _static_
|
||||
* [.preloadPackages](#AtomEnvironment.preloadPackages) ℗
|
||||
* _Event Subscription_
|
||||
* [.onDidBeep(callback)](#AtomEnvironment.onDidBeep) ⇒ <code>Disposable</code>
|
||||
|
||||
<a name="AtomEnvironment+clipboard"></a>
|
||||
|
||||
### atomEnvironment.clipboard : [<code>Clipboard</code>](#Clipboard)
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+deserializers"></a>
|
||||
|
||||
### atomEnvironment.deserializers : <code>DeserializerManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+views"></a>
|
||||
|
||||
### atomEnvironment.views : <code>ViewRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+notifications"></a>
|
||||
|
||||
### atomEnvironment.notifications : <code>NotificationManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+config"></a>
|
||||
|
||||
### atomEnvironment.config : <code>Config</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+keymaps"></a>
|
||||
|
||||
### atomEnvironment.keymaps : <code>KeymapManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+tooltips"></a>
|
||||
|
||||
### atomEnvironment.tooltips : <code>TooltipManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+commands"></a>
|
||||
|
||||
### atomEnvironment.commands : <code>CommandRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+grammars"></a>
|
||||
|
||||
### atomEnvironment.grammars : <code>GrammarRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+styles"></a>
|
||||
|
||||
### atomEnvironment.styles : <code>StyleManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+packages"></a>
|
||||
|
||||
### atomEnvironment.packages : <code>PackageManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+themes"></a>
|
||||
|
||||
### atomEnvironment.themes : <code>ThemeManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+menu"></a>
|
||||
|
||||
### atomEnvironment.menu : <code>MenuManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+contextMenu"></a>
|
||||
|
||||
### atomEnvironment.contextMenu : <code>ContextMenuManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+project"></a>
|
||||
|
||||
### atomEnvironment.project : <code>Project</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+textEditors"></a>
|
||||
|
||||
### atomEnvironment.textEditors : <code>TextEditorRegistry</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+workspace"></a>
|
||||
|
||||
### atomEnvironment.workspace : <code>Workspace</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+history"></a>
|
||||
|
||||
### atomEnvironment.history : <code>HistoryManager</code>
|
||||
**Kind**: instance property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
<a name="AtomEnvironment+beep"></a>
|
||||
|
||||
### atomEnvironment.beep()
|
||||
Visually and audibly trigger a beep.
|
||||
|
||||
**Kind**: instance method of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
**Category**: Messaging the User
|
||||
**Emits**: <code>event:beep</code>
|
||||
<a name="AtomEnvironment.preloadPackages"></a>
|
||||
|
||||
### AtomEnvironment.preloadPackages ℗
|
||||
Returns output of `preloadPackages()` for this Classes Instance of `Packages`.
|
||||
|
||||
**Kind**: static property of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
**Access**: private
|
||||
<a name="AtomEnvironment.onDidBeep"></a>
|
||||
|
||||
### AtomEnvironment.onDidBeep(callback) ⇒ <code>Disposable</code>
|
||||
Invoke the given callback whenever [::beep](::beep) is called.
|
||||
|
||||
**Kind**: static method of [<code>AtomEnvironment</code>](#AtomEnvironment)
|
||||
**Returns**: <code>Disposable</code> - on which `.dispose()` can be called to unsubscribe.
|
||||
**Category**: Event Subscription
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| callback | <code>function</code> | Function to be called whenever [::beep](::beep) is called. |
|
||||
|
||||
<a name="Clipboard"></a>
|
||||
|
||||
## Clipboard
|
||||
**Kind**: global class
|
||||
<a name="new_Clipboard_new"></a>
|
||||
|
||||
### new Clipboard()
|
||||
Represents the clipboard used for copying and pasting in Pulsar.
An instance of this class is always available as the `atom.clipboard` global.
|
||||
|
||||
**Example**
|
||||
```js
|
||||
// returns 'hello'
atom.clipboard.write('hello');
console.log(atom.clipboard.read());
|
||||
```
|
||||
14
yarn.lock
14
yarn.lock
@ -2349,9 +2349,9 @@ atom-slick@^2, atom-slick@^2.0.0:
|
||||
"autocomplete-html@file:packages/autocomplete-html":
|
||||
version "0.8.9"
|
||||
|
||||
"autocomplete-plus@https://github.com/pulsar-edit/autocomplete-plus.git#48ecced":
|
||||
"autocomplete-plus@https://github.com/pulsar-edit/autocomplete-plus.git#1f056ef":
|
||||
version "2.42.6"
|
||||
resolved "https://github.com/pulsar-edit/autocomplete-plus.git#48eccede0d3f2dfe4ba3deb050f4cd241efc6153"
|
||||
resolved "https://github.com/pulsar-edit/autocomplete-plus.git#1f056ef9c1fbc666309433024318678370f6bbc5"
|
||||
dependencies:
|
||||
atom-slick "^2.0.0"
|
||||
dompurify "^2.2.6"
|
||||
@ -2652,9 +2652,9 @@ braces@~3.0.2:
|
||||
dependencies:
|
||||
fill-range "^7.0.1"
|
||||
|
||||
"bracket-matcher@https://codeload.github.com/atom/bracket-matcher/legacy.tar.gz/refs/tags/v0.92.0":
|
||||
"bracket-matcher@https://github.com/pulsar-edit/bracket-matcher.git#c877977":
|
||||
version "0.92.0"
|
||||
resolved "https://codeload.github.com/atom/bracket-matcher/legacy.tar.gz/refs/tags/v0.92.0#fe75cb7dd3f286d9f20b1d1edd7fec085730a866"
|
||||
resolved "https://github.com/pulsar-edit/bracket-matcher.git#c877977ac7e9b7fe43c2100a1880c7ffc119280b"
|
||||
dependencies:
|
||||
first-mate "^7.4.1"
|
||||
underscore-plus "1.x"
|
||||
@ -5460,7 +5460,6 @@ image-size@~0.5.0:
|
||||
dependencies:
|
||||
bytes "^3.0.0"
|
||||
etch "0.9.0"
|
||||
fs-plus "^3.0.0"
|
||||
|
||||
import-fresh@^3.0.0, import-fresh@^3.1.0, import-fresh@^3.2.1:
|
||||
version "3.3.0"
|
||||
@ -8698,13 +8697,12 @@ smart-buffer@^4.0.2, smart-buffer@^4.2.0:
|
||||
resolved "https://registry.yarnpkg.com/smart-buffer/-/smart-buffer-4.2.0.tgz#6e1d71fa4f18c05f7d0ff216dd16a481d0e8d9ae"
|
||||
integrity sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==
|
||||
|
||||
"snippets@https://codeload.github.com/pulsar-edit/snippets/legacy.tar.gz/refs/tags/v1.6.1":
|
||||
"snippets@https://github.com/pulsar-edit/snippets.git#fe00fd6":
|
||||
version "1.6.1"
|
||||
resolved "https://codeload.github.com/pulsar-edit/snippets/legacy.tar.gz/refs/tags/v1.6.1#dc5e28086e77beeec63b35b3d52f6b32dc5994ab"
|
||||
resolved "https://github.com/pulsar-edit/snippets.git#fe00fd6933fa33f819d14cdd6938d538d25ba1dd"
|
||||
dependencies:
|
||||
async "~0.2.6"
|
||||
atom-select-list "^0.7.0"
|
||||
fs-plus "^3.0.0"
|
||||
loophole "^1"
|
||||
pegjs "~0.8.0"
|
||||
scoped-property-store "^0.17.0"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user