warframe-name-generator 1.0.1 → 2.0.0

package/.nvmrc

@@ -0,0 +1 @@
+lts/hydrogen

package/README.md

@@ -9,12 +9,16 @@ npm i -S warframe-name-generator
 ## Usage
 
 ```js
-const { Generator } = require('warframe-name-generator');
+import Generator from 'warframe-name-generator';
 
 const generator = new Generator();
 console.log(generator.make({ adjective: true }));
+
+// if you'd like to access the data itself
+import data from 'warframe-name-generator/data';
+// and do stuff w/ it
 ```
 
 ## Contact me
 
-[![Contact me on Discord](https://img.shields.io/badge/discord-Tobiah%230001-7289DA.svg)](https://discord.gg/0ycgfahdR8gTzWgM "Contact me on Discord: Tobiah#0001")
+[![Contact me on Discord](https://img.shields.io/badge/discord-Tobiah%230001-7289DA.svg)](https://discord.gg/jGZxH9f "Contact me on Discord: Tobiah#0001")

package/lib/Generator.js

@@ -1,78 +1,36 @@
-'use strict';
-
-const data = {
-  corpus: {
-    adjectives: require('../options/corpus/adjectives.json'),
-    names: require('../options/corpus/names.json'),
-    places: require('../options/corpus/places.json'),
-    titles: require('../options/corpus/titles.json'),
-  },
-  grineer: {
-    adjectives: require('../options/grineer/adjectives.json'),
-    names: require('../options/grineer/names.json'),
-    places: require('../options/grineer/places.json'),
-    titles: require('../options/grineer/titles.json'),
-  },
-  orokin: {
-    adjectives: require('../options/orokin/adjectives.json'),
-    names: require('../options/orokin/names.json'),
-    places: require('../options/orokin/places.json'),
-    titles: require('../options/orokin/titles.json'),
-  },
-  sentient: {
-    adjectives: require('../options/sentient/adjectives.json'),
-    names: require('../options/sentient/names.json'),
-    places: require('../options/sentient/places.json'),
-    titles: require('../options/sentient/titles.json'),
-  },
-  tenno: {
-    adjectives: require('../options/tenno/adjectives.json'),
-    names: require('../options/tenno/names.json'),
-    places: require('../options/tenno/places.json'),
-    titles: require('../options/tenno/titles.json'),
-  },
-  infested: {
-    adjectives: require('../options/infested/adjectives.json'),
-    names: require('../options/infested/names.json'),
-    places: require('../options/infested/places.json'),
-    titles: require('../options/infested/titles.json'),
-  },
-};
+import data from './data.js';
 
 const races = Object.keys(data);
 const types = ['names', 'places', 'titles'];
 
-const getRandomEntry = array => array[Math.floor(Math.random() * array.length)];
+const getRandomEntry = (array) => array[Math.floor(Math.random() * array.length)];
 
-const toTitleCase = (string, includeSpaces) => string.toLowerCase()
-  .split(' ')
-  .map(word => word.replace(word[0], word[0].toUpperCase())).join(includeSpaces ? ' ' : '');
+const toTitleCase = (string, includeSpaces) =>
+  string
+    .toLowerCase()
+    .split(' ')
+    .map((word) => word.replace(word[0], word[0].toUpperCase()))
+    .join(includeSpaces ? ' ' : '');
 
-
-/**
- * Get a unique noun.
- * @param  {string[]} tokens        array of existing tokens
- * @param  {string} [race='random'] race type to use
- * @param  {string} [type='random'] noun type to use
- * @param  {boolean} [spaces=true}] whether or not to include spaces
- * @returns {string}                 the unique noun result
- */
-const getNoun = (tokens, {
-  race = 'random', type = 'random', spaces = true, iterations = 0,
-}) => {
-  const entry = toTitleCase(getRandomEntry(data[race][type]), spaces);
-  if (tokens.includes(entry) && (iterations < data[race][type].length)) {
-    return getNoun(tokens, {
-      race, type, spaces, iterations: iterations + 1,
-    });
+const evalRace = (race) => {
+  const r = race.toLowerCase() === 'random' ? races[Math.floor(Math.random() * races.length)] : race;
+  if (!races.includes(r.toLowerCase())) {
+    throw new Error(`Invalid race '${r}' provided.\nValid races: ${races.map((innRace) => `'${innRace}'`).join(', ')}`);
+  }
+  return r;
+};
+const evalType = (type) => {
+  const t = type.toLowerCase() === 'random' ? types[Math.floor(Math.random() * types.length)] : type;
+  if (!types.includes(t.toLowerCase())) {
+    throw new Error(`Invalid type '${t}' provided.\nValid types: ${types.map((iType) => `'${iType}'`).join(', ')}`);
   }
-  return entry;
+  return t;
 };
 
 /**
- * Generator for
+ * Generator for names!
  */
-class Generator {
+export default class Generator {
   constructor() {
     this.default = this.make();
     this.logger = console;
@@ -92,29 +50,78 @@ class Generator {
    * @param  {boolean} [debug=false]       (Optional) if true, debug and output string
    * @returns {string}                      resultant generation from provided options
    */
-  make({
-    race = 'random', nouns = 1, type = 'random', spaces = true, includeRace = false, adjective = false, debug = false,
-  } = { race: 'random', nouns: 1, type: 'random' }) {
-    const raceRes = race.toLowerCase() === 'random' ? races[Math.floor(Math.random() * races.length)] : race;
-    if (!races.includes(raceRes.toLowerCase())) {
-      throw new Error(`Invalid race '${type}' provided.\nValid races: ${races.map(innRace => `'${innRace}'`).join(', ')}`);
-    }
-
-    const typeRes = type.toLowerCase() === 'random' ? types[Math.floor(Math.random() * types.length)] : type;
-    if (!types.includes(typeRes.toLowerCase())) {
-      throw new Error(`Invalid type '${typeRes}' provided.\nValid types: ${types.map(iType => `'${iType}'`).join(', ')}`);
-    }
+  make(
+    {
+      race = 'random',
+      nouns = 1,
+      type = 'random',
+      spaces = true,
+      includeRace = false,
+      adjective = false,
+      debug = false,
+    } = { race: 'random', nouns: 1, type: 'random' }
+  ) {
+    const raceRes = evalRace(race);
+    const typeRes = evalType(type);
 
     const tokens = [];
     if (adjective) tokens.push(toTitleCase(getRandomEntry(data[raceRes].adjectives), spaces));
     if (includeRace) tokens.push(toTitleCase(raceRes, spaces));
     for (let index = 0; index < nouns; index += 1) {
-      tokens.push(getNoun(tokens, { race: raceRes, type: typeRes, spaces }));
+      tokens.push(this.getNoun(tokens, { race: raceRes, type: typeRes, spaces }));
     }
     const name = tokens.join(spaces ? ' ' : '');
     if (debug) this.logger.debug(name);
     return name;
   }
-}
 
-module.exports = Generator;
+  /**
+   * Get a random entry
+   * @returns {string} a random entry`
+   */
+  get random() {
+    return this.getNoun();
+  }
+
+  /**
+   * Get another string that's not already included in the tokens
+   * @param  {string[]} tokens tokens to exclude
+   * @returns {string}        new unique token
+   */
+  another(tokens) {
+    return this.getNoun(tokens);
+  }
+
+  /**
+   * Get a unique noun.
+   * @param  {string[]} tokens        array of existing tokens
+   * @param  {string} [race='random'] race type to use
+   * @param  {string} [type='random'] noun type to use
+   * @param  {boolean} [spaces=true}] whether or not to include spaces
+   * @param {number} [iterations=0]    number of iterations to try to get a unique noun
+   * @returns {string}                 the unique noun result
+   */
+  // eslint-disable-next-line class-methods-use-this
+  getNoun(
+    tokens = [],
+    { race = 'random', type = 'random', spaces = true, iterations = 0 } = {
+      race: 'random',
+      type: 'random',
+      spaces: true,
+      iterations: 0,
+    }
+  ) {
+    const raceR = evalRace(race);
+    const typeR = evalType(type);
+    const entry = toTitleCase(getRandomEntry(data[raceR][typeR]), spaces);
+    if (tokens.includes(entry) && iterations < data[raceR][typeR].length) {
+      return this.getNoun(tokens, {
+        race,
+        type,
+        spaces,
+        iterations: iterations + 1,
+      });
+    }
+    return entry;
+  }
+}

package/lib/data.js

@@ -0,0 +1,134 @@
+export default {
+  corpus: {
+    adjectives: (
+      await import('../options/corpus/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/corpus/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/corpus/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/corpus/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+  grineer: {
+    adjectives: (
+      await import('../options/grineer/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/grineer/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/grineer/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/grineer/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+  orokin: {
+    adjectives: (
+      await import('../options/orokin/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/orokin/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/orokin/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/orokin/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+  sentient: {
+    adjectives: (
+      await import('../options/sentient/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/sentient/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/sentient/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/sentient/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+  tenno: {
+    adjectives: (
+      await import('../options/tenno/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/tenno/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/tenno/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/tenno/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+  infested: {
+    adjectives: (
+      await import('../options/infested/adjectives.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    names: (
+      await import('../options/infested/names.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    places: (
+      await import('../options/infested/places.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+    titles: (
+      await import('../options/infested/titles.json', {
+        assert: { type: 'json' },
+      })
+    ).default,
+  },
+};

package/options/corpus/names.json

@@ -1,52 +1,105 @@
-["Deri",
-"Frohd",
-"Alad",
-"Clohs",
-"Hedron",
-"Bidd",
-"Darvo",
-"Fuhns",
-"Ranger",
-"Drone",
-"Arn",
-"Raptor",
-"Octa",
-"Nef",
-"Chas",
-"Deca",
-"Ico",
-"Kappa",
-"Hepta",
-"Zeta",
-"Rho",
-"Derf",
-"Kite",
-"Uno",
-"Loot",
-"Kota",
-"Moa",
-"Amprex",
-"Dera",
-"Lynx",
-"Serro",
-"Anyo",
-"Prodman",
-"Quanta",
-"Bek",
-"Spectra",
-"Opticor",
-"Detron",
-"Bursa",
-"Glaxion",
-"Osprey",
-"Zanuka",
-"Etina",
-"Tetra",
-"Helios",
-"Prova",
-"Ambulas",
-"Cestra",
-"V",
-"Hyena",
-"Lanka",
-"Supra"]
+[
+  "002-ER",
+  "Alad",
+  "Ambulas",
+  "Amprex",
+  "Angstrum",
+  "Anyo",
+  "Armis",
+  "Arn",
+  "Arca",
+  "Auditor",
+  "Azoth",
+  "Battacor",
+  "Bek",
+  "Bidd",
+  "Bursa",
+  "Carmine",
+  "Cestra",
+  "Chas",
+  "Clohs",
+  "Coildrive",
+  "Comba",
+  "Convectrix",
+  "Corvette",
+  "Crewman",
+  "Cycron",
+  "Darvo",
+  "Datalyst",
+  "Deca",
+  "Dera",
+  "Derf",
+  "Derim",
+  "Detron",
+  "Dro",
+  "Drone",
+  "Dropship",
+  "Dru",
+  "Etina",
+  "Ferrox",
+  "Flux",
+  "Frigate",
+  "Frohd",
+  "Fuhns",
+  "Glaxion",
+  "Gox",
+  "Hedron",
+  "Helios",
+  "Hepta",
+  "Hyena",
+  "Ico",
+  "Intehb",
+  "Jackal",
+  "Jad",
+  "Jen",
+  "John",
+  "Jordas",
+  "Kappa",
+  "Kite",
+  "Kota",
+  "Kreska",
+  "Lanka",
+  "Lecta",
+  "Lenz",
+  "Lockjaw",
+  "Loot",
+  "Lynx",
+  "M-W.A.M.",
+  "MOA",
+  "Nako",
+  "Nef",
+  "Nemes",
+  "Nullifier",
+  "Octa",
+  "Obex",
+  "Ocucor",
+  "Ohma",
+  "Opticor",
+  "Orb",
+  "Osprey",
+  "Penta",
+  "Plasmor",
+  "Presfor",
+  "Prodman",
+  "Prova",
+  "Quanta",
+  "Raknoid",
+  "Ranger",
+  "Raptor",
+  "Rho",
+  "Scisco",
+  "Serro",
+  "Sol",
+  "Spectra",
+  "Supra",
+  "Teran",
+  "Tetra",
+  "Titron",
+  "Trencher",
+  "Ulta",
+  "Uno",
+  "Xol",
+  "Zahn",
+  "Zanuka",
+  "Zeta"
+]

package/options/infested/titles.json

@@ -1,14 +1,14 @@
-["Juggernaut",
-"Golem",
-"Crawler",
-"Runner",
-"Boiler",
-"Mutalist",
-"Moa",
-"Ancient",
-"Charger",
-"Leaper",
-"Mutualist",
-"Moa",
-"Brood Mother",
-"Carrier"]
+[
+  "Juggernaut",
+  "Golem",
+  "Crawler",
+  "Runner",
+  "Boiler",
+  "Moa",
+  "Ancient",
+  "Charger",
+  "Leaper",
+  "Moa",
+  "Brood Mother",
+  "Carrier"
+]

package/options/orokin/places.json

@@ -1 +1,5 @@
-["Void", "Tower"]
+[
+  "Void",
+  "Tower",
+  "Weave"
+]

package/options/tenno/places.json

@@ -1 +1,7 @@
-["Zariman Ten-Zero", "Resevoir", "Orbiter", "Mantis", "Liset"]
+[
+  "Zariman Ten-Zero",
+  "Reservoir",
+  "Orbiter",
+  "Mantis",
+  "Liset"
+]

package/package.json

@@ -1,13 +1,22 @@
 {
   "name": "warframe-name-generator",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Name Generator for Warframe",
-  "main": "index.js",
+  "exports": {
+    ".": {
+      "import": "./lib/Generator.js"
+    },
+    "./data": {
+      "import": "./lib/data.js"
+    }
+  },
+  "type": "module",
   "scripts": {
-    "test": "npm run lint && npx mocha test/",
-    "lint": "npx eslint --ignore-path .gitignore .",
-    "lint:fix": "npx eslint --ignore-path .gitignore . --fix",
-    "postversion": "git push && git push --tags"
+    "test": "c8 mocha",
+    "coverage": "npm test && c8 report --reporter=text-lcov | coveralls",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "postinstall": "npx install-peerdeps @wfcd/eslint-config@latest -S"
   },
   "keywords": [
     "warframe",
@@ -17,20 +26,48 @@
   "author": "TobiTenno",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=8.9.0",
-    "npm": ">=6.1.0"
+    "node": ">=18.19.1",
+    "npm": ">=10.2.4"
   },
   "devDependencies": {
-    "chai": "^4.1.2",
-    "eslint": "^5.3.0",
-    "eslint-config-airbnb": "^17.1.0",
-    "eslint-plugin-import": "^2.14.0",
-    "eslint-plugin-jsx-a11y": "^6.1.1",
-    "eslint-plugin-react": "^7.11.1",
-    "greenkeeper-lockfile": "^1.15.1",
-    "mocha": "^5.2.0",
-    "semantic-release": "^15.9.8",
-    "sinon": "^6.1.5",
-    "travis-deploy-once": "^5.0.2"
-  }
+    "c8": "^9.1.0",
+    "chai": "^5.1.0",
+    "coveralls": "^3.1.1",
+    "mocha": "^10.3.0",
+    "sinon": "^17.0.1"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "skip-full": true
+  },
+  "mocha": {
+    "exit": true,
+    "check-leaks": true,
+    "diff": true,
+    "color": true,
+    "spec": "test/**/*.spec.js"
+  },
+  "eslintIgnore": [],
+  "eslintConfig": {
+    "extends": [
+      "@wfcd/eslint-config/esm"
+    ],
+    "parserOptions": {
+      "sourceType": "module",
+      "parser": "@babel/eslint-parser"
+    }
+  },
+  "babel": {
+    "presets": [
+      "@babel/preset-env"
+    ],
+    "plugins": [
+      "@babel/plugin-transform-class-properties",
+      "@babel/plugin-transform-private-methods"
+    ]
+  },
+  "prettier": "@wfcd/eslint-config/prettier"
 }

package/.eslintrc.json

@@ -1,30 +0,0 @@
-{
-  "extends": "airbnb",
-  "parserOptions": {
-    "sourceType": "script"
-  },
-  "rules": {
-    "valid-jsdoc": ["error", {
-      "requireReturn": false,
-      "requireReturnDescription": false,
-      "preferType": {
-        "String": "string",
-        "Number": "number",
-        "Boolean": "boolean",
-        "Function": "function",
-        "object": "Object",
-        "date": "Date",
-        "error": "Error"
-      },
-      "prefer": {
-        "return": "returns"
-      }
-    }],
-    "strict": ["error", "safe"],
-    "linebreak-style": "off",
-    "no-restricted-syntax": ["off"],
-    "no-await-in-loop": "off",
-    "import/no-unresolved": 0,
-    "global-require": "off"
-  }
-}

package/index.js

@@ -1,44 +0,0 @@
-'use strict';
-
-/* eslint-disable global-require */
-module.exports = {
-  Generator: require('./lib/Generator'),
-  data: {
-    corpus: {
-      adjectives: require('./options/corpus/adjectives.json'),
-      names: require('./options/corpus/names.json'),
-      places: require('./options/corpus/places.json'),
-      titles: require('./options/corpus/titles.json'),
-    },
-    grineer: {
-      adjectives: require('./options/grineer/adjectives.json'),
-      names: require('./options/grineer/names.json'),
-      places: require('./options/grineer/places.json'),
-      titles: require('./options/grineer/titles.json'),
-    },
-    orokin: {
-      adjectives: require('./options/orokin/adjectives.json'),
-      names: require('./options/orokin/names.json'),
-      places: require('./options/orokin/places.json'),
-      titles: require('./options/orokin/titles.json'),
-    },
-    sentient: {
-      adjectives: require('./options/sentient/adjectives.json'),
-      names: require('./options/sentient/names.json'),
-      places: require('./options/sentient/places.json'),
-      titles: require('./options/sentient/titles.json'),
-    },
-    tenno: {
-      adjectives: require('./options/tenno/adjectives.json'),
-      names: require('./options/tenno/names.json'),
-      places: require('./options/tenno/places.json'),
-      titles: require('./options/tenno/titles.json'),
-    },
-    infested: {
-      adjectives: require('./options/infested/adjectives.json'),
-      names: require('./options/infested/names.json'),
-      places: require('./options/infested/places.json'),
-      titles: require('./options/infested/titles.json'),
-    },
-  },
-};

package/test/.eslintrc.json

@@ -1,13 +0,0 @@
-{
-  "env": {
-    "mocha": true
-  },
-  "rules": {
-    "prefer-arrow-callback": "off",
-    "func-names": "off",
-    "no-new": "off",
-    "no-unused-expressions": "off",
-    "valid-jsdoc": "off",
-    "import/no-extraneous-dependencies": ["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
-  }
-}

package/test/mochaspec.js

@@ -1,35 +0,0 @@
-'use strict';
-
-const chai = require('chai');
-const { Generator } = require('../index.js');
-
-const should = chai.should();
-
-describe('The Generator', () => {
-  const generator = new Generator();
-
-  it('should provide a default name with no extra call', () => {
-    should.exist(generator.default);
-  });
-
-  it('should generate a name with no parameters', () => {
-    (() => {
-      const name = generator.make({ debug: false, adjective: true });
-      should.exist(name);
-    }).should.not.throw();
-  });
-
-  it('should generate unique names', () => {
-    const name = generator.make({ debug: false, adjective: true });
-    const name2 = generator.make({ debug: false, adjective: true });
-    should.not.equal(name, name2);
-  });
-
-  it('should generate 10k names without issues', () => {
-    (() => {
-      for (let i = 0; i < 10000; i += 1) {
-        generator.make({ debug: false, adjective: true, nouns: Math.floor(Math.random() * 10) });
-      }
-    }).should.not.throw();
-  });
-});