Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lionad-morotar/anysort
Anysort，符合直觉的多属性排序方法，类型完备，Flexible and Full Typed multi-properties sorter for nested objects
https://github.com/lionad-morotar/anysort
anysort attributes-sort multi-attribute multi-index multi-sort nested-objects sort stable-sort
Last synced: 24 days ago
JSON representation
Anysort，符合直觉的多属性排序方法，类型完备，Flexible and Full Typed multi-properties sorter for nested objects
- Host: GitHub
- URL: https://github.com/lionad-morotar/anysort
- Owner: Lionad-Morotar
- License: mit
- Created: 2022-07-11T09:56:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T13:16:25.000Z (4 months ago)
- Last Synced: 2024-10-26T13:04:58.256Z (25 days ago)
- Topics: anysort, attributes-sort, multi-attribute, multi-index, multi-sort, nested-objects, sort, stable-sort
- Language: JavaScript
- Homepage:
- Size: 521 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Anysort
Anysort：符合直觉、类型完备的多属性排序方法
## Why Anysort
A picture is worth a thousand words.
project moved from [Lionad-Morotar/anysort-old](https://github.com/Lionad-Morotar/any-sort-old)
## Install
```sh
npm install --save anysort-typed
```
## Why Anysort
* Anysort can sort with multi-attributes
```js
// select articles which has 'it' tag, put ahead,
// then move articles which status is 'editing' at the beginning
anysort(articles)
.tag.has('it')
.status.is('editing')
.map(print)
```
* Intuitive
```js
// Array.prototype.sort: what hell the result is!
[].sort.apply([0, '0', 1, 'd', '1', '0', 0, ''])
// ['', 0, '0', '0', 0, 1, '1', 'd']
// Anysort：the result is intuitive
anysort([0, '0', 1, undefined, 'd', '1', '0', null, 0, '', undefined])
// [0, 0, 1, '', '0', '0', '1', 'd']
```
* Flexible API
```js
// proxy chain api
anysort(articles).created.date.reverse()
// or
anysort(articles, 'created.date-reverse()')
```
* Full typed, even in call-with-string-mode, **AMAZING**!
```js
// @ts-expect-error
anysort(articles).tag.hass('it')
// @ts-expect-error
anysort(articles, 'created.date-unknownPlugin()')
// OK!
anysort(articles).created.date.reverse()
// OK!
anysort(articles, 'created.date-reverse()')
// @ts-expect-error
anysort(articles).created.date.reverse(123)
// @ts-expect-error
anysort(articles, 'created.date-reverse(123)')
```
* Zero dependencies（minified + gzip ≈ 3KB）
* Well tested, logic and type
* WIP: Full API document, help wanted
* WIP: Benchmark, help wanted
## Usage
Short instruction。
```js
const posts = getPosts()
const print = (x) => console.log(JSON.stringify(x))
// select articles being edited with IT tags,
// sorted by date in reverse order and time in positive order
anysort(posts, [
'status-is(editing)',
'tag-has(it)',
'created.date-reverse()',
'created.hour'
]).map(print)
// {"tag":["it"],"status":"editing","created":{"date":"2021-01-02T00:00:00.000Z","hour":23}}
// {"tag":["it"],"status":"editing","created":{"date":"2021-01-01T00:00:00.000Z","hour":16}}
// {"tag":["game","it"],"status":"editing","created":{"date":"2021-01-01T00:00:00.000Z","hour":23}}
// {"tag":["mp3"],"status":"","created":{"date":"2019-08-01T00:00:00.000Z","hour":23}}
// sick of using string manipulation?
// try this!
anysort(getPosts())
.created.hour.result()
.created.date.reverse()
.tag.has('it')
.status.is('editing')
.map(print)
// {"tag":["it"],"status":"editing","created":{"date":"2021-01-02T00:00:00.000Z","hour":23}}
// {"tag":["it"],"status":"editing","created":{"date":"2021-01-01T00:00:00.000Z","hour":16}}
// {"tag":["game","it"],"status":"editing","created":{"date":"2021-01-01T00:00:00.000Z","hour":23}}
// {"tag":["mp3"],"status":"","created":{"date":"2019-08-01T00:00:00.000Z","hour":23}}
function getPosts () {
return [
{
tag: ['mp3'],
status: '',
created: {
date: new Date('2019-08-01'),
hour: 23
}
},
{
tag: ['game', 'it'],
status: 'editing',
created: {
date: new Date('2021-01-01'),
hour: 23
}
},
{
tag: ['it'],
status: 'editing',
created: {
date: new Date('2021-01-01'),
hour: 16
}
},
{
tag: ['it'],
status: 'editing',
created: {
date: new Date('2021-01-02'),
hour: 23
}
}
]
}
```
## Full API Doc
TODO
## Change Log
See [ChangeLog.md](./CHANGELOG.md)
## Dev & Test
```sh
# run test when files change in directory build
npm run watch:test
# modify source code then build
npm run build
```
## How this work
[《🌐 Anysort：灵活、优雅的多属性排序》](https://lionad.art/articles/anysort-2th)
## Pull & Request
See [TODO.MD](./TODO.md)，help wanted!
## Related Projects
* [sort-by](https://github.com/kvnneff/sort-by)
* [array-sort](https://github.com/jonschlinkert/array-sort)
* [sort-on](https://github.com/sindresorhus/sort-on)
* [...](https://github.com/search?q=property+sort&type=Repositories)
## License
Copyright © 2021, [Lionad-Morotar](https://github.com/Lionad-Morotar).
Released under the MIT License.