orc-me 1.2.2 → 1.2.6

package/README.md

@@ -16,6 +16,8 @@
 
 * 👹 NPM package to generate random orc names
 * ✨ Get awesome orc names for your projects!
+* 👹 An orc name is created by starting with a harsh consonant sound (like `gr`, `kr`, `th`, or `sh`), followed by a short, heavy vowel (`a`, `o`, or `u`), and usually ending with another hard consonant (`g`, `k`, `r`, or `z`). Sometimes an extra harsh sound is added at the end to make the name feel more brutal.
+* ⭐ Updated the version using a custom `orc phoneme grammar` to avoid hardcoded array of names.
 
 # Install [NPM](https://www.npmjs.com/package/orc-me) 📦
 
@@ -30,12 +32,8 @@
 ``` javascript
 const orcMe = require('orc-me');
 
-function capitalizeFirstLetter(string) {
-    return string.charAt(0).toUpperCase() + string.slice(1);
-};
-
-const orcThreeNames = capitalizeFirstLetter(orcMe()) + ' ' + capitalizeFirstLetter(orcMe()) + ' ' + capitalizeFirstLetter(orcMe());
-const orcTwoNames = capitalizeFirstLetter(orcMe()) + ' ' + capitalizeFirstLetter(orcMe());
+const orcThreeNames = `${orcMe()} ${orcMe()} ${orcMe()}`;
+const orcTwoNames = `${orcMe()} ${orcMe()}`;
 
 console.log('Orc battle started! ⚔️');
 console.log(orcThreeNames + '    ⚔️     ' + orcTwoNames);

package/index.d.ts

@@ -1 +1,8 @@
-export default function (): string;
+/**
+ * Generate a random Orc-style name.
+ *
+ * @returns A randomly generated orc name as a string
+ */
+declare function orcName(): string;
+
+export = orcName;

package/index.js

@@ -1,24 +1,42 @@
 /**
- *  orchish - 👹 Generate a random orc name
- *  @version: v1.2.2
+ *  orc-me - 👹 Generate a random orc name
+ *  @version: v1.2.6
  *  @link: https://github.com/tutyamxx/orc-me
  *  @license: MIT
  **/
 
-const randomOrcnameStrings = [
-    'ach', 'adz', 'ak', 'ark', 'az', 'balg', 'bilg', 'blid', 'blig', 'blok', 'blot', 'bolg', 'bot', 'bug', 'burk', 'dokh', 'drik', 'driz', 'duf', 'flug', 'ga', 'gad', 'gag', 'gah',
-    'gak', 'gar', 'gat', 'gaz', 'ghag', 'ghak', 'git', 'glag', 'glak', 'glat', 'glig', 'gliz', 'glok', 'gnat', 'gog', 'grak', 'grat', 'guk', 'hig', 'irk', 'kak', 'khad', 'krig', 'lag',
-    'lak', 'lig', 'likk', 'loz', 'luk', 'mak', 'maz', 'miz', 'mub', 'nad', 'nag', 'naz', 'nig', 'nikk', 'nogg', 'nok', 'nukk', 'rag', 'rak', 'rat', 'rok', 'shrig', 'shuk', 'skrag', 'skug',
-    'slai', 'slig', 'slog', 'sna', 'snag', 'snark', 'snat', 'snig', 'snik', 'snit', 'sog', 'spik', 'stogg', 'tog', 'urf', 'vark', 'yad', 'yagg', 'yak', 'yark', 'yarp', 'yig', 'yip', 'zat',
-    'zib', 'zit', 'ziz', 'ag', 'aug', 'bad', 'bag', 'bakh', 'bash', 'baz', 'blag', 'brag', 'brog', 'bruz', 'dag', 'dakk', 'darg', 'dob', 'dog', 'drab', 'dug', 'dur', 'gash', 'ghaz', 'glakh',
-    'glaz', 'glob', 'glol', 'gluf', 'glur', 'gnarl', 'gnash', 'gnub', 'gob', 'gokh', 'gol', 'golk', 'gor', 'grakh', 'grash', 'grath', 'graz', 'grot', 'grub', 'grud', 'gud', 'gut', 'hag',
-    'hakk', 'hrat', 'hrog', 'hrug', 'khag', 'khar', 'krag', 'krud', 'lakh', 'lash', 'lob', 'lub', 'lud', 'luf', 'luk', 'molk', 'muk', 'muz', 'nar', 'ogg', 'olg', 'rag', 'rash', 'rogg', 'rorg',
-    'rot', 'rud', 'ruft', 'rug', 'rut', 'shad', 'shag', 'shak', 'shaz', 'shog', 'skar', 'skulg', 'slur', 'snar', 'snorl', 'snub', 'snurr', 'sod', 'stulg', 'thak', 'trog', 'ug', 'umsh', 'ung',
-    'uth', 'yakh', 'yash', 'yob', 'zahk', 'zog', 'argh', 'barsh', 'bog', 'burz', 'dof', 'drok', 'drub', 'drug', 'dub', 'dug', 'dul', 'dursh', 'dush', 'duz', 'faug', 'fug', 'ghakh', 'ghar', 'ghash',
-    'ghol', 'ghor', 'ghukk', 'ghul', 'glub', 'glud', 'glug', 'gluz', 'gom', 'grad', 'grash', 'grob', 'grogg', 'grok', 'grol', 'gru', 'gruf', 'gruk', 'grul', 'grum', 'grumf', 'grut', 'gruz', 'guhl',
-    'gulv', 'hai', 'hrung', 'hur', 'hurg', 'kai', 'klob', 'krod', 'kug', 'kulk', 'kur', 'lorg', 'lug', 'lukh', 'lum', 'lurz', 'lush', 'luz', 'makh', 'maug', 'molg', 'mud', 'mug', 'mul', 'murk', 'muzd',
-    'nakh', 'narg', 'obb', 'rolb', 'rukh', 'ruz', 'sharg', 'shruf', 'shud', 'shug', 'shur', 'shuz', 'slub', 'slud', 'slug', 'snad', 'snog', 'thrag', 'thulk', 'thurk', 'trug', 'ulg', 'ur', 'urd', 'urgh',
-    'urkh', 'uz', 'yug', 'yur', 'zud', 'zug', 'xug', 'grug'
-];
-
-module.exports = () => randomOrcnameStrings[Math.floor(Math.random() * randomOrcnameStrings.length)];
+const pick = (src) => src?.[Math.random() * src.length | 0] ?? '';
+
+/**
+ * Generate a random Orc-style name.
+ *
+ * @returns A randomly generated orc name as a string
+ */
+const orcMe = () => {
+    // --| Onset: single or double harsh consonants
+    const onset = Math.random() < 0.5
+        ? pick('gkrzbdh')   // --| Single consonants
+        : pick(['gr', 'kr', 'th', 'sh', 'br', 'dr', 'gl', 'gh']);
+
+    // --| Vowels: single or diphthong for variety
+    const vowel = pick(['a', 'o', 'u', 'aa', 'oo', 'au']);
+
+    // --| Coda: optional, mostly harsh consonants or clusters
+    const coda = Math.random() < 0.7
+        ? pick(['g', 'k', 'r', 'z', 'sh', 'rg', 'kk', 'zz', 'th'])
+        : '';
+
+    // --| Extra ending letter sometimes
+    const extra = Math.random() < 0.4
+        ? pick('gkrz')
+        : '';
+
+    // --| Optional second syllable sometimes to make longer names
+    const secondSyllable = Math.random() < 0.3
+        ? pick(['', '', 'g', 'k', 'r', 'z', 'sh']) + pick(['a', 'o', 'u'])
+        : '';
+
+    return `${onset}${vowel}${coda}${extra}${secondSyllable}`?.replace?.(/^./, c => c.toUpperCase()) ?? '';
+};
+
+module.exports = orcMe;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "orc-me",
-  "version": "1.2.2",
+  "version": "1.2.6",
   "description": "Generate a random orc name",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "jest --verbose"
   },

package/test/index.test.js

@@ -1,8 +1,31 @@
 const orcMe = require('../index.js');
 
-test('Check if it returns a random Orc name with a length between 2  and 5 chars', () => {
-    const expectedString = expect.stringMatching(/^[a-z]{2,5}$/);
+test('Check if it returns a random Orc name with valid characters and length', () => {
+    const expectedString = expect.stringMatching(/^[A-Z][a-z]{1,6}$/);
 
-    expect(orcMe()).toEqual(expectedString);
-    expect(orcMe()).not.toBe('');
+    const name = orcMe();
+
+    expect(name).toEqual(expectedString);
+    expect(name).not.toBe('');
+});
+
+test('Check that multiple calls return strings', () => {
+    for (let i = 0; i < 10; i++) {
+        expect(typeof orcMe()).toBe('string');
+    }
+});
+
+test('Check that generated names are not all identical', () => {
+    const names = new Set(Array.from({ length: 10 }, () => orcMe()));
+    expect(names.size).toBeGreaterThan(1);
+});
+
+test('Check that the first character is uppercase', () => {
+    const name = orcMe();
+    expect(name[0]).toMatch(/[A-Z]/);
+});
+
+test('Check that the name contains at least one vowel', () => {
+    const name = orcMe().toLowerCase();
+    expect(name).toMatch(/[aou]/);
 });