pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-10-03 22:07:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

GH Action Documentation

Browse Source
This commit is contained in:
savetheclocktower 2024-01-07 23:36:02 +00:00 committed by github-actions[bot]
parent fd908ca0b7
commit 4a7f23d91e
3 changed files with 278 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
docs/Pulsar-API-Documentation.md
View File

@ -7,6 +7,23 @@
</dd>
<dt><a href="#Clipboard">Clipboard</a></dt>
<dd></dd>
<dt><a href="#Container">Container</a></dt>
<dd><p>A container capture. When another capture&#39;s node is contained by the
definition capture&#39;s node, it gets added to this instance.</p>
</dd>
<dt><a href="#CaptureOrganizer">CaptureOrganizer</a></dt>
<dd><p>Keeps track of @definition.* captures and the captures they may contain.</p>
</dd>
<dt><a href="#InvalidProviderError">InvalidProviderError</a> ⇐ <code>Error</code></dt>
<dd><p>An error thrown when a newly added symbol provider does not conform to its
contract.</p>
</dd>
<dt><a href="#ListController">ListController</a></dt>
<dd><p>A class for setting various UI properties on a symbol list palette. This is a
privilege given to the “main” (or <em>exclusive</em>) provider for a given task.</p>
<p>This is how we allow a provider to communicate its state to the UI without
giving it full control over the <code>SelectListView</code> used to show results.</p>
</dd>
</dl>
## Constants
@ -202,6 +219,25 @@ style: Exclusively used for the <code>style</code> attribute</p>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#isIterable">isIterable(obj)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Ensures an object can be iterated over.</p>
<p>The contract with the symbol providers is that they return an object that
gives us symbol objects when we iterate over it. It&#39;ll probably be an array,
but we&#39;re cool with anything iterable.</p>
</dd>
<dt><a href="#timeout">timeout(ms)</a> ⇒ <code>Promise.&lt;true&gt;</code></dt>
<dd><p>Returns a promise that resolves after a given number of milliseconds.</p>
</dd>
<dt><a href="#getBadgeTextVariant">getBadgeTextVariant(text)</a> ⇒ <code>String</code></dt>
<dd><p>Given a string of text, returns a hexadecimal character from <code>0</code> to <code>f</code> to
represent a classification “bucket.” This is used when assigning colors to
various symbol badges.</p>
</dd>
<dt><a href="#badge">badge(text, options)</a> ⇒ <code>Element</code></dt>
<dd><p>Return a DOM element for a badge for a given symbol tag name.</p>
</dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
@ -358,6 +394,37 @@ atom.clipboard.write('hello');
console.log(atom.clipboard.read());
```
<a name="Container"></a>
## Container
A container capture. When another capture's node is contained by the
definition capture's node, it gets added to this instance.
**Kind**: global class
<a name="CaptureOrganizer"></a>
## CaptureOrganizer
Keeps track of @definition.* captures and the captures they may contain.
**Kind**: global class
<a name="InvalidProviderError"></a>
## InvalidProviderError ⇐ <code>Error</code>
An error thrown when a newly added symbol provider does not conform to its
contract.
**Kind**: global class
**Extends**: <code>Error</code>
<a name="ListController"></a>
## ListController
A class for setting various UI properties on a symbol list palette. This is a
privilege given to the “main” (or _exclusive_) provider for a given task.
This is how we allow a provider to communicate its state to the UI without
giving it full control over the `SelectListView` used to show results.
**Kind**: global class
<a name="etch"></a>
## etch
@ -628,6 +695,68 @@ This file aims to run some short simple tests against `update.js`. Focusing
**Babel**:
<a name="beforeEach"></a>
## beforeEach()
**Kind**: global function
**Babel**:
<a name="isIterable"></a>
## isIterable(obj) ⇒ <code>Boolean</code>
Ensures an object can be iterated over.
The contract with the symbol providers is that they return an object that
gives us symbol objects when we iterate over it. It'll probably be an array,
but we're cool with anything iterable.
**Kind**: global function
**Returns**: <code>Boolean</code> - Whether the item will respond correctly to a `for..of`
loop.
| Param | Type | Description |
| --- | --- | --- |
| obj | <code>?</code> | Anything. |
<a name="timeout"></a>
## timeout(ms) ⇒ <code>Promise.&lt;true&gt;</code>
Returns a promise that resolves after a given number of milliseconds.
**Kind**: global function
**Returns**: <code>Promise.&lt;true&gt;</code> - A promise that resolves with `true` as its argument.
| Param | Type | Description |
| --- | --- | --- |
| ms | <code>Number</code> | Number of milliseconds after which to resolve. |
<a name="getBadgeTextVariant"></a>
## getBadgeTextVariant(text) ⇒ <code>String</code>
Given a string of text, returns a hexadecimal character from `0` to `f` to
represent a classification “bucket.” This is used when assigning colors to
various symbol badges.
**Kind**: global function
**Returns**: <code>String</code> - A single character that represents a hexadecimal digit.
| Param | Type | Description |
| --- | --- | --- |
| text | <code>String</code> | The text of the badge. |
<a name="badge"></a>
## badge(text, options) ⇒ <code>Element</code>
Return a DOM element for a badge for a given symbol tag name.
**Kind**: global function
**Returns**: <code>Element</code> - An element for adding to an `atom-select-view` entry.
| Param | Type | Description |
| --- | --- | --- |
| text | <code>String</code> | The text of the tag. |
| options | <code>Object</code> | Options. Defaults to an empty object. |
| options.variant | <code>Boolean</code> | Whether to add a class name for the badge's “variant.” If enabled, this will attempt to assign a different badge color for each kind of tag. Optional; defaults to `false`. |
<a name="beforeEach"></a>
## beforeEach()
**Kind**: global function
**Babel**:

129
docs/Source-Code-Documentation.md
View File

@ -7,6 +7,23 @@
</dd>
<dt><a href="#Clipboard">Clipboard</a></dt>
<dd></dd>
<dt><a href="#Container">Container</a></dt>
<dd><p>A container capture. When another capture&#39;s node is contained by the
definition capture&#39;s node, it gets added to this instance.</p>
</dd>
<dt><a href="#CaptureOrganizer">CaptureOrganizer</a></dt>
<dd><p>Keeps track of @definition.* captures and the captures they may contain.</p>
</dd>
<dt><a href="#InvalidProviderError">InvalidProviderError</a> ⇐ <code>Error</code></dt>
<dd><p>An error thrown when a newly added symbol provider does not conform to its
contract.</p>
</dd>
<dt><a href="#ListController">ListController</a></dt>
<dd><p>A class for setting various UI properties on a symbol list palette. This is a
privilege given to the “main” (or <em>exclusive</em>) provider for a given task.</p>
<p>This is how we allow a provider to communicate its state to the UI without
giving it full control over the <code>SelectListView</code> used to show results.</p>
</dd>
</dl>
## Constants
@ -202,6 +219,25 @@ style: Exclusively used for the <code>style</code> attribute</p>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#isIterable">isIterable(obj)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Ensures an object can be iterated over.</p>
<p>The contract with the symbol providers is that they return an object that
gives us symbol objects when we iterate over it. It&#39;ll probably be an array,
but we&#39;re cool with anything iterable.</p>
</dd>
<dt><a href="#timeout">timeout(ms)</a> ⇒ <code>Promise.&lt;true&gt;</code></dt>
<dd><p>Returns a promise that resolves after a given number of milliseconds.</p>
</dd>
<dt><a href="#getBadgeTextVariant">getBadgeTextVariant(text)</a> ⇒ <code>String</code></dt>
<dd><p>Given a string of text, returns a hexadecimal character from <code>0</code> to <code>f</code> to
represent a classification “bucket.” This is used when assigning colors to
various symbol badges.</p>
</dd>
<dt><a href="#badge">badge(text, options)</a> ⇒ <code>Element</code></dt>
<dd><p>Return a DOM element for a badge for a given symbol tag name.</p>
</dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
<dd></dd>
<dt><a href="#beforeEach">beforeEach()</a></dt>
@ -366,6 +402,37 @@ atom.clipboard.write('hello');
console.log(atom.clipboard.read());
```
<a name="Container"></a>
## Container
A container capture. When another capture's node is contained by the
definition capture's node, it gets added to this instance.
**Kind**: global class
<a name="CaptureOrganizer"></a>
## CaptureOrganizer
Keeps track of @definition.* captures and the captures they may contain.
**Kind**: global class
<a name="InvalidProviderError"></a>
## InvalidProviderError ⇐ <code>Error</code>
An error thrown when a newly added symbol provider does not conform to its
contract.
**Kind**: global class
**Extends**: <code>Error</code>
<a name="ListController"></a>
## ListController
A class for setting various UI properties on a symbol list palette. This is a
privilege given to the “main” (or _exclusive_) provider for a given task.
This is how we allow a provider to communicate its state to the UI without
giving it full control over the `SelectListView` used to show results.
**Kind**: global class
<a name="etch"></a>
## etch
@ -636,6 +703,68 @@ This file aims to run some short simple tests against `update.js`. Focusing
**Babel**:
<a name="beforeEach"></a>
## beforeEach()
**Kind**: global function
**Babel**:
<a name="isIterable"></a>
## isIterable(obj) ⇒ <code>Boolean</code>
Ensures an object can be iterated over.
The contract with the symbol providers is that they return an object that
gives us symbol objects when we iterate over it. It'll probably be an array,
but we're cool with anything iterable.
**Kind**: global function
**Returns**: <code>Boolean</code> - Whether the item will respond correctly to a `for..of`
loop.
| Param | Type | Description |
| --- | --- | --- |
| obj | <code>?</code> | Anything. |
<a name="timeout"></a>
## timeout(ms) ⇒ <code>Promise.&lt;true&gt;</code>
Returns a promise that resolves after a given number of milliseconds.
**Kind**: global function
**Returns**: <code>Promise.&lt;true&gt;</code> - A promise that resolves with `true` as its argument.
| Param | Type | Description |
| --- | --- | --- |
| ms | <code>Number</code> | Number of milliseconds after which to resolve. |
<a name="getBadgeTextVariant"></a>
## getBadgeTextVariant(text) ⇒ <code>String</code>
Given a string of text, returns a hexadecimal character from `0` to `f` to
represent a classification “bucket.” This is used when assigning colors to
various symbol badges.
**Kind**: global function
**Returns**: <code>String</code> - A single character that represents a hexadecimal digit.
| Param | Type | Description |
| --- | --- | --- |
| text | <code>String</code> | The text of the badge. |
<a name="badge"></a>
## badge(text, options) ⇒ <code>Element</code>
Return a DOM element for a badge for a given symbol tag name.
**Kind**: global function
**Returns**: <code>Element</code> - An element for adding to an `atom-select-view` entry.
| Param | Type | Description |
| --- | --- | --- |
| text | <code>String</code> | The text of the tag. |
| options | <code>Object</code> | Options. Defaults to an empty object. |
| options.variant | <code>Boolean</code> | Whether to add a class name for the badge's “variant.” If enabled, this will attempt to assign a different badge color for each kind of tag. Optional; defaults to `false`. |
<a name="beforeEach"></a>
## beforeEach()
**Kind**: global function
**Babel**:

30
yarn.lock
View File

@ -5313,7 +5313,7 @@ humanize-ms@^1.2.1:
dependencies:
ms "^2.0.0"
humanize-plus@^1.8.2, humanize-plus@~1.8.2:
humanize-plus@~1.8.2:
version "1.8.2"
resolved "https://registry.yarnpkg.com/humanize-plus/-/humanize-plus-1.8.2.tgz#a65b34459ad6367adbb3707a82a3c9f916167030"
integrity sha512-jaLeQyyzjjINGv7O9JJegjsaUcWjSj/1dcXvLEgU3pGdqCdP1PiC/uwr+saJXhTNBHZtmKnmpXyazgh+eceRxA==
@ -6990,6 +6990,11 @@ multi-integer-range@^2.0.0:
resolved "https://registry.yarnpkg.com/multi-integer-range/-/multi-integer-range-2.1.0.tgz#73675519ba2146dba22cd35960e9c5e804ffe2fc"
integrity sha512-hhxJJyEXhLlsCgzMsX10NlPL35yM/v/ThBNlHgLP/84/Wkf6VugIMIVqEH1m0bvOwGYSmz92yhPLKdoPV87BBg==
murmurhash-js@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/murmurhash-js/-/murmurhash-js-1.0.0.tgz#b06278e21fc6c37fa5313732b0412bcb6ae15f51"
integrity sha512-TvmkNhkv8yct0SVBSy+o8wYzXjE4Zz3PCesbfs8HiCXXdcTuocApFv11UWlNFWKYsP2okqrhb7JNlSm9InBhIw==
nan@2.14.0:
version "2.14.0"
resolved "https://registry.yarnpkg.com/nan/-/nan-2.14.0.tgz#7818f722027b2459a86f0295d434d1fc2336c52c"
@ -9054,18 +9059,23 @@ sylvester@^0.0.12:
resolved "https://registry.yarnpkg.com/sylvester/-/sylvester-0.0.12.tgz#5a884415cd2d002c57e7a3aac99462a75ce9fdb4"
integrity sha512-SzRP5LQ6Ts2G5NyAa/jg16s8e3R7rfdFjizy1zeoecYWw+nGL+YA1xZvW/+iJmidBGSdLkuvdwTYEyJEb+EiUw==
"symbols-view@https://codeload.github.com/atom/symbols-view/legacy.tar.gz/refs/tags/v0.118.4":
version "0.118.4"
resolved "https://codeload.github.com/atom/symbols-view/legacy.tar.gz/refs/tags/v0.118.4#cd1b515d4a3d720402b85301ea8e4d6c8815aaf2"
"symbol-provider-ctags@file:./packages/symbol-provider-ctags":
version "1.0.0"
dependencies:
async "^0.2.6"
atom-select-list "^0.7.0"
ctags "^3.1.0"
fs-plus "^3.0.0"
fs-plus "^3.1.1"
"symbol-provider-tree-sitter@file:./packages/symbol-provider-tree-sitter":
version "1.0.0"
"symbols-view@file:./packages/symbols-view":
version "1.0.0"
dependencies:
atom-select-list "^0.8.1"
fs-plus "^3.1.1"
fuzzaldrin "^2.1.0"
humanize-plus "^1.8.2"
temp "^0.8.3"
underscore-plus "^1.6.6"
murmurhash-js "^1.0.0"
tabbable@^5.1.5:
version "5.3.3"
@ -9582,7 +9592,7 @@ unbzip2-stream@1.4.3:
buffer "^5.2.1"
through "^2.3.8"
underscore-plus@1.7.0, underscore-plus@1.x, underscore-plus@^1, underscore-plus@^1.0.0, underscore-plus@^1.0.6, underscore-plus@^1.6.3, underscore-plus@^1.6.6, underscore-plus@^1.7.0, underscore-plus@~1.x:
underscore-plus@1.7.0, underscore-plus@1.x, underscore-plus@^1, underscore-plus@^1.0.0, underscore-plus@^1.0.6, underscore-plus@^1.6.3, underscore-plus@^1.7.0, underscore-plus@~1.x:
version "1.7.0"
resolved "https://registry.yarnpkg.com/underscore-plus/-/underscore-plus-1.7.0.tgz#107f1900c520ac1fefe4edec6580a7ff08a99d0f"
integrity sha512-A3BEzkeicFLnr+U/Q3EyWwJAQPbA19mtZZ4h+lLq3ttm9kn8WC4R3YpuJZEXmWdLjYP47Zc8aLZm9kwdv+zzvA==