bb26 4.0.0 → 5.0.0

package/{dist → distribution/source}/increment.d.ts

@@ -1,14 +1,5 @@
 /**
  * Increments a bijective base-26 string by one numeral.
- *
- * ```
- * import { increment } from 'bb26'
- *
- * increment('A')  // 'B'
- * increment('Z')  // 'AA'
- * increment('AA') // 'AB'
- * ```
- *
  * @param string - String to increment
  * @return Incremented string
  */

package/{dist → distribution/source}/increment.js

@@ -1,15 +1,7 @@
-import { toBb26, toDecimal } from './index.js';
+import toBb26 from './to-bb26.js';
+import toDecimal from './to-decimal.js';
 /**
  * Increments a bijective base-26 string by one numeral.
- *
- * ```
- * import { increment } from 'bb26'
- *
- * increment('A')  // 'B'
- * increment('Z')  // 'AA'
- * increment('AA') // 'AB'
- * ```
- *
  * @param string - String to increment
  * @return Incremented string
  */

package/distribution/source/random.js

@@ -0,0 +1,18 @@
+import randomInteger from 'random-int';
+import toBb26 from './to-bb26.js';
+import toDecimal from './to-decimal.js';
+/**
+ * Produces a random string between the inclusive `lower` and `upper` bounds. If
+ * only one argument is provided, a string between `'A'` and the given string is
+ * returned.
+ *
+ * @param lower
+ * @param upper
+ * @returns Random string
+ */
+export default function random(lower, upper) {
+    const lowerDecimal = upper === undefined ? 1 : toDecimal(lower);
+    const upperDecimal = upper === undefined ? toDecimal(lower) : toDecimal(upper);
+    const integer = randomInteger(lowerDecimal, upperDecimal);
+    return toBb26(integer);
+}

package/{dist → distribution/source}/range.js

@@ -1,20 +1,11 @@
-import { toDecimal, increment } from './index.js';
+import increment from './increment.js';
+import toDecimal from './to-decimal.js';
 /**
  * Creates an array of bijective base-26 numerals progressing from `start` up
  * to, but not including, `end`.
  *
  * If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
  *
- * ```
- * import { range } from 'bb26'
- *
- * range('B')       // ['A']
- * range('C')       // ['A', 'B']
- * range('B', 'C')  // ['B']
- * range('B', 'D')  // ['B', 'C']
- * range('Z', 'AC') // ['Z', 'AA', 'AB']
- * ```
- *
  * @param start - The start of the range
  * @param end - The end of the range
  */

package/distribution/source/to-bb26.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a decimal number to a bijective base-26 string.
+ *
+ * @param number
+ */
+export default function toBb26(number: number): string;

package/{dist → distribution/source}/to-bb26.js

@@ -4,16 +4,6 @@ function toChar(number) {
 /**
  * Converts a decimal number to a bijective base-26 string.
  *
- * ```
- * import { toBb26 } from 'bb26'
- *
- * toBb26(1)  // 'A'
- * toBb26(2)  // 'B'
- * toBb26(26) // 'Z'
- * toBb26(27) // 'AA'
- * toBb26(28) // 'AB'
- * ```
- *
  * @param number
  */
 export default function toBb26(number) {

package/distribution/source/to-decimal.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a bijective base-26 string to a decimal number.
+ *
+ * @param string
+ */
+export default function toDecimal(string: string): number;

package/{dist → distribution/source}/to-decimal.js

@@ -1,25 +1,16 @@
+import ow from 'ow';
 function charToDecimal(letter) {
     return letter.codePointAt(0) - 'A'.codePointAt(0) + 1;
 }
 /**
  * Converts a bijective base-26 string to a decimal number.
  *
- * ```
- * import { toDecimal } from 'bb26'
- *
- * toDecimal('A')  // 1
- * toDecimal('B')  // 2
- * toDecimal('Z')  // 26
- * toDecimal('AA') // 27
- * toDecimal('AB') // 28
- * ```
- *
  * @param string
  */
 export default function toDecimal(string) {
-    if (!/[A-Z]/.test(string)) {
-        throw new Error('String must contain only upper-case characters');
-    }
+    ow(string, ow.string
+        .matches(/^[A-Z]+$/)
+        .message(`Expected string to only contain upper-case letters, got \`${string}\``));
     let number = 0;
     for (let i = 0; i < string.length; i++) {
         const char = string[string.length - i - 1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb26",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Utilities for working with bijective base-26 numerals",
   "keywords": [
     "base 26",
@@ -11,39 +11,42 @@
     "spreadsheet column letters",
     "license plate serials"
   ],
-  "homepage": "https://github.com/patrik-csak/BB26#readme",
-  "bugs": {
-    "url": "https://github.com/patrik-csak/BB26/issues"
-  },
+  "repository": "github:patrik-csak/BB26",
+  "funding": "https://buymeacoffee.com/patrikcsak",
   "license": "MIT",
-  "author": "Patrik Csak <p@trikcsak.com>",
+  "author": "Patrik Csak <p@trikcsak.com> (https://patrikcsak.com)",
+  "type": "module",
+  "exports": {
+    "types": "./distribution/source/index.d.ts",
+    "default": "./distribution/source/index.js"
+  },
   "files": [
-    "dist"
+    "distribution/source"
   ],
-  "repository": "github:patrik-csak/BB26",
   "scripts": {
-    "build": "del-cli dist && tsc",
-    "format": "xo --fix",
+    "build": "del-cli distribution && tsc",
+    "format": "eslint --fix && prettier --write . && sort-package-json",
     "prepare": "npm run build",
-    "test": "xo && ava",
-    "test:coverage": "del-cli coverage && xo && c8 ava",
-    "test:coverage:lcov": "del-cli coverage && xo && c8 --reporter=lcovonly ava"
+    "test": "eslint && prettier --check . && sort-package-json --check && ava",
+    "test:coverage": "del-cli coverage && eslint && prettier --check . && sort-package-json --check && c8 ava"
   },
   "dependencies": {
-    "random-item": "^4.0.1"
+    "ow": "^2.0.0",
+    "random-int": "^3.0.0"
   },
   "devDependencies": {
-    "@sindresorhus/tsconfig": "^3.0.1",
-    "ava": "^5.2.0",
-    "c8": "^7.10.0",
-    "del-cli": "^5.0.0",
-    "ts-node": "^10.4.0",
+    "@ava/typescript": "^6.0.0",
+    "@sindresorhus/tsconfig": "^7.0.0",
+    "ava": "^6.4.1",
+    "c8": "^10.1.3",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.32.0",
+    "prettier": "^3.6.2",
+    "sort-package-json": "^3.0.0",
     "typescript": "^5.0.2",
-    "xo": "^0.54.1"
+    "xo": "^1.2.1"
   },
   "engines": {
-    "node": ">=16 <=19"
-  },
-  "exports": "./dist/index.js",
-  "type": "module"
+    "node": ">=20 <=24"
+  }
 }

package/readme.md

@@ -1,9 +1,6 @@
 # BB26
 
-[![Badge indicating number of weekly downloads of BB26 from npm package registry](https://badgen.net/npm/dw/bb26)](https://www.npmjs.com/package/bb26)
-[![Badge indicating percent test coverage of BB26](https://badgen.net/codeclimate/coverage/patrik-csak/BB26?label=test+coverage)](https://codeclimate.com/github/patrik-csak/BB26/test_coverage)
-
-BB26 is a JavaScript library for working with [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) (BB26) numbers
+BB26 is a JavaScript library for working with [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) (BB26) numbers.
 
 ## What is bijective base-26 numeration?
 
@@ -12,17 +9,13 @@ You’re probably familiar with BB26 numeration. It’s used for spreadsheet col
 Here’s an example of decimal (base-10) numbers (the numbers you use every day to count things) compared to their corresponding BB26 numbers:
 
 ```
-Decimal: | 1 | 2 | 3 | ... | 24 | 25 | 26 | 27 | 28 | 29 | ...
-   BB26: | A | B | C | ... |  X |  Y |  Z | AA | AB | AC | ...
+Decimal: | 1 | 2 | 3 | … | 24 | 25 | 26 | 27 | 28 | 29 | …
+   BB26: | A | B | C | … |  X |  Y |  Z | AA | AB | AC | …
 ```
 
 ## Install
 
-> **Note**
->
-> This package is a native ECMAScript Module (ESM). If your project is not ESM, read [Sindre Sorhus’s Pure ESM package article](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
-
-```sh
+```shell
 npm install bb26
 ```
 
@@ -30,68 +23,68 @@ npm install bb26
 
 ### `increment()`
 
-```ts
+```typescript
 function increment(string: string): string;
 ```
 
 Increments a bijective base-26 string by one numeral.
 
-```js
-import { increment } from "bb26";
+```javascript
+import {increment} from 'bb26';
 
-increment("A");  // 'B'
-increment("Z");  // 'AA'
-increment("AA"); // 'AB'
+increment('A'); // 'B'
+increment('Z'); // 'AA'
+increment('AA'); // 'AB'
 ```
 
 ### `random()`
 
-```ts
+```typescript
 function random(upper: string): string;
 function random(lower: string, upper: string): string;
 ```
 
 Produces a random string between the inclusive `lower` and `upper` bounds. If only one argument is provided, a string between `'A'` and the given string is returned.
 
-```js
-import { random } from "bb26";
+```javascript
+import {random} from 'bb26';
 
-random("AAA");         // 'NE'
-random("AAA", "AAAA"); // 'KXZ'
+random('AAA'); // 'NE'
+random('AAA', 'AAAA'); // 'KXZ'
 ```
 
 ### `range()`
 
-```ts
+```typescript
 function range(end: string): string[];
 function range(start: string, end: string): string[];
 ```
 
 Creates an array of bijective base-26 numerals progressing from `start` up to, but not including, `end`. If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
 
-```js
-import { range } from "bb26";
+```javascript
+import {range} from 'bb26';
 
-range("B");       // ['A']
-range("C");       // ['A', 'B']
-range("B", "C");  // ['B']
-range("B", "D");  // ['B', 'C']
-range("Z", "AC"); // ['Z', 'AA', 'AB']
+range('B'); // ['A']
+range('C'); // ['A', 'B']
+range('B', 'C'); // ['B']
+range('B', 'D'); // ['B', 'C']
+range('Z', 'AC'); // ['Z', 'AA', 'AB']
 ```
 
 ### `toBb26()`
 
-```ts
+```typescript
 function toBb26(number: number): string;
 ```
 
 Converts a decimal number to a bijective base-26 string.
 
-```js
-import { toBb26 } from "bb26";
+```javascript
+import {toBb26} from 'bb26';
 
-toBb26(1);  // 'A'
-toBb26(2);  // 'B'
+toBb26(1); // 'A'
+toBb26(2); // 'B'
 toBb26(26); // 'Z'
 toBb26(27); // 'AA'
 toBb26(28); // 'AB'
@@ -99,18 +92,18 @@ toBb26(28); // 'AB'
 
 ### `toDecimal()`
 
-```ts
+```typescript
 function toDecimal(string: string): number;
 ```
 
 Converts a bijective base-26 string to a decimal number.
 
-```js
-import { toDecimal } from "bb26";
+```javascript
+import {toDecimal} from 'bb26';
 
-toDecimal("A");  // 1
-toDecimal("B");  // 2
-toDecimal("Z");  // 26
-toDecimal("AA"); // 27
-toDecimal("AB"); // 28
+toDecimal('A'); // 1
+toDecimal('B'); // 2
+toDecimal('Z'); // 26
+toDecimal('AA'); // 27
+toDecimal('AB'); // 28
 ```

package/dist/random.js

@@ -1,23 +0,0 @@
-import randomItem from 'random-item';
-import { range } from './index.js';
-/**
- * Produces a random string between the inclusive `lower` and `upper` bounds. If
- * only one argument is provided, a string between `'A'` and the given string is
- * returned.
- *
- * ```
- * import { random } from 'bb26'
- *
- * random('AAA')         // 'NE'
- * random('AAA', 'AAAA') // 'KXZ'
- * ```
- *
- * @param lower
- * @param upper
- * @returns Random string
- */
-export default function random(lower, upper) {
-    const start = upper ? lower : 'A';
-    const end = upper ?? lower;
-    return randomItem(range(start, end));
-}

package/dist/to-bb26.d.ts

@@ -1,16 +0,0 @@
-/**
- * Converts a decimal number to a bijective base-26 string.
- *
- * ```
- * import { toBb26 } from 'bb26'
- *
- * toBb26(1)  // 'A'
- * toBb26(2)  // 'B'
- * toBb26(26) // 'Z'
- * toBb26(27) // 'AA'
- * toBb26(28) // 'AB'
- * ```
- *
- * @param number
- */
-export default function toBb26(number: number): string;

package/dist/to-decimal.d.ts

@@ -1,16 +0,0 @@
-/**
- * Converts a bijective base-26 string to a decimal number.
- *
- * ```
- * import { toDecimal } from 'bb26'
- *
- * toDecimal('A')  // 1
- * toDecimal('B')  // 2
- * toDecimal('Z')  // 26
- * toDecimal('AA') // 27
- * toDecimal('AB') // 28
- * ```
- *
- * @param string
- */
-export default function toDecimal(string: string): number;