bb26 2.2.1 → 3.0.1

package/dist/increment.js

@@ -1,10 +1,4 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const to_bb26_1 = __importDefault(require("./to-bb26"));
-const to_decimal_1 = __importDefault(require("./to-decimal"));
+import { toBb26, toDecimal } from './index.js';
 /**
  * Increments a bijective base-26 string by one numeral.
  *
@@ -19,7 +13,6 @@ const to_decimal_1 = __importDefault(require("./to-decimal"));
  * @param string - String to increment
  * @return Incremented string
  */
-function increment(string) {
-    return (0, to_bb26_1.default)((0, to_decimal_1.default)(string) + 1);
+export default function increment(string) {
+    return toBb26(toDecimal(string) + 1);
 }
-exports.default = increment;

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import increment from './increment';
-import random from './random';
-import range from './range';
-import toBb26 from './to-bb26';
-import toDecimal from './to-decimal';
-export { increment, random, range, toBb26, toDecimal };
+export { default as increment } from './increment.js';
+export { default as range } from './range.js';
+export { default as random } from './random.js';
+export { default as toBb26 } from './to-bb26.js';
+export { default as toDecimal } from './to-decimal.js';

package/dist/index.js

@@ -1,16 +1,5 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDecimal = exports.toBb26 = exports.range = exports.random = exports.increment = void 0;
-const increment_1 = __importDefault(require("./increment"));
-exports.increment = increment_1.default;
-const random_1 = __importDefault(require("./random"));
-exports.random = random_1.default;
-const range_1 = __importDefault(require("./range"));
-exports.range = range_1.default;
-const to_bb26_1 = __importDefault(require("./to-bb26"));
-exports.toBb26 = to_bb26_1.default;
-const to_decimal_1 = __importDefault(require("./to-decimal"));
-exports.toDecimal = to_decimal_1.default;
+export { default as increment } from './increment.js';
+export { default as range } from './range.js';
+export { default as random } from './random.js';
+export { default as toBb26 } from './to-bb26.js';
+export { default as toDecimal } from './to-decimal.js';

package/dist/random.js

@@ -1,11 +1,6 @@
-"use strict";
-/* eslint-disable @typescript-eslint/unified-signatures, no-redeclare */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const random_item_1 = __importDefault(require("random-item"));
-const range_1 = __importDefault(require("./range"));
+/* eslint-disable @typescript-eslint/unified-signatures */
+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
@@ -22,9 +17,8 @@ const range_1 = __importDefault(require("./range"));
  * @param upper
  * @returns Random string
  */
-function random(lower, upper) {
+export default function random(lower, upper) {
     const start = upper ? lower : 'A';
-    const end = upper !== null && upper !== void 0 ? upper : lower;
-    return (0, random_item_1.default)((0, range_1.default)(start, end));
+    const end = upper ?? lower;
+    return randomItem(range(start, end));
 }
-exports.default = random;

package/dist/range.js

@@ -1,11 +1,5 @@
-"use strict";
-/* eslint-disable @typescript-eslint/unified-signatures, no-redeclare */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const to_decimal_1 = __importDefault(require("./to-decimal"));
-const increment_1 = __importDefault(require("./increment"));
+/* eslint-disable @typescript-eslint/unified-signatures */
+import { toDecimal, increment } from './index.js';
 /**
  * Creates an array of bijective base-26 numerals progressing from `start` up
  * to, but not including, `end`.
@@ -25,13 +19,12 @@ const increment_1 = __importDefault(require("./increment"));
  * @param start - The start of the range
  * @param end - The end of the range
  */
-function range(start, end) {
+export default function range(start, end) {
     const _range = [];
-    const _end = end !== null && end !== void 0 ? end : start;
+    const _end = end ?? start;
     const _start = end ? start : 'A';
-    for (let i = _start; (0, to_decimal_1.default)(i) < (0, to_decimal_1.default)(_end); i = (0, increment_1.default)(i)) {
+    for (let i = _start; toDecimal(i) < toDecimal(_end); i = increment(i)) {
         _range.push(i);
     }
     return _range;
 }
-exports.default = range;

package/dist/to-bb26.js

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 function toChar(number) {
-    return String.fromCharCode('A'.charCodeAt(0) - 1 + number);
+    return String.fromCodePoint('A'.codePointAt(0) - 1 + number);
 }
 /**
  * Converts a decimal number to a bijective base-26 string.
@@ -18,7 +16,7 @@ function toChar(number) {
  *
  * @param number
  */
-function toBb26(number) {
+export default function toBb26(number) {
     let string = '';
     let _number = number;
     while (_number > 0) {
@@ -27,4 +25,3 @@ function toBb26(number) {
     }
     return string;
 }
-exports.default = toBb26;

package/dist/to-decimal.js

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 function charToDecimal(letter) {
-    return letter.charCodeAt(0) - 'A'.charCodeAt(0) + 1;
+    return letter.codePointAt(0) - 'A'.codePointAt(0) + 1;
 }
 /**
  * Converts a bijective base-26 string to a decimal number.
@@ -18,15 +16,14 @@ function charToDecimal(letter) {
  *
  * @param string
  */
-function toDecimal(string) {
+export default function toDecimal(string) {
     if (!/[A-Z]/.test(string)) {
         throw new Error('String must contain only upper-case characters');
     }
     let number = 0;
     for (let i = 0; i < string.length; i++) {
         const char = string[string.length - i - 1];
-        number += Math.pow(26, i) * charToDecimal(char);
+        number += 26 ** i * charToDecimal(char);
     }
     return number;
 }
-exports.default = toDecimal;

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Patrik Csak
+Copyright (c) Patrik Csak <p@trikcsak.com> (https://patrikcsak.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb26",
-  "version": "2.2.1",
+  "version": "3.0.1",
   "description": "Utilities for working with bijective base-26 numerals",
   "keywords": [
     "base 26",
@@ -20,27 +20,30 @@
   "files": [
     "dist"
   ],
-  "main": "dist",
   "repository": "github:ptrkcsk/BB26",
   "scripts": {
-    "build": "tsc",
+    "build": "del-cli dist && tsc",
     "format": "xo --fix",
-    "prepare": "del-cli dist && npm run build",
+    "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"
   },
   "dependencies": {
-    "random-item": "^3.1.0"
+    "random-item": "^4.0.1"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.1",
-    "ava": "^3.15.0",
+    "@sindresorhus/tsconfig": "^3.0.1",
+    "ava": "^5.2.0",
     "c8": "^7.10.0",
-    "del-cli": "^4.0.1",
+    "del-cli": "^5.0.0",
     "ts-node": "^10.4.0",
-    "typescript": "^4.0.5",
-    "xo": "^0.39.1"
+    "typescript": "^5.0.2",
+    "xo": "^0.53.1"
   },
-  "types": "dist"
+  "engines": {
+    "node": ">=14 <=19"
+  },
+  "exports": "./dist/index.js",
+  "type": "module"
 }

package/readme.md

@@ -1,111 +1,115 @@
 # BB26
 
-[![BB26 minified and gzipped size](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=bb26) [![BB26 downloads per month on npm](https://badgen.net/npm/dw/bb26)](https://www.npmjs.com/package/bb26) [![Test Coverage](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/test_coverage)](https://codeclimate.com/github/ptrkcsk/BB26/test_coverage)
+[![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
 
 ## What is bijective base-26 numeration?
 
-You're probably familiar with BB26 numeration. It's used for spreadsheet columns, license plate serials, and (probably?) more.
+You’re probably familiar with BB26 numeration. It’s used for spreadsheet columns, license plate serials, and (probably?) more.
 
-Here's an example of decimal (base-10) numbers (the numbers you use every day to count things) compared to their corresponding BB26 numbers:
+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 | ...
 ```
 
-## Installation
+## 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
 npm install bb26
 ```
 
-## Usage
+## API
 
-### Increment
+### `increment()`
 
-```
-increment(string: string): string
+```ts
+function increment(string: string): string;
 ```
 
 Increments a bijective base-26 string by one numeral.
 
 ```js
-import { increment } from 'bb26'
+import { increment } from "bb26";
 
-increment('A')  // 'B'
-increment('Z')  // 'AA'
-increment('AA') // 'AB'
+increment("A");  // 'B'
+increment("Z");  // 'AA'
+increment("AA"); // 'AB'
 ```
 
-### Random
+### `random()`
 
-```
-random(upper: string): string
-random(lower: string, upper: string): string
+```ts
+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'
+import { random } from "bb26";
 
-random('AAA')         // 'NE'
-random('AAA', 'AAAA') // 'KXZ'
+random("AAA");         // 'NE'
+random("AAA", "AAAA"); // 'KXZ'
 ```
 
-### Range
+### `range()`
 
-```
-range(end: string): string[]
-range(start: string, end: string): string[]
+```ts
+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'
+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']
 ```
 
-### Convert from decimal to BB26
+### `toBb26()`
 
-```
-toBb26(number: number): string
+```ts
+function toBb26(number: number): string;
 ```
 
 Converts a decimal number to a bijective base-26 string.
 
 ```js
-import { toBb26 } from 'bb26'
+import { toBb26 } from "bb26";
 
-toBb26(1)  // 'A'
-toBb26(2)  // 'B'
-toBb26(26) // 'Z'
-toBb26(27) // 'AA'
-toBb26(28) // 'AB'
+toBb26(1);  // 'A'
+toBb26(2);  // 'B'
+toBb26(26); // 'Z'
+toBb26(27); // 'AA'
+toBb26(28); // 'AB'
 ```
 
-### Convert from BB26 to decimal
+### `toDecimal()`
 
-```
-toDecimal(string: string): number
+```ts
+function toDecimal(string: string): number;
 ```
 
 Converts a bijective base-26 string to a decimal number.
 
 ```js
-import { toDecimal } from 'bb26'
+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
 ```