Skip to content

Commit 98759bb

Browse files
vitokevitoke
committed
Migrate to GitHub
0 parents  commit 98759bb

File tree

635 files changed

+78882
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

635 files changed

+78882
-0
lines changed

‎.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: vitoke

‎.github/ISSUE_TEMPLATE.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<!--
2+
HOLD UP PLEASE, BEFORE DELETING THIS TEMPLATE!
3+
4+
Thank you for contributing and please follow this guide before creating an issue!
5+
6+
1. Do you have a usage question?
7+
=============================
8+
- Look for prior or closed issues (but please avoid replying to them if they're old)
9+
- Check the docs
10+
- Look for/ask questions in the Github Discussions section
11+
12+
2. Think you found a bug?
13+
=============================
14+
- Consider submitting a PR with a failing test instead
15+
- Don't forget to provide a reproduction (Codesandbox links are provided and most useful, repositories are ok)
16+
- If you can't provide a reproduction, snippets of code can help, but are incomplete reports
17+
18+
3. Do you have a feature request?
19+
=============================
20+
- Look for old & closed issues (replying might be ok if they're not too old or have no conclusion)
21+
- Consider first starting a discussion in the Discussions section
22+
- Otherwise: Remove the template below and provide thoughtful commentary *and code samples* on what this feature means for your product
23+
24+
What will it allow you to do that you can't do today?
25+
How will it make current work-arounds straightforward?
26+
What potential bugs and edge cases does it help to avoid?
27+
Please keep it product-centric.
28+
29+
This template was adapted from the styled-components issue template:
30+
https://github.com/styled-components/styled-components/blob/main/.github/ISSUE_TEMPLATE.md
31+
-->
32+
33+
<!-- TEMPLATE -->
34+
35+
## Environment
36+
37+
<!-- Please specify how you run your code:
38+
- OS: e.g. win/mac/linux
39+
- runtime: e.g. Node 15.12.0 / Firefox 88.0.1
40+
-->
41+
42+
## Reproduction
43+
44+
<!--
45+
Consider creating a Codesandbox and supplying the link.
46+
If you can't reproduce your bug, make sure to add details on how you've set up your project
47+
-->
48+
49+
## Steps to reproduce
50+
51+
<!--
52+
If not immediately clear from the Reproduction step, describe how to reproduce the issue.
53+
e.g.
54+
1. Check out <this> repository
55+
2. Run `yarn` and then `yarn build`
56+
-->
57+
58+
## Expected Behavior
59+
60+
<!--
61+
Describe what you expect to happen, e.g:
62+
The project compiles succesfully
63+
-->
64+
65+
## Actual Behavior
66+
67+
<!--
68+
Describe what actually happens, e.g:
69+
The compiler fails with error: 'unknown[] cannot be assigned to string[]'
70+
71+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Fixes #issue_nr
2+
3+
### All Submissions:
4+
5+
- [ ] Have you followed the guidelines in our Contributing document?
6+
- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
7+
8+
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
9+
10+
### New Feature Submissions:
11+
12+
1. [ ] Does your submission pass tests?
13+
2. [ ] Have you lint and formatted your code locally prior to submission?
14+
15+
### Changes to Core Features:
16+
17+
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
18+
- [ ] Have you written new tests for your core changes, as applicable?
19+
- [ ] Have you successfully ran tests with your changes locally?

‎.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
node_modules
2+
/lib
3+
/temp
4+
5+
.vscode
6+
coverage
7+
8+
benchmark
9+
10+
yarn-error.log

‎.prettierrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./config/.prettierrc');

‎CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
<[email protected]>.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to Rimbu
2+
3+
We want to make contributing to this project as easy and transparent as
4+
possible.
5+
6+
Be sure to read our [Code of Conduct](./CODE_OF_CONDUCT.md)
7+
8+
## Our Development Process
9+
10+
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
11+
12+
As development process we use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests.
13+
14+
Pull requests are the only way to propose changes to the codebase. We actively welcome your pull requests.
15+
16+
## Pull Requests
17+
18+
We actively welcome your pull requests.
19+
20+
1. Fork the repo and create your branch from `main`.
21+
2. If you've added code that should be tested, add tests.
22+
3. If you've changed APIs, update the documentation.
23+
4. Ensure the test suite passes.
24+
5. Make sure your code lints.
25+
26+
## Issues
27+
28+
We use GitHub issues to track bugs. Before submitting an issue, please search the existing issues to see if the issue has already been reported.
29+
30+
Please don't use the issues board to ask questions, for this you can use the TODO:Gitter channel.
31+
32+
Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
33+
34+
## Coding Style
35+
36+
The project is pre-configured with `prettier` and `eslint` configurations, please make sure your code adheres to this configuration by running:
37+
38+
- `yarn lint`
39+
- `yarn format`
40+
41+
## License
42+
43+
By contributing to Rimbu, you agree that your contributions will be licensed under its MIT license.
44+
45+
## References
46+
47+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md)

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Arvid Nicolaas
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<p align="center">
2+
<img src="assets/rimbu_logo.svg" />
3+
</p>
4+
5+
# Immutable collections and tools for TypeScript
6+
7+
Rimbu consists of TypeScript projects focused on immutability. This is the monorepo for all Rimbu projects.
8+
9+
For complete documentation please visit the _[Rimbu Docs](http://rimbu.org)_.
10+
11+
The main projects are:
12+
13+
| Name | Description |
14+
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| [@rimbu/core](packages/core) | Immutable collections including `List`, `SortedMap`, `EdgeGraph`, `HashBiMultiMap` and many more. |
16+
| [@rimbu/deep](packages/deep) | Utilities to define immutable views on plain JS objects, and to easily handle and manipulate (e.g. create changed copies) of those objects. |
17+
| [@rimbu/actor](packages/actor) | A framework-agnostic synchronous state management library that uses immutable objects under the hood. |
18+
| [@rimbu/reactor](packages/reactor) | A framework that allows usage of `@rimbu/actor` objects in `React`. |
19+
20+
## Getting started with this monorepo
21+
22+
1. Clone this repository
23+
2. Run `yarn setup`
24+
25+
To build all the packages: `yarn build`
26+
To start the Rimbu Docs locally: `yarn docsify`
27+
28+
## Author
29+
30+
[Arvid Nicolaas](https://github.com/vitoke)
31+
32+
## Contributing
33+
34+
Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](/CONTRIBUTING.md).
35+
36+
## Contributors
37+
38+
<img src = "https://contrib.rocks/image?repo=vitoke/iternal"/>
39+
40+
Made with [contributors-img](https://contrib.rocks).
41+
42+
## License
43+
44+
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
45+
46+
See [LICENSE](./LICENSE) for more information.

‎SUPPORT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Support for Rimbu
2+
3+
Thanks for using Rimbu in your project. We have various methods available to provide support if you run into any issues or if you have questions.
4+
5+
## Documentation
6+
7+
First please make sure that the information is not already in the [Rimbu documentation](http://rimbu.org)
8+
9+
## Questions or ideas
10+
11+
For questions or ideas, please use our [Github Discussions board](github.com/vitoke/rimbu/discussions). Before posting a question, please search first to see if the question has not been asked before.
12+
13+
## Bugs and issues
14+
15+
If you run into a bug or issue, please use [Github Issues](github.com/vitoke/rimbu/issues). Before creating an issue, please search first to see if the issue has not been raised before. Please do not create issues for questions or ideas, those belong in [Github Discussions](github.com/vitoke/rimbu/discussions)

‎assets/rimbu_logo.svg

Lines changed: 25 additions & 0 deletions
Loading

‎assets/trees.jpeg

5.38 MB
Loading

0 commit comments

Comments
 (0)