Rename files, remove unused "as"'s, bump to 6.0.0 (#631)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "randsum",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "private": false,
   "author": "Alex Jarvis",
   "icon": "https://raw.githubusercontent.com/RANDSUM/randsum-ts/main/icon.webp",

src/parameterizeRollArgument/index.ts

@@ -15,7 +15,7 @@ function parameterizeRollArgument(
     die,
     notation: formatNotation(options),
     description: formatDescription(options)
-  } as RandsumRollParameters
+  }
 }
 
 export { parameterizeRollArgument }

src/roll/generateRollResultFromParameters/index.ts → src/roll/generateRollResult/index.ts

@@ -52,9 +52,7 @@ function generateModifiedRolls(
   )
 }
 
-function generateRollResultFromParameters(
-  DicePools: DicePools
-): RandsumRollResult {
+function generateRollResult(DicePools: DicePools): RandsumRollResult {
   const rawRolls = generateRawRolls(DicePools.dicePools)
   const modifiedRolls = generateModifiedRolls(DicePools, rawRolls)
   const modifiedValues = Object.values(modifiedRolls)
@@ -74,4 +72,4 @@ function generateRollResultFromParameters(
   }
 }
 
-export { generateRollResultFromParameters }
+export { generateRollResult }

src/roll/index.ts

@@ -1,10 +1,10 @@
 import { RandsumRollArgument, RandsumRollResult } from '~types'
-import { generateRollResultFromParameters } from './generateRollResultFromParameters'
+import { generateRollResult } from './generateRollResult'
 import { formDicePools } from './formDicePools'
 
 function roll(arg?: RandsumRollArgument): RandsumRollResult {
   const dicePools = formDicePools(arg)
-  return generateRollResultFromParameters(dicePools)
+  return generateRollResult(dicePools)
 }
 
 export { roll }

src/utils/formatNotation/index.ts

@@ -30,19 +30,17 @@ function formatModifierNotation({ modifiers }: RandsumRollOptions): string {
 }
 
 function formatCoreNotation({
-  quantity,
+  quantity = 1,
   sides
-}: RandsumRollOptions<string | number>) {
+}: RandsumRollOptions<string | number>): RandsumNotation {
   const formattedSides = Array.isArray(sides)
     ? `{${sides.map((s) => (s === '' ? ' ' : s)).join('')}}`
     : sides
-  return `${quantity}d${formattedSides}`
+  return `${quantity}d${formattedSides}` as RandsumNotation
 }
 
 function formatNotation(options: RandsumRollOptions): RandsumNotation {
-  return `${formatCoreNotation(options)}${formatModifierNotation(options)}` as
-    | RandsumNotation<string>
-    | RandsumNotation<number>
+  return `${formatCoreNotation(options)}${formatModifierNotation(options)}` as RandsumNotation
 }
 
 export { formatNotation }

src/utils/parseModifiers.ts → src/utils/parseNotation/parseModifiers.ts

@@ -28,7 +28,7 @@ export function parseCoreNotation(
     sides: sides.includes('{')
       ? [...sides.replaceAll(/{|}/g, '')]
       : Number(sides)
-  } as RequiredCoreDiceParameters
+  }
 }
 
 function parseCapNotation(modifiersString: string): Pick<Modifiers, 'cap'> {

tests/generateRawRolls.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, test } from 'bun:test'
 
 import { RandsumRollParameters, DicePools } from '~types'
-import { generateRawRolls } from '~src/roll/generateRollResultFromParameters/generateRawRolls'
+import { generateRawRolls } from '~src/roll/generateRollResult/generateRawRolls'
 
 describe('generateRawRolls', () => {
   describe('when given a DicePools object', () => {

tests/generateResult.test.ts

@@ -1,12 +1,12 @@
 import { describe, expect, spyOn, test } from 'bun:test'
 
 import { D } from '~src/D'
-import { generateRollResultFromParameters } from '~src/roll/generateRollResultFromParameters'
-import { InvalidUniqueError } from '~src/roll/generateRollResultFromParameters/applyModifiers'
-import * as GenerateRawRolls from '~src/roll/generateRollResultFromParameters/generateRawRolls'
+import { generateRollResult } from '~src/roll/generateRollResult'
+import { InvalidUniqueError } from '~src/roll/generateRollResult/applyModifiers'
+import * as GenerateRawRolls from '~src/roll/generateRollResult/generateRawRolls'
 import { RandsumNotation, DicePoolType, DicePools } from '~types'
 
-describe('generateRollResultFromParameters', () => {
+describe('generateRollResult', () => {
   const testRollSet = [1, 2, 3, 4]
   const coreRawRolls = {
     'test-roll-id': testRollSet
@@ -38,7 +38,7 @@ describe('generateRollResultFromParameters', () => {
         coreRawRolls
       )
 
-      expect(generateRollResultFromParameters(coreParameters)).toMatchObject({
+      expect(generateRollResult(coreParameters)).toMatchObject({
         ...coreParameters,
         rawRolls: coreRawRolls,
         type: DicePoolType.standard,
@@ -74,7 +74,7 @@ describe('generateRollResultFromParameters', () => {
       }
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(rawRolls)
 
-      expect(generateRollResultFromParameters(uniqueParameters)).toMatchObject({
+      expect(generateRollResult(uniqueParameters)).toMatchObject({
         ...uniqueParameters,
         rawRolls,
         modifiedRolls: {
@@ -116,9 +116,7 @@ describe('generateRollResultFromParameters', () => {
           rawRolls
         )
 
-        expect(
-          generateRollResultFromParameters(notUniqueParameters)
-        ).toMatchObject({
+        expect(generateRollResult(notUniqueParameters)).toMatchObject({
           ...notUniqueParameters,
           rawRolls,
           modifiedRolls: {
@@ -162,9 +160,9 @@ describe('generateRollResultFromParameters', () => {
           rawRolls
         )
 
-        expect(() =>
-          generateRollResultFromParameters(overflowParameters)
-        ).toThrow(new InvalidUniqueError())
+        expect(() => generateRollResult(overflowParameters)).toThrow(
+          new InvalidUniqueError()
+        )
       })
     })
   })
@@ -194,9 +192,7 @@ describe('generateRollResultFromParameters', () => {
       }
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(rawRolls)
 
-      expect(
-        generateRollResultFromParameters(customSidesParameters)
-      ).toMatchObject({
+      expect(generateRollResult(customSidesParameters)).toMatchObject({
         ...customSidesParameters,
         rawRolls,
         modifiedRolls: {
@@ -245,7 +241,7 @@ describe('generateRollResultFromParameters', () => {
       }
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(rawRolls)
 
-      expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+      expect(generateRollResult(dropParameters)).toMatchObject({
         ...dropParameters,
         rawRolls,
         modifiedRolls: {
@@ -284,7 +280,7 @@ describe('generateRollResultFromParameters', () => {
           coreRawRolls
         )
 
-        expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+        expect(generateRollResult(dropParameters)).toMatchObject({
           ...dropParameters,
           rawRolls: coreRawRolls,
           type: DicePoolType.standard,
@@ -327,7 +323,7 @@ describe('generateRollResultFromParameters', () => {
           coreRawRolls
         )
 
-        expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+        expect(generateRollResult(dropParameters)).toMatchObject({
           ...dropParameters,
           type: DicePoolType.standard,
           rawRolls: coreRawRolls,
@@ -369,21 +365,19 @@ describe('generateRollResultFromParameters', () => {
       }
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(rawRolls)
 
-      expect(generateRollResultFromParameters(explodeParameters)).toMatchObject(
-        {
-          ...explodeParameters,
-          rawRolls,
-          type: DicePoolType.standard,
-          modifiedRolls: {
-            'test-roll-id': {
-              rolls: [1, 2, 3, 6, 200],
-              total: 212
-            }
-          },
-          total: 212,
-          result: [[1, 2, 3, 6, 200]]
-        }
-      )
+      expect(generateRollResult(explodeParameters)).toMatchObject({
+        ...explodeParameters,
+        rawRolls,
+        type: DicePoolType.standard,
+        modifiedRolls: {
+          'test-roll-id': {
+            rolls: [1, 2, 3, 6, 200],
+            total: 212
+          }
+        },
+        total: 212,
+        result: [[1, 2, 3, 6, 200]]
+      })
     })
   })
 
@@ -409,7 +403,7 @@ describe('generateRollResultFromParameters', () => {
         spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
           coreRawRolls
         )
-        expect(generateRollResultFromParameters(reDicePools)).toMatchObject({
+        expect(generateRollResult(reDicePools)).toMatchObject({
           ...reDicePools,
           rawRolls: coreRawRolls,
           modifiedRolls: {
@@ -448,7 +442,7 @@ describe('generateRollResultFromParameters', () => {
         spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
           coreRawRolls
         )
-        expect(generateRollResultFromParameters(reDicePools)).toMatchObject({
+        expect(generateRollResult(reDicePools)).toMatchObject({
           ...reDicePools,
           rawRolls: coreRawRolls,
           modifiedRolls: {
@@ -487,7 +481,7 @@ describe('generateRollResultFromParameters', () => {
         spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
           coreRawRolls
         )
-        expect(generateRollResultFromParameters(reDicePools)).toMatchObject({
+        expect(generateRollResult(reDicePools)).toMatchObject({
           ...reDicePools,
           rawRolls: coreRawRolls,
           modifiedRolls: {
@@ -525,7 +519,7 @@ describe('generateRollResultFromParameters', () => {
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
         coreRawRolls
       )
-      expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+      expect(generateRollResult(dropParameters)).toMatchObject({
         ...dropParameters,
         rawRolls: coreRawRolls,
         modifiedRolls: {
@@ -562,7 +556,7 @@ describe('generateRollResultFromParameters', () => {
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
         coreRawRolls
       )
-      expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+      expect(generateRollResult(dropParameters)).toMatchObject({
         ...dropParameters,
         rawRolls: coreRawRolls,
         modifiedRolls: {
@@ -598,7 +592,7 @@ describe('generateRollResultFromParameters', () => {
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(
         coreRawRolls
       )
-      expect(generateRollResultFromParameters(dropParameters)).toMatchObject({
+      expect(generateRollResult(dropParameters)).toMatchObject({
         ...dropParameters,
         rawRolls: coreRawRolls,
         modifiedRolls: {
@@ -640,7 +634,7 @@ describe('generateRollResultFromParameters', () => {
       }
 
       spyOn(GenerateRawRolls, 'generateRawRolls').mockReturnValueOnce(rawRolls)
-      expect(generateRollResultFromParameters(parameters)).toMatchObject({
+      expect(generateRollResult(parameters)).toMatchObject({
         ...parameters,
         rawRolls,
         modifiedRolls: {
@@ -678,7 +672,7 @@ describe('generateRollResultFromParameters', () => {
     } as unknown as DicePools
 
     test('Throws an error', () => {
-      expect(() => generateRollResultFromParameters(dropParameters)).toThrow(
+      expect(() => generateRollResult(dropParameters)).toThrow(
         'Unknown modifier: foo'
       )
     })