Clean up

Author: rdmurphy

.github/workflows/nodejs.yml

@@ -3,7 +3,7 @@ name: Node CI
 on: [push, pull_request]
 
 env:
-  CI: "true"
+  CI: 'true'
 
 jobs:
   test:
@@ -28,7 +28,7 @@ jobs:
         uses: coverallsapp/[email protected]
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel: "true"
+          parallel: 'true'
   # coverage_complete:
   #   runs-on: ubuntu-latest
   #   needs:

.prettierignore

@@ -1,3 +1,4 @@
+coverage
 dist
 package.json
 package-lock.json

__tests__/apnumber.test.js

@@ -2,7 +2,7 @@ import apnumber from '../src/apnumber';
 
 describe('apnumber', () => {
   it('should correctly convert numbers', () => {
-    const testList = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10].map(n =>
+    const testList = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10].map((n) =>
       n.toString()
     );
 

__tests__/ordinal.test.js

@@ -7,6 +7,8 @@ describe('ordinal', () => {
       '2',
       '3',
       '4',
+      '9',
+      '10',
       '11',
       '12',
       '13',
@@ -20,6 +22,23 @@ describe('ordinal', () => {
       '2nd',
       '3rd',
       '4th',
+      '9th',
+      '10th',
+      '11th',
+      '12th',
+      '13th',
+      '101st',
+      '102nd',
+      '103rd',
+      '111th',
+    ];
+    const spelledOutOrdinalResultList = [
+      'first',
+      'second',
+      'third',
+      'fourth',
+      'ninth',
+      '10th',
       '11th',
       '12th',
       '13th',
@@ -32,6 +51,10 @@ describe('ordinal', () => {
     testList.forEach((n, idx) => {
       expect(ordinal(n)).toBe(resultList[idx]);
     });
+
+    testList.forEach((n, idx) => {
+      expect(ordinal(n, true)).toBe(spelledOutOrdinalResultList[idx]);
+    });
   });
 
   it('should return empty string when input is `undefined`', () => {

package-lock.json

@@ -45,21 +45,16 @@
   "homepage": "https://github.com/rdmurphy/journalize#readme",
   "devDependencies": {
     "@babel/preset-env": "^7.3.4",
+    "@newswire/prettier-config": "^3.0.0",
+    "@types/jest": "^25.2.1",
     "@zeit/git-hooks": "^0.1.4",
-    "coveralls": "^3.0.3",
+    "coveralls": "^3.0.13",
     "documentation": "^12.0.0",
     "jest": "^25.1.0",
     "microbundle": "^0.11.0",
     "precise-commits": "^1.0.2",
-    "prettier": "^1.16.4"
+    "prettier": "^2.0.5"
   },
   "dependencies": {},
-  "prettier": {
-    "bracketSpacing": true,
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5"
-  }
+  "prettier": "@newswire/prettier-config"
 }

package.json

@@ -3,7 +3,7 @@
  * JavaScript's life choices. Exported for testing purposes.
  *
  * @private
- * @type {Object}
+ * @type {object}
  */
 export const AP_MONTHS = {
   0: 'Jan.',

src/apmonth.js

@@ -3,7 +3,7 @@ import { isInteger, isNil } from './utils';
 /**
  * List of spelled out numbers per AP style.
  * @private
- * @type {Array}
+ * @type {string[]}
  */
 const AP_NUMBERS = [
   'one',

src/apnumber.js

@@ -3,7 +3,7 @@ import { isInteger, isNil } from './utils';
 /**
  * Array of suffixes to be used by intword.
  * @private
- * @type {Array}
+ * @type {string[]}
  */
 const SUFFIXES = [
   'million',

src/intword.js

@@ -3,23 +3,42 @@ import { isInteger, isNil } from './utils';
 /**
  * A list of suffixes for conversions.
  * @private
- * @type {Array}
+ * @type {string[]}
  */
 const SUFFIXES = ['th', 'st', 'nd', 'rd', 'th', 'th', 'th', 'th', 'th', 'th'];
 
+/**
+ * List of spelled out ordinals per AP style.
+ * @private
+ * @type {string[]}
+ */
+const AP_ORDINALS = [
+  'first',
+  'second',
+  'third',
+  'fourth',
+  'fifth',
+  'sixth',
+  'seventh',
+  'eighth',
+  'ninth',
+];
+
 /**
  * A list of funky English ordinals.
  * @private
- * @type {Array}
+ * @type {number[]}
  */
 const ENGLISH_ORDINAL_EXCEPTIONS = [11, 12, 13];
 
 /**
- * Converts an integer into its ordinal form. Handles the special cases of 11,
- * 12 and 13, too. If a non-integer is submitted, it will be returned in its
- * original form.
+ * Converts an integer into its ordinal form. If `spellOutOrdinals` is `true`,
+ * 1 through 9 will be spelled out per AP style. Handles the special cases of
+ * 11, 12 and 13, too. If a non-integer is submitted it will be returned in
+ * its original form.
  *
  * @param  {number|string} val
+ * @param {boolean} [spellOutOrdinals]
  * @return {string}
  * @example
  *
@@ -33,8 +52,11 @@ const ENGLISH_ORDINAL_EXCEPTIONS = [11, 12, 13];
  *
  * journalize.ordinal(103);
  * // returns '103rd'
+ *
+ * journalize.ordinal(7, true);
+ * // returns 'seventh'
  */
-export default function ordinal(val) {
+export default function ordinal(val, spellOutOrdinals = false) {
   // if `val` is undefined or null, return an empty string
   if (isNil(val)) return '';
 
@@ -43,9 +65,15 @@ export default function ordinal(val) {
   // if `convertedVal` is not an integer, return `val`
   if (!isInteger(convertedVal)) return val.toString();
 
+  // if `spellOutOrdinals` is true, return the spelled out versions of 1-9
+  if (spellOutOrdinals && convertedVal < 10) {
+    return AP_ORDINALS[convertedVal - 1];
+  }
+
   // if `convertedVal` is 11, 12 or 13, English gets weird
-  if (ENGLISH_ORDINAL_EXCEPTIONS.indexOf(convertedVal % 100) > -1)
+  if (ENGLISH_ORDINAL_EXCEPTIONS.indexOf(convertedVal % 100) > -1) {
     return convertedVal + SUFFIXES[0];
+  }
 
   return convertedVal + SUFFIXES[convertedVal % 10];
 }

src/ordinal.js

@@ -6,7 +6,7 @@
  * alternative plural suffix can be provided as the second parameter, and if
  * necessary, an alternative singular suffix can be provided as the third.
  *
- * @param {number|string|Array} value
+ * @param {number|string|array} value
  * @param {string} [pluralSuffix='s']
  * @param {string} [singularSuffix='']
  * @return {string}

src/pluralize.js

@@ -5,11 +5,11 @@ import { isNil } from './utils';
  * `null`/`undefined`, return a string according to the value. If `maybe` is not
  * provided, a `null` or `undefined` value will return the `no` argument.
  *
- * @param {boolean|Null|undefined} val
+ * @param {boolean|null|undefined} val
  * @param {string} [yes='yes']
  * @param {string} [no='no']
  * @param {string} [maybe='maybe']
- * @returns {string|boolean|Null|undefined}
+ * @returns {string|boolean|null|undefined}
  * @example
  *
  * var journalize = require('journalize');

src/yesno.js

@@ -65,14 +65,19 @@ export function intcomma(val: number | string): string;
 export function intword(val: number | string): string;
 
 /**
- * Converts an integer into its ordinal form. Handles the special cases of 11,
- * 12 and 13, too. If a non-integer is submitted, it will be returned in its
- * original form.
+ * Converts an integer into its ordinal form. If `spellOutOrdinals` is `true`,
+ * 1 through 9 will be spelled out per AP style. Handles the special cases of
+ * 11, 12 and 13, too. If a non-integer is submitted it will be returned in
+ * its original form.
  *
  * @param val The supplied value
+ * @param spellOutOrdinals If true, 1 through 9 will be spelled out
  * @returns The converted value
  */
-export function ordinal(val: number | string): string;
+export function ordinal(
+  val: number | string,
+  spellOutOrdinals?: boolean
+): string;
 
 /**
  * Returns a plural suffix if the value is not 1. By default, `pluralize`