Skip to content

Commit 415805f

Browse files
authored
docs: Update readme.md, and ensure stability by sorting by name instead of relying upon glob to fix the readme (#541)
1 parent 67863b6 commit 415805f

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Many of these packages represent not just useful code, but useful patterns, or w
5555
### All packages
5656
<!--package-list-generated-start-->
5757

58-
There are 268 packages in Nevermore.
58+
There are 269 packages in Nevermore.
5959

6060
| Package | Description | Install | docs | source | changelog | npm |
6161
| ------- | ----------- | ------- | ---- | ------ | --------- | --- |
@@ -223,9 +223,9 @@ There are 268 packages in Nevermore.
223223
| [PlayerHumanoidBinder](https://quenty.github.io/NevermoreEngine/api/PlayerHumanoidBinder) | Binder that will automatically bind to each player's humanoid | `npm i @quenty/playerhumanoidbinder` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerHumanoidBinder) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerhumanoidbinder) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerhumanoidbinder/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerhumanoidbinder) |
224224
| [PlayerInputMode](https://quenty.github.io/NevermoreEngine/api/PlayerInputModeService) | Service that takes active input modes from the player and exposes it to every other player via the server. | `npm i @quenty/playerinputmode` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerInputModeService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerinputmode) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerinputmode/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerinputmode) |
225225
| [PlayersServicePromises](https://quenty.github.io/NevermoreEngine/api/PlayersServicePromises) | Utility methods for async methods in Players service | `npm i @quenty/playersservicepromises` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayersServicePromises) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playersservicepromises) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playersservicepromises/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playersservicepromises) |
226+
| [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Utility methods to query policies for players from PolicyService. | `npm i @quenty/policyserviceutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/policyserviceutils) |
226227
| [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Reimplementation of Player:GetUserThumbnailAsync but as a promise with retry logic | `npm i @quenty/playerthumbnailutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerthumbnailutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerthumbnailutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerthumbnailutils) |
227228
| [PlayerUtils](https://quenty.github.io/NevermoreEngine/api/PlayerUtils) | Player utility functions | `npm i @quenty/playerutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerutils) |
228-
| [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Utility methods to query policies for players from PolicyService. | `npm i @quenty/policyserviceutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/policyserviceutils) |
229229
| [PolynomialUtils](https://quenty.github.io/NevermoreEngine/api/PolynomialUtils) | Solves polynomials of certain degrees. | `npm i @quenty/polynomialutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PolynomialUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/polynomialutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/polynomialutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/polynomialutils) |
230230
| [PreferredParentUtils](https://quenty.github.io/NevermoreEngine/api/PreferredParentUtils) | Handles logic for creating a "preferred" parent container or erroring if it already exists | `npm i @quenty/preferredparentutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PreferredParentUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/preferredparentutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/preferredparentutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/preferredparentutils) |
231231
| [Probability](https://quenty.github.io/NevermoreEngine/api/Probability) | Probability utility functions | `npm i @quenty/probability` | [docs](https://quenty.github.io/NevermoreEngine/api/Probability) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/probability) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/probability/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/probability) |
@@ -309,6 +309,7 @@ There are 268 packages in Nevermore.
309309
| [Time](https://quenty.github.io/NevermoreEngine/api/Time) | Library handles time based parsing / operations. Untested. Based off of PHP's time system. Note: This library is out of date, and does not necessarily work. I recommend using os.time() | `npm i @quenty/time` | [docs](https://quenty.github.io/NevermoreEngine/api/Time) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/time) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/time/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/time) |
310310
| [TimedTween](https://quenty.github.io/NevermoreEngine/api/TimedTweenUtils) | Linear timed tweening model | `npm i @quenty/timedtween` | [docs](https://quenty.github.io/NevermoreEngine/api/TimedTweenUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/timedtween) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/timedtween/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/timedtween) |
311311
| [TimeSyncService](https://quenty.github.io/NevermoreEngine/api/TimeSyncService) | Quenty's TimeSyncService keeps time synchronized between all clients and the server | `npm i @quenty/timesyncservice` | [docs](https://quenty.github.io/NevermoreEngine/api/TimeSyncService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/timesyncservice) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/timesyncservice/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/timesyncservice) |
312+
| [ToolUtils](https://quenty.github.io/NevermoreEngine/api/RxToolUtils) | Utility methods for tools | `npm i @quenty/toolutils` | [docs](https://quenty.github.io/NevermoreEngine/api/RxToolUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/toolutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/toolutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/toolutils) |
312313
| [TouchingPartUtils](https://quenty.github.io/NevermoreEngine/api/TouchingPartUtils) | Utility to get touching parts on a Roblox part. This acts as a performance-friendly way to query Roblox's spatial tree. | `npm i @quenty/touchingpartutils` | [docs](https://quenty.github.io/NevermoreEngine/api/TouchingPartUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/touchingpartutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/touchingpartutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/touchingpartutils) |
313314
| [trajectory](https://quenty.github.io/NevermoreEngine/api/trajectory) | Utility function for estimating low and high arcs of projectiles. Solves for bullet drop given | `npm i @quenty/trajectory` | [docs](https://quenty.github.io/NevermoreEngine/api/trajectory) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/trajectory) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/trajectory/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/trajectory) |
314315
| [TransitionModel](https://quenty.github.io/NevermoreEngine/api/TransitionModelUtils) | Helps with Gui visiblity showing and hiding | `npm i @quenty/transitionmodel` | [docs](https://quenty.github.io/NevermoreEngine/api/TransitionModelUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/transitionmodel) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/transitionmodel/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/transitionmodel) |

tools/update_readme.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ def get_package_data_list(root):
7777
columns = [linked_name, description, install_command, f"[docs]({docs_link})", f"[source]({github_link})", f"[changelog]({changelog_link})", f"[npm]({npm_link})"]
7878
package_data_list.append(columns)
7979

80+
def get_name(entry):
81+
return entry[0].lower()
82+
package_data_list.sort(key=get_name)
83+
8084
return package_data_list
8185

8286
def update_readme(root, output):

0 commit comments

Comments
 (0)