Skip to content

Commit

Permalink
docs(sandbox): add license, repo url, modify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake Lauer authored and Jake Lauer committed Jul 24, 2024
1 parent 161d472 commit 20d8ce4
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 21 deletions.
27 changes: 11 additions & 16 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
MIT License

Copyright (c) [year] [fullname]
Copyright (c) 2024 Jake Lauer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
16 changes: 16 additions & 0 deletions packages/sandbox/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
MIT License

Copyright (c) 2024 Jake Lauer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12 changes: 10 additions & 2 deletions packages/sandbox/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Overview
# theseus-sandbox

Theseus Sandbox provides a unique approach to immutability that allows objects to be made immutable while still
<sup>Part of [`theseus-js`](https://github.com/jakelauer/theseus-js).</sup>

![build](https://github.com/jakelauer/theseus-js/actions/workflows/build.yml/badge.svg?branch=main)
![test](https://github.com/jakelauer/theseus-js/actions/workflows/test.yml/badge.svg?branch=main)

<a href="https://www.npmjs.com/package/theseus-sandbox"><img src="https://badgen.net/npm/v/theseus-sandbox?color=red" alt="npm version" height="18"></a>
<img src="https://badgen.net/github/license/jakelauer/theseus-sandbox" alt="npm version" height="18">

`theseus-sandbox` provides a unique approach to immutability that allows objects to be made immutable while still
permitting controlled modifications. Unlike other immutability libraries like [Immer](https://immerjs.github.io/immer/),
which freeze objects irreversibly, or [Immutable.js](https://immutable-js.com/), which replaces native functionality
with immutable replacements, Theseus Sandbox uses a combination of `frost`, `sandbox`, and `cement` to achieve
Expand Down
6 changes: 5 additions & 1 deletion packages/sandbox/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
{
"name": "theseus-sandbox",
"version": "6.0.1",
"description": "",
"description": "A flexible immutability library for controlled object modifications using frost, sandbox, and cement concepts.",
"main": "dist/index.cjs",
"module": "dist/index.js",
"type": "module",
"repository": {
"url": "https://github.com/jakelauer/theseus-js/tree/main/packages/sandbox",
"type": "git"
},
"scripts": {
"build": "tsup",
"test": "vitest run",
Expand Down
2 changes: 0 additions & 2 deletions src/lib/Evolvers/EvolverComplex.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ export const generateEvolveMethods = <
{
const mutators = macro ? evolver.evolve(input).getMutators() : evolver.mutate(input).getMutators();

console.log(evolver.evolverName);

(acc as Record<string, any>)[evolver.evolverName] = mutators;

return acc;
Expand Down

0 comments on commit 20d8ce4

Please sign in to comment.