Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Cleanup #26

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
github: csqrl
github: cxmeel
custom:
- "https://roblox.com/groups/9536808/csqrl#!/store"
- "https://www.roblox.com/groups/9536808/cxmeel#!/store"
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

### Changed

- If `update` is called with a key that doesn't exist in the specified dictionary, the key's value is **set to the key itself**. Fix by [@reselim](https://github.com/Reselim) in [PR #7](https://github.com/csqrl/sift/pull/7).
- If `update` is called with a key that doesn't exist in the specified dictionary, the key's value is **set to the key itself**. Fix by [@reselim](https://github.com/Reselim) in [PR #7](https://github.com/cxmeel/sift/pull/7).
- Added `aftman.toml` and switched GitHub workflows over to use aftman.

## [0.0.2]
Expand All @@ -52,7 +52,7 @@
### Changed

- Exposed `isEmpty` and `equalObjects` from the root module
- Improved typings for methods accepting predictes
- Improved typings for methods accepting predicates
- Updated documentation for some methods
- Fixed `Dictionary.flatten` being shown in the `Array` docs (wrong `@within` tag)

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 csqrl
Copyright (c) 2022 cxmeel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
42 changes: 20 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,32 @@

[freddylist/llama]: https://github.com/freddylist/llama
[osyrisrblx/t]: https://github.com/osyrisrblx/t
[upliftgames/moonwave]: https://github.com/upliftgames/moonwave
[evaera/moonwave]: https://github.com/evaera/moonwave
[upliftgames/wally]: https://github.com/upliftgames/wally
[sift]: https://github.com/csqrl/sift
[sift/releases]: https://github.com/csqrl/sift/releases
[sift]: https://github.com/cxmeel/sift
[sift/releases]: https://github.com/cxmeel/sift/releases
[sift/wally]: https://wally.run/package/csqrl/sift
[sift/roblox]: https://www.roblox.com/library/9486684823
[sift/itch.io]: https://csqrl.itch.io/sift
[sift/roblox]: https://create.roblox.com/store/asset/9486684823/Sift
[sift/npm]: https://npmjs.com/package/@rbxts/sift
[sift/documentation]: https://cxmeel.github.io/sift

<!-- Shields -->

[shields/github-release]: https://img.shields.io/github/v/release/csqrl/sift?label=latest+release&style=flat
[shields/github-release]: https://img.shields.io/github/v/release/cxmeel/sift?label=latest+release&style=flat
[shields/wally]: https://img.shields.io/endpoint?url=https://runkit.io/clockworksquirrel/wally-version-shield/branches/master/csqrl/sift&color=blue&label=wally&style=flat
[shields/npm]: https://img.shields.io/npm/v/@rbxts/sift?style=flat

<!-- Badges -->

[badges/github]: https://raw.githubusercontent.com/gist/csqrl/56c5f18b229ca1e61feb6eb5fb149f43/raw/githubSource.svg
[badges/itch]: https://raw.githubusercontent.com/gist/csqrl/56c5f18b229ca1e61feb6eb5fb149f43/raw/itch.svg
[badges/npm]: https://raw.githubusercontent.com/gist/csqrl/56c5f18b229ca1e61feb6eb5fb149f43/raw/npm.svg
[badges/roblox]: https://raw.githubusercontent.com/gist/csqrl/56c5f18b229ca1e61feb6eb5fb149f43/raw/roblox.svg
[badges/roblox-small]: https://raw.githubusercontent.com/gist/csqrl/56c5f18b229ca1e61feb6eb5fb149f43/raw/robloxSmall.svg
[badges/github]: https://raw.githubusercontent.com/gist/cxmeel/56c5f18b229ca1e61feb6eb5fb149f43/raw/githubSource.svg
[badges/npm]: https://raw.githubusercontent.com/gist/cxmeel/56c5f18b229ca1e61feb6eb5fb149f43/raw/npm.svg
[badges/roblox]: https://raw.githubusercontent.com/gist/cxmeel/56c5f18b229ca1e61feb6eb5fb149f43/raw/roblox.svg

# Sift

<div align="center">

[![Source code][badges/github]][sift] [![NPM Package][badges/npm]][sift/npm] [![Itch.io store page][badges/itch]][sift/itch.io] [![Roblox library][badges/roblox]][sift/roblox]
[![Source code][badges/github]][sift] [![NPM Package][badges/npm]][sift/npm] [![Roblox library][badges/roblox]][sift/roblox]

[![Latest GitHub version][shields/github-release]][sift/releases] [![Latest Wally version][shields/wally]][sift/wally] [![Latest NPM version][shields/npm]][sift/npm]

Expand All @@ -41,7 +39,7 @@ Heavily based on [@freddylist's Llama][freddylist/llama] library, which is no lo

## Documentation

Documentation, powered by [moonwave][upliftgames/moonwave], is available at https://csqrl.github.io/sift.
Documentation, powered by [@evaera's moonwave][evaera/moonwave], is available at [here][sift/documentation].

## v0.x

Expand All @@ -54,31 +52,31 @@ This will remain the same until v1.x.

## Quick Start

Sift is available from [Wally][sift/wally], [Itch.io][sift/itch.io], the [Roblox Library][sift/roblox], and [GitHub releases][sift/releases].
Sift is available from [Wally][sift/wally], the [Roblox Library][sift/roblox], and [GitHub releases][sift/releases].

While Sift is 100% free and open source, if you feel like sponsoring, Sift is also available on [Itch.io][sift/itch.io].
While Sift is 100% free and open source, if you feel like sponsoring, you can support us on [GitHub Sponsors](https://github.com/sponsors/cxmeel).

### Wally

Wally is a CLI package manager (much like NPM, Yarn or Cargo) for Roblox by @UpliftGames. Find out more at https://github.com/upliftgames/wally.
Wally is a CLI package manager (much like NPM, Yarn or Cargo) for Roblox by @UpliftGames. Find out more at [here][upliftgames/wally].

```toml
# wally.toml

[dependencies]
Sift = "csqrl/[email protected]" # Replace with current version number
Sift = "csqrl/[email protected]" # Replace with latest version number
```

```shell
$ wally install
wally install
```

### TypeScript

v0.0.1 of Sift includes TypeScript typings. This means Sift is now compatible with roblox-ts. Refer to the Luau docs for API details.

```shell
$ npm install @rbxts/sift
npm install @rbxts/sift
```

```ts
Expand All @@ -96,10 +94,10 @@ Grab a copy [from the Roblox Library][sift/roblox] or [GitHub releases][sift/rel

As per the recommendations in [Llama's README][freddylist/llama], the following changes have been made:

- Sift utilises native Luau types. Llama used [@osyrisrblx/t][osyrisrblx/t] for type checking, which meant that types were only checked at runtime.
- Sift utilizes native Luau types. Llama used [@osyrisrblx/t][osyrisrblx/t] for type checking, which meant that types were only checked at runtime.
- Sift _will not_ check types at runtime. If you're using the library wrong, you'll get errors at runtime anyway!
- Organised tests. `*.spec` files are now alongside their source files, making it easier to locate them.
- Documentation is now generated using [@upliftgames' moonwave][upliftgames/moonwave] (Docusaurus). This makes it quick and easy to add new documentation, and provides a pleasant experience for the user.
- Organized tests. `*.spec` files are now alongside their source files, making it easier to locate them.
- Documentation is now generated using [@evaera's moonwave][evaera/moonwave] (Docusaurus). This makes it quick and easy to add new documentation, and provides a pleasant experience for the user.
- Built-in TypeScript typings.

## What's New?
Expand Down
19 changes: 9 additions & 10 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,37 @@ sidebar_position: 2

<!-- Links -->

[sift]: https://github.com/csqrl/sift
[sift/releases]: https://github.com/csqrl/sift/releases
[upliftgames/wally]: https://github.com/upliftgames/wally
[sift/releases]: https://github.com/cxmeel/sift/releases
[sift/wally]: https://wally.run/package/csqrl/sift
[sift/roblox]: https://www.roblox.com/library/9486684823
[sift/itch.io]: https://csqrl.itch.io/sift
[sift/roblox]: https://create.roblox.com/store/asset/9486684823/Sift
[sift/npm]: https://npmjs.com/package/@rbxts/sift

Sift is available from [Wally][sift/wally], [Itch.io][sift/itch.io], the [Roblox Library][sift/roblox], and [GitHub releases][sift/releases].
Sift is available from [Wally][sift/wally], the [Roblox Library][sift/roblox], and [GitHub releases][sift/releases].

While Sift is 100% free and open source, if you feel like sponsoring, Sift is also available on [Itch.io][sift/itch.io].
While Sift is 100% free and open source, if you feel like sponsoring, you can support us on [GitHub Sponsors](https://github.com/sponsors/cxmeel).

### Wally

Wally is a CLI package manager (much like NPM, Yarn or Cargo) for Roblox by @UpliftGames. Find out more at https://github.com/upliftgames/wally.
Wally is a CLI package manager (much like NPM, Yarn or Cargo) for Roblox by @UpliftGames. Find out more at [here][upliftgames/wally].

```toml
# wally.toml

[dependencies]
Sift = "csqrl/sift@=0.0.1"
Sift = "csqrl/[email protected].X" # Replace with latest version number
```

```shell
$ wally install
wally install
```

### TypeScript

v0.0.1 of Sift includes TypeScript definitions. This means Sift is now compatible with roblox-ts. Refer to the Luau docs for API details.

```shell
$ npm install @rbxts/sift
npm install @rbxts/sift
```

[View on NPM &rarr;][sift/npm]
Expand Down
2 changes: 1 addition & 1 deletion moonwave.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ includeReadme = true

[[navbar.items]]
label = "Sponsor"
href = "https://github.com/sponsors/csqrl"
href = "https://github.com/sponsors/cxmeel"
position = "right"

[docusaurus.themeConfig.colorMode]
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/csqrl/sift.git"
"url": "git+https://github.com/cxmeel/sift.git"
},
"keywords": [
"array",
Expand All @@ -28,9 +28,9 @@
],
"license": "MIT",
"bugs": {
"url": "https://github.com/csqrl/sift/issues"
"url": "https://github.com/cxmeel/sift/issues"
},
"homepage": "https://csqrl.github.io/sift",
"homepage": "https://cxmeel.github.io/sift",
"files": [
"out",
"!**/*.tsbuildinfo"
Expand Down
Loading