refactor: rename words to dictionary

TimMikeladze · Aug 11, 2023 · 88d8fd4 · 88d8fd4
1 parent c410b8b
commit 88d8fd4
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -130,7 +130,7 @@ spaceSlug([
 
 | Function | Type |
 | ---------- | ---------- |
-| `digits` | `(count?: number) => (options: SpaceSlugOptions) => string` |
+| `digits` | `(count?: number, noConsecutive?: boolean) => (options: SpaceSlugOptions) => string` |
 
 ### :gear: cleanString
 
@@ -153,7 +153,7 @@ spaceSlug([
 
 ## :wrench: Constants
 
-- [defaultWords](#gear-defaultwords)
+- [spaceSlugDefaultDictionary](#gear-spaceslugdefaultdictionary)
 - [spaceSlugDefaultOptions](#gear-spaceslugdefaultoptions)
 - [noun](#gear-noun)
 - [adjective](#gear-adjective)
@@ -164,11 +164,11 @@ spaceSlug([
 - [animal](#gear-animal)
 - [cosmos](#gear-cosmos)
 
-### :gear: defaultWords
+### :gear: spaceSlugDefaultDictionary
 
 | Constant | Type |
 | ---------- | ---------- |
-| `defaultWords` | `Record<string, Partial<{ [key: string]: string[]; adjectives: string[]; animals: string[]; colors: string[]; cosmos: string[]; emojis: string[]; nouns: string[]; seasons: string[]; verbs: string[]; }>>` |
+| `spaceSlugDefaultDictionary` | `Record<string, Partial<{ [key: string]: string[]; adjectives: string[]; animals: string[]; colors: string[]; cosmos: string[]; emojis: string[]; nouns: string[]; seasons: string[]; verbs: string[]; }>>` |
 
 ### :gear: spaceSlugDefaultOptions
 

diff --git a/src/data/emojis.ts → src/dictionary/emojis.ts b/src/data/emojis.ts → src/dictionary/emojis.ts
diff --git a/src/data/en/adjectives.ts → src/dictionary/en/adjectives.ts b/src/data/en/adjectives.ts → src/dictionary/en/adjectives.ts
diff --git a/src/data/en/animals.ts → src/dictionary/en/animals.ts b/src/data/en/animals.ts → src/dictionary/en/animals.ts
diff --git a/src/data/en/colors.ts → src/dictionary/en/colors.ts b/src/data/en/colors.ts → src/dictionary/en/colors.ts
diff --git a/src/data/en/cosmos.ts → src/dictionary/en/cosmos.ts b/src/data/en/cosmos.ts → src/dictionary/en/cosmos.ts
diff --git a/src/data/en/index.ts → src/dictionary/en/index.ts b/src/data/en/index.ts → src/dictionary/en/index.ts
diff --git a/src/data/en/nouns.ts → src/dictionary/en/nouns.ts b/src/data/en/nouns.ts → src/dictionary/en/nouns.ts
diff --git a/src/data/en/seasons.ts → src/dictionary/en/seasons.ts b/src/data/en/seasons.ts → src/dictionary/en/seasons.ts
diff --git a/src/data/en/verbs.ts → src/dictionary/en/verbs.ts b/src/data/en/verbs.ts → src/dictionary/en/verbs.ts
diff --git a/src/index.ts b/src/index.ts
@@ -6,14 +6,14 @@ import {
   animals,
   verbs,
   cosmos as cosmosWords,
-} from './data/en';
+} from './dictionary/en';
 
-import { emojis } from './data/emojis';
+import { emojis } from './dictionary/emojis';
 
-export * from './data/emojis';
-export * from './data/en';
+export * from './dictionary/emojis';
+export * from './dictionary/en';
 
-export const defaultWords: Record<string, SpaceSlugDictionary> = {
+export const spaceSlugDefaultDictionary: Record<string, SpaceSlugDictionary> = {
   en: {
     seasons,
     emojis,
@@ -29,7 +29,7 @@ export const defaultWords: Record<string, SpaceSlugDictionary> = {
 export const spaceSlugDefaultOptions: Partial<SpaceSlugOptions> = {
   locale: 'en',
   separator: '-',
-  dictionary: defaultWords,
+  dictionary: spaceSlugDefaultDictionary,
 };
 
 export type SpaceSlugDictionary = Partial<{

diff --git a/tests/spaceSlug.test.ts b/tests/spaceSlug.test.ts
@@ -2,7 +2,7 @@ import { describe, it, expect } from 'vitest';
 import {
   spaceSlug,
   animal,
-  defaultWords,
+  spaceSlugDefaultDictionary,
   digits,
   noun,
   word,
@@ -85,11 +85,17 @@ describe('spaceSlug', () => {
 
     expect(parts).toHaveLength(4);
 
-    expect(defaultWords.en.nouns!.includes(parts[0])).toBeTruthy();
+    expect(
+      spaceSlugDefaultDictionary.en.nouns!.includes(parts[0])
+    ).toBeTruthy();
 
-    expect(defaultWords.en.nouns!.includes(parts[1])).toBeTruthy();
+    expect(
+      spaceSlugDefaultDictionary.en.nouns!.includes(parts[1])
+    ).toBeTruthy();
 
-    expect(defaultWords.en.animals!.includes(parts[2])).toBeTruthy();
+    expect(
+      spaceSlugDefaultDictionary.en.animals!.includes(parts[2])
+    ).toBeTruthy();
 
     expect(parts[3]).toHaveLength(3);
   });