feat: science module (#1014)

Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: pkuczynski <piotr.kuczynski@gmail.com>

docs/.vitepress/api-pages.ts

@@ -23,6 +23,7 @@ export const apiPages = [
   { text: 'Name', link: '/api/name.html' },
   { text: 'Phone', link: '/api/phone.html' },
   { text: 'Random', link: '/api/random.html' },
+  { text: 'Science', link: '/api/science.html' },
   { text: 'System', link: '/api/system.html' },
   { text: 'Unique', link: '/api/unique.html' },
   { text: 'Vehicle', link: '/api/vehicle.html' },

scripts/generateLocales.ts

@@ -59,6 +59,7 @@ const definitionsTypes: DefinitionsType = {
   music: 'MusicDefinitions',
   name: 'NameDefinitions',
   phone_number: 'PhoneNumberDefinitions',
+  science: 'ScienceDefinitions',
   system: 'SystemDefinitions',
   vehicle: 'VehicleDefinitions',
   word: 'WordDefinitions',

src/definitions/definitions.ts

@@ -12,6 +12,7 @@ import type { LoremDefinitions } from './lorem';
 import type { MusicDefinitions } from './music';
 import type { NameDefinitions } from './name';
 import type { PhoneNumberDefinitions } from './phone_number';
+import type { ScienceDefinitions } from './science';
 import type { SystemDefinitions } from './system';
 import type { VehicleDefinitions } from './vehicle';
 import type { WordDefinitions } from './word';
@@ -39,6 +40,7 @@ export interface Definitions {
   music: MusicDefinitions;
   name: NameDefinitions;
   phone_number: PhoneNumberDefinitions;
+  science: ScienceDefinitions;
   system: SystemDefinitions;
   vehicle: VehicleDefinitions;
   word: WordDefinitions;

src/definitions/index.ts

@@ -19,6 +19,7 @@ export type { LoremDefinitions } from './lorem';
 export type { MusicDefinitions } from './music';
 export type { NameDefinitions, NameTitleDefinitions } from './name';
 export type { PhoneNumberDefinitions } from './phone_number';
+export type { ScienceDefinitions } from './science';
 export type {
   SystemDefinitions,
   SystemMimeTypeEntryDefinitions,

src/definitions/science.ts

@@ -0,0 +1,16 @@
+import type { ChemicalElement, Unit } from '../modules/science';
+import type { LocaleEntry } from './definitions';
+
+/**
+ * The possible definitions related to science.
+ */
+export type ScienceDefinitions = LocaleEntry<{
+  /**
+   * Some science units.
+   */
+  unit: readonly Unit[];
+  /**
+   * Some periodic table element informtion.
+   */
+  chemicalElement: readonly ChemicalElement[];
+}>;

src/faker.ts

@@ -22,6 +22,7 @@ import { Music } from './modules/music';
 import { Name } from './modules/name';
 import { Phone } from './modules/phone';
 import { Random } from './modules/random';
+import { Science } from './modules/science';
 import { System } from './modules/system';
 import { Unique } from './modules/unique';
 import { Vehicle } from './modules/vehicle';
@@ -75,6 +76,7 @@ export class Faker {
   readonly music: Music = new Music(this);
   readonly name: Name = new Name(this);
   readonly phone: Phone = new Phone(this);
+  readonly science: Science = new Science(this);
   readonly system: System = new System(this);
   readonly vehicle: Vehicle = new Vehicle(this);
   readonly word: Word = new Word(this);

src/index.ts

@@ -21,6 +21,7 @@ export type {
   NameDefinitions,
   NameTitleDefinitions,
   PhoneNumberDefinitions,
+  ScienceDefinitions,
   SystemDefinitions,
   SystemMimeTypeEntryDefinitions,
   VehicleDefinitions,
@@ -38,6 +39,7 @@ export type {
 } from './modules/color';
 export { Gender } from './modules/name';
 export type { GenderType } from './modules/name';
+export { ChemicalElement, Unit } from './modules/science';
 export { Faker };
 
 // since we are requiring the top level of faker, load all locales by default

src/locales/en/index.ts

@@ -20,6 +20,7 @@ import lorem from './lorem';
 import music from './music';
 import name_ from './name';
 import phone_number from './phone_number';
+import science from './science';
 import system from './system';
 import team from './team';
 import vehicle from './vehicle';
@@ -45,6 +46,7 @@ const en: LocaleDefinition = {
   music,
   name: name_,
   phone_number,
+  science,
   system,
   team,
   vehicle,