Merge pull request #104 from prjctimg/dev

Patch update for v1.7.87

.eslintignore

@@ -1,4 +1,3 @@
-node_modules
-dist
 *.js
-*.cjs
+*.cjs
+

.gitignore

@@ -5,6 +5,9 @@
 /.pnp
 .pnp.js
 
+lodash-main
+lessons-learnt-from-my-first-open-source-project.md
+emoji.md
 # testing
 /temp
 /color-thief
@@ -13,10 +16,10 @@
 # next.js
 /.next/
 /out/
-
+source/lib
 # production
 /build
-/dist
+lib
 
 # misc
 .DS_Store
@@ -40,5 +43,9 @@ debug.log
 next-env.d.ts
 /_site
 
+
+
 app.js
-*.code-worspace
+*.code-worspace
+/leonardo-main
+source/lib

.husky/pre-commit

@@ -1,5 +1,7 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
+git add . && npm run lint
+
 
 

.husky/pre-push

@@ -2,4 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 # We cant push code that doesn't build.
- npm run lint && npm run format 
+ npm test && npm run format

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "MD013": false,
+  "MD001": false,
+  "MD0026": true,
+  "MD0009": false
+}

CHANGELOG.md

@@ -36,7 +36,8 @@ Changed docs to docsify
 
 - Fully treeshakable
 - Core-utils directory was split to submodules.
-- Added the `load()` to create read-manipulate-output chains like the one presented by the `chroma()` constructor in chroma-js
+- Added the `load()` utility to create read-manipulate-output chain with all the utilities that take a collection of colos as first input. The chain is lazy.
+- Added the Color class which is aliased as `color()` which has all the utilities that take a color as the first argument bound to its prototype as methods. Calling color() simply calls `new IColor()` under the hood.
 - Added the `toHex` utility which parses all known color tokens similar to chroma-js
 - Eliminated dependancy on lodash.
 - Used treeshaken Culori modules to reduce bundle size. Only 20KB when minified!
@@ -47,8 +48,9 @@ Over 50 utilities in the API now!
 - All palette functions have easings for internal computations
 Updated the docs!
 - Improved the accuracy of temperature based utilities.
+- Rewrote the type declarations to make them simpler and more generic.
 - All palette functions now take an optional overrides object to fine tune parameters like easing methods, fixups etc.
-- Added introduction guides to help users understand the project
+- Temperature utilities are marked as experiental until a more effecient way of predicting color temperature is discovered
 - Rewrote the README and CONTRIBUTING. Added missing licenses for borrowed code.
-Special thanks to our [contributors!]()
+
 

LICENSE.md

@@ -1,17 +1,4 @@
-   Copyright (c) 2023
-   huetiful-js    Javascript library for general purpose color manipulations
-   Dean Tarisai and contributors 
 
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.  
-
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -200,94 +187,18 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
+          (c) 2023 Dean Tarisai
+              huetiful-js
+           -> Open source TypeScript library for general purpose color manipulations.
 
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
-   Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
-
-Based on Underscore.js, copyright Jeremy Ashkenas,
-DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
-
-This software consists of voluntary contributions made by many
-individuals. For exact contribution history, see the revision history
-available at https://github.com/lodash/lodash
-
-The following license applies to all parts of this software except as
-documented below:
-
-====
-
-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.
-
-====
-
-Copyright and related rights for sample code are waived via CC0. Sample
-code is defined as all source code displayed within the prose of the
-documentation.
-
-CC0: http://creativecommons.org/publicdomain/zero/1.0/
+       http://www.apache.org/licenses/LICENSE-2.0
 
-====
-
-Files located in the node_modules and vendor directories are externally
-maintained libraries used by this software which have their own
-licenses; we recommend you read them, as their terms may differ from the
-terms above.
-
-
-MIT License
-
-Copyright (c) 2018 Dan Burzo
-Culori - JavaScript library for general purpose color manipulations.
-
-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.
-
-
-/**
-    ColorBrewer colors for chroma.js
-
-    Copyright (c) 2002 Cynthia Brewer, Mark Harrower, and The
-    Pennsylvania State University.
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-    http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software distributed
-    under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-    CONDITIONS OF ANY KIND, either express or implied. See the License for the
-    specific language governing permissions and limitations under the License.
-*/
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.