color-2-name 1.3.1 → 1.3.2

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [private contact addresses](https://github.com/dec0dOS/amazing-github-template#support). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

package/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

package/biome.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.7.0/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	}
+}

package/lib/@types/color-utils.d.ts

@@ -1,4 +1,4 @@
-import { RGBCOLORDEF } from "./types";
+import type { RGBCOLORDEF } from "./types";
 /**
  * This function was the opposite of the name of the repo and returns the color of the colorSet given the name
  *
@@ -10,6 +10,9 @@ export declare function getColor(searchedColor: string, set?: RGBCOLORDEF[] | un
     rgb: string;
     hsl: string;
 };
+/**
+ * Get all the colors from the colorSet
+ */
 export declare function getColors(): {
     hex: string;
     rgb: string;

package/lib/@types/common.d.ts

@@ -1,4 +1,4 @@
-import { RGBCOLORDEF } from "./types";
+import type { RGBCOLORDEF } from "./types";
 /** The maximum distance possible between colors */
 export declare const MAXDISTANCE = 441.6729559300637;
 /** A regex to match hex colors */
@@ -83,11 +83,11 @@ export declare function colorValueFallbacks(value: string, err?: string): number
 /**
  * Takes a string with a css value that could be a number or percentage or an angle in degrees and returns the corresponding 8bit value
  *
- * @param {string} value - a valid value for the css color definition (like 255, "100%", "324deg", etc.) *
+ * @param value - a valid value for the css color definition (like 255, "100%", "324deg", etc.) *
  * @param multiplier - the number that represent the maximum - default is 255 decimal - 100 hex
  *
  * @example convertToInt8('100%'); // 255
  *
  * @return {string} the corresponding value in 8-bit format
  */
-export declare function convertToInt8(value: string, multiplier?: number): number;
+export declare function convertToInt8(value: string | unknown, multiplier?: number): number;

package/lib/@types/hex-utils.d.ts

@@ -1,4 +1,4 @@
-import { COLORSTRING, HEX, RGBVALUE } from "./types";
+import type { COLORSTRING, HEX, RGBVALUE } from "./types";
 /**
  * It returns an object with the hex values of the 3 digit hex color
  *

package/lib/@types/hsl-utils.d.ts

@@ -1,4 +1,4 @@
-import { HSLVALUE, RGBVALUE } from "./types";
+import type { HSLVALUE, RGBVALUE } from "./types";
 export declare function fallbackHSL(hsl: string[], err?: string): string[];
 /**
  * Get the values of the hsl string

package/lib/@types/index.d.ts

@@ -1,5 +1,6 @@
-import type { COLORDEF, COLORSTRING, HEX, RGBCOLORDEF, RGBVALUE } from "./types";
 import { getColor, getColors } from "./color-utils";
+import type { COLORDEF, COLORSTRING, ColorParsers, HEX, RGBCOLORDEF, RGBVALUE } from "./types";
+export declare const colorParsers: ColorParsers[];
 /**
  * Given a color string, it returns the closest corresponding name of the color.
  * Uses the Euclidean distance formula to calculate the distance between colors in the RGB color space.
@@ -19,6 +20,16 @@ import { getColor, getColors } from "./color-utils";
 declare function closest(color: string | COLORSTRING, set?: RGBCOLORDEF[] | undefined, args?: {
     info?: boolean;
 }): COLORDEF;
+/**
+ * This function takes a string representing a color (color) and uses regular expressions to check if it matches any of the following formats: hex, hex+alpha, RGB, RGBA, HSL, or HSLA.
+ * If the color string matches one of these formats, the function returns an object with the type of color and the value of the color.
+ * If the color string does not match any of the formats, the function throws an error.
+ *
+ * @param {string} colorString - the color string to test and convert to rgb values
+ *
+ * @return {Object|Error} the object with rgb values of that color
+ */
+export declare function parseColor(colorString: string): RGBVALUE;
 /**
  * Given a color returns if the color is light (by light is meant more mathematically closer to white)
  *
@@ -74,14 +85,4 @@ declare function distance(rgb1: [number, number, number], rgb2: [number, number,
  * @example rgbToHex("rgba(100% 0 0 / .5)"); // #FF0000
  */
 declare function rgbToHex(rgbString: string): HEX | Error;
-/**
- * This function takes a string representing a color (color) and uses regular expressions to check if it matches any of the following formats: hex, hex+alpha, RGB, RGBA, HSL, or HSLA.
- * If the color string matches one of these formats, the function returns an object with the type of color and the value of the color.
- * If the color string does not match any of the formats, the function throws an error.
- *
- * @param {string} colorString - the color string to test and convert to rgb values
- *
- * @return {Object|Error} the object with rgb values of that color
- */
-export declare function parseColor(colorString: string): RGBVALUE;
-export { closest, rgbToHex, distance, isLight, isDark, closestRGB, getColor, getColors };
+export { closest, rgbToHex, distance, isLight, isDark, closestRGB, getColor, getColors, };

package/lib/@types/rgb-utils.d.ts

@@ -1,4 +1,4 @@
-import { RGBVALUE } from "./types";
+import type { RGBVALUE } from "./types";
 export declare function fallbackRGB(rgb: string[], err?: string): string[];
 /**
  * Get the values of the rgb string

package/lib/@types/types.d.ts

@@ -31,6 +31,11 @@ export interface COLORDEF {
     hsl?: string;
     gap?: number;
 }
+export interface ColorParsers {
+    regex: RegExp;
+    parser: (color: string) => string[];
+    converter: (colorSet: string[]) => RGBVALUE;
+}
 export type colorListHEX = Array<{
     name: string;
     color: string;