🔢 @lets/count: Consistent counter

Author: omrilotan

packages/count/.npmignore

@@ -0,0 +1,3 @@
+.*
+*.log
+spec.js

packages/count/.npmrc

@@ -0,0 +1,2 @@
+package-lock=false
+access=public

packages/count/README.md

@@ -0,0 +1,36 @@
+# count [![](https://img.shields.io/npm/v/@lets/count.svg)](https://www.npmjs.com/package/@lets/count) [![](https://img.shields.io/badge/source--000000.svg?logo=github&style=social)](https://github.com/omrilotan/mono/tree/master/packages/count)
+
+## 🔢 Consistent counter
+
+```js
+// Just count
+count() // 1st
+count() // 2nd
+
+// Set counter
+count.set(14)
+count() // 15th
+count() // 16th
+
+// Start counting from
+count.from(10)
+count() // 11th
+count() // 12th
+
+// Count down
+count.down() // 11th
+count.down() // 10th
+
+// Reset counter to 0
+count.reset()
+count.down() // -1st
+count.down() // -2nd
+```
+
+## Transpiled version
+Environments which exclude node_modules from the transpiling pipeline should include the "browser" entry instead of "main". This exposes an ES5 commonjs module.
+
+Also available for explicit import:
+```js
+const count = require('@lets/count/dist');
+```

packages/count/index.js

@@ -0,0 +1,43 @@
+const original = require('ordinal');
+const ordinal = num => num < 0
+	? ['-', original(Math.abs(num))].join('')
+	: original(num);
+
+let current = 0;
+
+/**
+ * Count
+ * @return {String}
+ */
+const count = () => ordinal(++current);
+
+/**
+ * Set
+ * @param  {Number} number
+ * @return {count}
+ */
+count.set = number => {
+	current = number;
+	return count;
+}
+
+/**
+ * From
+ * @param  {Number} number
+ * @return {String}
+ */
+count.from = number => count.set(number)();
+
+/**
+ * Reset to 0
+ * @return {count}
+ */
+count.reset = () => count.set(0);
+
+/**
+ * Count down
+ * @return {String}
+ */
+count.down = () => ordinal(--current);
+
+module.exports = count;

packages/count/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@lets/count",
+  "version": "0.0.0",
+  "description": "🔢 Consistent counter",
+  "keywords": [
+    "count",
+    "consistent",
+    "ordinal",
+    "1st",
+    "2nd",
+    "🔢"
+  ],
+  "author": "omrilotan",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omrilotan/mono.git"
+  },
+  "homepage": "https://omrilotan.com/mono/count/",
+  "browser": "dist/index.js",
+  "main": "index.js",
+  "scripts": {
+    "dist": "mkdir -p dist; ../../node_modules/.bin/babel index.js --out-file dist/index.js --config-file ../../.babelrc.js",
+    "test": "cd ../../; npm t packages/count; cd -"
+  },
+  "dependencies": {
+    "ordinal": "^1.0.2"
+  }
+}

packages/count/spec.js

@@ -0,0 +1,35 @@
+const count = require('.');
+
+describe('count', () => {
+	it('Should count', () => {
+		expect(count()).to.equal('1st');
+		expect(count()).to.equal('2nd');
+	});
+	it('Should continue to count', () => {
+		expect(count()).to.equal('3rd');
+		expect(count()).to.equal('4th');
+	});
+	it('Should reset to 0', () => {
+		expect(count()).to.equal('5th');
+		count.reset();
+		expect(count()).to.equal('1st');
+	});
+	it('Should set to given number', () => {
+		expect(count()).to.equal('2nd');
+		count.set(6);
+		expect(count()).to.equal('7th');
+	});
+	it('Should start from given number', () => {
+		expect(count()).to.equal('8th');
+		expect(count.from(6)).to.equal('7th');
+	});
+	it('Should count down', () => {
+		expect(count.down()).to.equal('6th');
+		expect(count.down()).to.equal('5th');
+	});
+	it('Should count negative numbers', () => {
+		count.reset();
+		expect(count.down()).to.equal('-1st');
+		expect(count.down()).to.equal('-2nd');
+	});
+});