@tombell/4ad 1.0.0 → 1.0.1

package/README.md

@@ -1 +1,40 @@
-# 4ad.js
+# @tombell/4ad
+
+A library for parsing simple dice rolling syntax, with basic modifier support.
+
+For example `d6`, `2d20`, and `2d20+2`.
+
+Currently only very basic syntax is supported: `{count}d{sides}{modifier}`. Where the following:
+
+- `count` is optional
+- `sides` is required
+- `modifier` is an optional positive or negative number (e.g. `+2`, or `-10`)
+
+# Usage
+
+You can import the `roll` function if you would like to get the result of a specific dice syntax.
+
+```typescript
+import roll from "@tombell/4ad";
+
+const { total, rolls, modifier } = roll("2d6+2");
+
+// total will the the total of all the rolls +2
+// rolls will be an array of each individual roll
+// modifier will be the positive or negative modifier that will be added
+```
+
+The `parse` function is also exported if you would like to handle the "rolling" yourself.
+
+```typescript
+import { parse } from "@tombell/4ad";
+
+count { count, sides, modSign, modValue } = parse("2d6+2");
+
+// count will be 2
+// sides will be 6
+// modSign will be "+"
+// modValue will be 2
+```
+
+The `modSign` will be `undefined` if no modifier is specified, and `modValue` will be 0.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export declare function parse(notation: string): {
     count: number;
     sides: number;
-    modSign: string;
+    modSign: string | undefined;
     modValue: number;
 };
 export default function roll(notation: string): {

package/dist/index.js

@@ -6,7 +6,7 @@ export function parse(notation) {
     }
     const count = parseInt(match[1], 10) || 1;
     const sides = parseInt(match[2], 10);
-    const modSign = match[3];
+    const modSign = match[3] || undefined;
     const modValue = match[4] ? parseInt(match[4], 10) : 0;
     return { count, sides, modSign, modValue };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tombell/4ad",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A simple library to parse dice syntax for Four Against Darkness games.",
   "keywords": [
     "dice",
@@ -17,22 +17,22 @@
     "dist/"
   ],
   "scripts": {
-    "build": "bunx tsc -p tsconfig.build.json",
-    "lint": "bunx eslint",
     "test": "bun test",
     "coverage": "bun test --coverage",
-    "prepublishOnly": "rm -fr dist/ && bun run build"
+    "check": "bunx prettier --check .",
+    "lint": "bunx eslint",
+    "build": "bunx tsc -p tsconfig.build.json",
+    "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@eslint/js": "^9.27.0",
-    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
-    "@types/bun": "latest",
-    "eslint": "^9.27.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-prettier": "^5.4.0",
-    "jiti": "^2.4.2",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.0"
+    "@eslint/js": "^9.37.0",
+    "@types/bun": "1.2.23",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jiti": "^2.6.1",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.45.0"
   }
 }