bb26 2.1.1 → 2.2.1

package/dist/increment.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var to_bb26_1 = require("./to-bb26");
-var to_decimal_1 = require("./to-decimal");
+const to_bb26_1 = __importDefault(require("./to-bb26"));
+const to_decimal_1 = __importDefault(require("./to-decimal"));
 /**
  * Increments a bijective base-26 string by one numeral.
  *
@@ -17,6 +20,6 @@ var to_decimal_1 = require("./to-decimal");
  * @return Incremented string
  */
 function increment(string) {
-    return to_bb26_1.default(to_decimal_1.default(string) + 1);
+    return (0, to_bb26_1.default)((0, to_decimal_1.default)(string) + 1);
 }
 exports.default = increment;

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,13 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toBb26 = exports.toDecimal = exports.range = exports.random = exports.increment = void 0;
-var increment_1 = require("./increment");
+exports.toDecimal = exports.toBb26 = exports.range = exports.random = exports.increment = void 0;
+const increment_1 = __importDefault(require("./increment"));
 exports.increment = increment_1.default;
-var random_1 = require("./random");
+const random_1 = __importDefault(require("./random"));
 exports.random = random_1.default;
-var range_1 = require("./range");
+const range_1 = __importDefault(require("./range"));
 exports.range = range_1.default;
-var to_decimal_1 = require("./to-decimal");
-exports.toDecimal = to_decimal_1.default;
-var to_bb26_1 = require("./to-bb26");
+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;

package/dist/random.d.ts

@@ -1,3 +1,2 @@
-declare function random(upper: string): string;
-declare function random(lower: string, upper: string): string;
-export default random;
+export default function random(upper: string): string;
+export default function random(lower: string, upper: string): string;

package/dist/random.js

@@ -1,7 +1,11 @@
 "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 });
-var range_1 = require("./range");
-var sample_1 = require("./sample");
+const random_item_1 = __importDefault(require("random-item"));
+const range_1 = __importDefault(require("./range"));
 /**
  * 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
@@ -19,8 +23,8 @@ var sample_1 = require("./sample");
  * @returns Random string
  */
 function random(lower, upper) {
-    var start = upper ? lower : 'A';
-    var end = upper || lower;
-    return sample_1.default(range_1.default(start, end));
+    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));
 }
 exports.default = random;

package/dist/range.d.ts

@@ -1,3 +1,2 @@
-declare function range(end: string): string[];
-declare function range(start: string, end: string): string[];
-export default range;
+export default function range(end: string): string[];
+export default function range(start: string, end: string): string[];

package/dist/range.js

@@ -1,7 +1,11 @@
 "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 });
-var to_decimal_1 = require("./to-decimal");
-var increment_1 = require("./increment");
+const to_decimal_1 = __importDefault(require("./to-decimal"));
+const increment_1 = __importDefault(require("./increment"));
 /**
  * Creates an array of bijective base-26 numerals progressing from `start` up
  * to, but not including, `end`.
@@ -22,12 +26,12 @@ var increment_1 = require("./increment");
  * @param end - The end of the range
  */
 function range(start, end) {
-    var range = [];
-    var _end = end || start;
-    var _start = end ? start : 'A';
-    for (var i = _start; to_decimal_1.default(i) < to_decimal_1.default(_end); i = increment_1.default(i)) {
-        range.push(i);
+    const _range = [];
+    const _end = end !== null && end !== void 0 ? 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)) {
+        _range.push(i);
     }
-    return range;
+    return _range;
 }
 exports.default = range;

package/dist/to-bb26.js

@@ -19,8 +19,8 @@ function toChar(number) {
  * @param number
  */
 function toBb26(number) {
-    var string = '';
-    var _number = number;
+    let string = '';
+    let _number = number;
     while (_number > 0) {
         string = toChar(_number % 26 || 26) + string;
         _number = Math.floor((_number - 1) / 26);

package/dist/to-decimal.js

@@ -22,9 +22,9 @@ function toDecimal(string) {
     if (!/[A-Z]/.test(string)) {
         throw new Error('String must contain only upper-case characters');
     }
-    var number = 0;
-    for (var i = 0; i < string.length; i++) {
-        var char = string[string.length - i - 1];
+    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);
     }
     return number;

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Patrik Csak
+Copyright (c) 2021 Patrik Csak
 
 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,41 +1,46 @@
 {
   "name": "bb26",
-  "version": "2.1.1",
-  "description": "Bijective base-26 utility functions for converting numbers to/from spreadsheet column letters",
-  "repository": "github:ptrkcsk/BB26",
-  "author": "Patrik Csak <p@trikcsak.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ptrkcsk/BB26/issues"
-  },
-  "homepage": "https://github.com/ptrkcsk/BB26#readme",
+  "version": "2.2.1",
+  "description": "Utilities for working with bijective base-26 numerals",
   "keywords": [
     "base 26",
     "bijective base 26",
     "hexavigesimal",
     "spreadsheet",
     "spreadsheet column",
-    "spreadsheet column letters"
+    "spreadsheet column letters",
+    "license plate serials"
   ],
-  "main": "dist",
+  "homepage": "https://github.com/ptrkcsk/BB26#readme",
+  "bugs": {
+    "url": "https://github.com/ptrkcsk/BB26/issues"
+  },
+  "license": "MIT",
+  "author": "Patrik Csak <p@trikcsak.com>",
   "files": [
     "dist"
   ],
+  "main": "dist",
+  "repository": "github:ptrkcsk/BB26",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint",
-    "prepublishOnly": "rm -fr dist && npm run build",
-    "test": "jest",
-    "test:coverage": "jest --coverage"
+    "format": "xo --fix",
+    "prepare": "del-cli dist && 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"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.15",
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
-    "eslint": "^7.13.0",
-    "jest": "^26.6.3",
-    "ts-jest": "^26.4.4",
-    "typescript": "^4.0.5"
+    "@tsconfig/recommended": "^1.0.1",
+    "ava": "^3.15.0",
+    "c8": "^7.10.0",
+    "del-cli": "^4.0.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.0.5",
+    "xo": "^0.39.1"
   },
   "types": "dist"
 }

package/readme.md

@@ -1,8 +1,19 @@
 # BB26
 
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/test_coverage)](https://codeclimate.com/github/ptrkcsk/BB26/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/maintainability)](https://codeclimate.com/github/ptrkcsk/BB26/maintainability) [![BB26 minified and gzipped size](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=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)
 
-JavaScript [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) utility functions for converting numbers to/from spreadsheet column letters
+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.
+
+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
 
@@ -35,7 +46,7 @@ random(upper: string): string
 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.
+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'
@@ -51,9 +62,7 @@ range(end: string): string[]
 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'.
+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'

package/dist/sample.d.ts

@@ -1 +0,0 @@
-export default function sample<T>(array: T[]): T;

package/dist/sample.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function sample(array) {
-    return array[Math.floor(Math.random() * array.length)];
-}
-exports.default = sample;