feat: color module (#801)

Co-authored-by: Shinigami <chrissi92@hotmail.de>

Author: harsohailB

docs/.vitepress/api-pages.ts

@@ -3,6 +3,7 @@
 export const apiPages = [
   { text: 'Address', link: '/api/address.html' },
   { text: 'Animal', link: '/api/animal.html' },
+  { text: 'Color', link: '/api/color.html' },
   { text: 'Commerce', link: '/api/commerce.html' },
   { text: 'Company', link: '/api/company.html' },
   { text: 'Database', link: '/api/database.html' },

scripts/generateLocales.ts

@@ -47,6 +47,7 @@ type DefinitionsType = {
 const definitionsTypes: DefinitionsType = {
   address: 'AddressDefinitions',
   animal: 'AnimalDefinitions',
+  color: 'ColorDefinitions',
   commerce: 'CommerceDefinitions',
   company: 'CompanyDefinitions',
   database: 'DatabaseDefinitions',

src/definitions/color.ts

@@ -0,0 +1,15 @@
+import type { LocaleEntry } from './definitions';
+
+/**
+ * The possible definitions related to color.
+ */
+export type ColorDefinitions = LocaleEntry<{
+  /**
+   * Human readable color names
+   */
+  human: string[];
+  /**
+   * Color space names.
+   */
+  space: string[];
+}>;

src/definitions/commerce.ts

@@ -4,10 +4,6 @@ import type { LocaleEntry } from './definitions';
  * The possible definitions related to commerce.
  */
 export type CommerceDefinitions = LocaleEntry<{
-  /**
-   * Human readable color names
-   */
-  color: string[];
   /**
    * Department names inside a shop.
    */

src/definitions/definitions.ts

@@ -1,5 +1,6 @@
 import type { AddressDefinitions } from './address';
 import type { AnimalDefinitions } from './animal';
+import type { ColorDefinitions } from './color';
 import type { CommerceDefinitions } from './commerce';
 import type { CompanyDefinitions } from './company';
 import type { DatabaseDefinitions } from './database';
@@ -26,6 +27,7 @@ export type LocaleEntry<T> = Partial<T> &
 export interface Definitions {
   address: AddressDefinitions;
   animal: AnimalDefinitions;
+  color: ColorDefinitions;
   commerce: CommerceDefinitions;
   company: CompanyDefinitions;
   database: DatabaseDefinitions;

src/definitions/index.ts

@@ -1,5 +1,6 @@
 export type { AddressDefinitions } from './address';
 export type { AnimalDefinitions } from './animal';
+export type { ColorDefinitions } from './color';
 export type {
   CommerceDefinitions,
   CommerceProductNameDefinitions,

src/faker.ts

@@ -3,6 +3,7 @@ import { FakerError } from './errors/faker-error';
 import type { KnownLocale } from './locales';
 import { Address } from './modules/address';
 import { Animal } from './modules/animal';
+import { Color } from './modules/color';
 import { Commerce } from './modules/commerce';
 import { Company } from './modules/company';
 import { Database } from './modules/database';
@@ -60,6 +61,7 @@ export class Faker {
 
   readonly address: Address = new Address(this);
   readonly animal: Animal = new Animal(this);
+  readonly color: Color = new Color(this);
   readonly commerce: Commerce = new Commerce(this);
   readonly company: Company = new Company(this);
   readonly database: Database = new Database(this);

src/index.ts

@@ -4,6 +4,7 @@ import allLocales from './locales';
 export type {
   AddressDefinitions,
   AnimalDefinitions,
+  ColorDefinitions,
   CommerceDefinitions,
   CommerceProductNameDefinitions,
   CompanyDefinitions,
@@ -27,6 +28,14 @@ export type {
 } from './definitions';
 export { FakerError } from './errors/faker-error';
 export type { FakerOptions, UsableLocale, UsedLocales } from './faker';
+export type {
+  Casing,
+  ColorFormat,
+  CSSFunction,
+  CSSSpace,
+  NumberColorFormat,
+  StringColorFormat,
+} from './modules/color';
 export { Gender } from './modules/name';
 export type { GenderType } from './modules/name';
 export { Faker };

src/locales/ar/commerce/color.ts src/locales/ar/color/human.tssrc/locales/ar/commerce/color.ts renamed to src/locales/ar/color/human.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { ColorDefinitions } from '../../..';
+import human from './human';
+
+const color: ColorDefinitions = {
+  human,
+};
+
+export default color;