feat: color module (#801)

Co-authored-by: Shinigami <[email protected]>

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/color/index.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;

src/locales/ar/commerce/index.ts

@@ -3,12 +3,10 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_name,
 };

src/locales/ar/index.ts

@@ -5,6 +5,7 @@
 import type { LocaleDefinition } from '../..';
 import address from './address';
 import cell_phone from './cell_phone';
+import color from './color';
 import commerce from './commerce';
 import date from './date';
 import name_ from './name';
@@ -17,6 +18,7 @@ const ar: LocaleDefinition = {
   separator: ' & ',
   address,
   cell_phone,
+  color,
   commerce,
   date,
   name: name_,

src/locales/az/color/index.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;

src/locales/az/commerce/index.ts

@@ -3,12 +3,10 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_name,
 };

src/locales/az/index.ts

@@ -4,6 +4,7 @@
  */
 import type { LocaleDefinition } from '../..';
 import address from './address';
+import color from './color';
 import commerce from './commerce';
 import company from './company';
 import date from './date';
@@ -15,6 +16,7 @@ const az: LocaleDefinition = {
   title: 'Azerbaijani',
   separator: ' və ',
   address,
+  color,
   commerce,
   company,
   date,

src/locales/el/color/index.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;

src/locales/el/commerce/index.ts

@@ -3,12 +3,10 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_name,
 };

src/locales/el/index.ts

@@ -7,6 +7,7 @@ import address from './address';
 import app from './app';
 import business from './business';
 import cell_phone from './cell_phone';
+import color from './color';
 import commerce from './commerce';
 import company from './company';
 import finance from './finance';
@@ -24,6 +25,7 @@ const el: LocaleDefinition = {
   app,
   business,
   cell_phone,
+  color,
   commerce,
   company,
   finance,

src/locales/en/color/index.ts

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

src/locales/en/color/space.ts

@@ -0,0 +1,43 @@
+export default [
+  'CIE 1931 XYZ',
+  'CIEUVW',
+  'Uniform Color Spaces (UCSs)',
+  'CIELUV',
+  'CIELAB',
+  'HSLuv',
+  'sRGB',
+  'Adobe RGB',
+  'Adobe Wide Gamut RGB',
+  'Rec. 2100',
+  'ProPhoto RGB Color Space',
+  'scRGB',
+  'DCI-P3',
+  'Display-P3',
+  'Rec. 601',
+  'Rec. 709',
+  'Academy Color Encoding System (ACES)',
+  'Rec. 2020',
+  'YPbPr',
+  'YDbDr',
+  'YIQ',
+  'xvYCC',
+  'sYCC',
+  'HSV',
+  'HSL',
+  'HWB',
+  'RGBA',
+  'HSLA',
+  'LCh',
+  'CMY',
+  'CMYK',
+  'Munsell Color System',
+  'Natural Color System (NSC)',
+  'Pantone Matching System (PMS)',
+  'RAL',
+  'Federal Standard 595C',
+  'British Standard Colour (BS)',
+  'HKS',
+  'LMS',
+  'RG',
+  'RGK',
+];

src/locales/en/commerce/index.ts

@@ -3,13 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_description from './product_description';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_description,
   product_name,

src/locales/en/index.ts

@@ -8,6 +8,7 @@ import animal from './animal';
 import app from './app';
 import business from './business';
 import cell_phone from './cell_phone';
+import color from './color';
 import commerce from './commerce';
 import company from './company';
 import database from './database';
@@ -32,6 +33,7 @@ const en: LocaleDefinition = {
   app,
   business,
   cell_phone,
+  color,
   commerce,
   company,
   database,

src/locales/es/color/index.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;

src/locales/es/commerce/index.ts

@@ -3,12 +3,10 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_name,
 };

src/locales/es/index.ts

@@ -5,6 +5,7 @@
 import type { LocaleDefinition } from '../..';
 import address from './address';
 import cell_phone from './cell_phone';
+import color from './color';
 import commerce from './commerce';
 import company from './company';
 import internet from './internet';
@@ -15,6 +16,7 @@ const es: LocaleDefinition = {
   title: 'Spanish',
   address,
   cell_phone,
+  color,
   commerce,
   company,
   internet,

src/locales/es_MX/color/index.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;

src/locales/es_MX/commerce/index.ts

@@ -3,12 +3,10 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { CommerceDefinitions } from '../../..';
-import color from './color';
 import department from './department';
 import product_name from './product_name';
 
 const commerce: CommerceDefinitions = {
-  color,
   department,
   product_name,
 };