Merge pull request #26 from jakeboone02/drop-umd

v2

Author: jakeboone02

.codesandbox/ci.json

@@ -1,3 +1,4 @@
 {
-  "sandboxes": ["numeric-quantity-ci-p97jb"]
+  "sandboxes": ["/ci"],
+  "node": "18"
 }

.github/workflows/main.yml

@@ -8,22 +8,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # node: ['10.x', '12.x', '14.x']
-        node: ['14.x']
+        # node: ['14.x', '16.x', '18.x']
+        node: ['18.x']
         # os: [ubuntu-latest, windows-latest, macOS-latest]
         os: [ubuntu-latest]
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
 
-      - name: Use Node ${{ matrix.node }}
+      - name: Use Node ${{ matrix.node }} on ${{ matrix.os }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node }}
 
       - name: Install deps and build (with cache)
         uses: bahmutov/npm-install@v1
+        with:
+          install-command: yarn --immutable
 
       - name: Test
         run: yarn test --ci --maxWorkers=2
@@ -32,5 +34,5 @@ jobs:
         run: yarn build
 
       - name: Upload coverage to Codecov
-        if: matrix.os == 'ubuntu-latest' && matrix.node == '14.x'
+        if: matrix.os == 'ubuntu-latest' && matrix.node == '18.x'
         uses: codecov/codecov-action@v1

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "editor.formatOnSave": true
+  "editor.formatOnSave": true,
+  "prettier.prettierPath": "./node_modules/prettier"
 }

.yarn/releases/yarn-3.2.3.cjs

@@ -8,4 +8,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
     spec: "@yarnpkg/plugin-typescript"
 
-yarnPath: .yarn/releases/yarn-3.2.3.cjs
+yarnPath: .yarn/releases/yarn-3.6.0.cjs

.yarn/releases/yarn-3.6.0.cjs

@@ -1,37 +1,180 @@
-## 1.0.1 (2021-02-15)
+# Changelog
 
-- Added description to package.json
+All notable changes to this project will be documented in this file.
 
-## 1.0.0 (2021-02-11)
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-- New build system ([tsdx](https://tsdx.io/))
+## [Unreleased]
 
-## 0.5.1 (2019-08-24)
+### Changed
 
-- Fixed README.md note about return values
+- `numericQuantity` is now a named export; there is no default export.
+- UMD build assigns all exports, including `numericQuantity`, to the global object `NumericQuantity`. Previously, it assigned the main function to the global namespace as `numericQuantity`.
 
-## 0.5.0 (2019-08-24)
+### Added
 
-### Breaking change
+- Support for comma (`','`) and underscore (`'_'`) separators within Arabic numeral sequences. If a numeric sequence has a leading or trailing separator, that sequence will be considered invalid. This will cause `numericQuantity` to return `NaN` unless `allowTrailingInvalid` is `true` (see next item), in which case the sequence in question and everything after it will be ignored.
+- Options object as optional second parameter. Accepts the following options:
+  - `allowTrailingInvalid` (`boolean`, default `false`): Allows `numericQuantity` to more closely resemble the behavior of `parseFloat` by accepting and ignoring everything from the first invalid character to the end of the string.
+  - `romanNumerals` (`boolean`, default `false`): Enables support for Roman numerals with modern, strict rules, including the Unicode code points `U+2160` through `U+217F`. Roman numerals will only be parsed if an attempt to parse the string based on Arabic numerals fails. To parse Roman numerals unconditionally, call `parseRomanNumerals` directly.
+  - `round` (`number | false`, default `3`): Rounds the result to the specified number of decimal places. Use `round: false` to avoid rounding.
+- Support for Unicode "Fraction Numerator One" code point (`'⅟'`, `U+215F`), which must be followed by a numeric sequence (the denominator) to be considered part of a valid fraction representation.
+- Named exports of internal utilities like regular expressions, character maps, types, etc.
+- Build with ([tsup](https://tsup.egoist.dev/)).
 
-- Returns `NaN` for invalid inputs instead of `-1`
+## [v1.0.4] - 2022-04-16
 
-### Bug fixes
+### Fixed
 
-- Handles negative numbers properly (fixes [#3](https://github.com/jakeboone02/numeric-quantity/issues/3))
+- Corrected filenames in [package.json](./package.json).
 
-## 0.4.2 (2019-08-23)
+## [v1.0.3] - 2022-04-16
 
-- Rewritten with TypeScript
+### Added
 
-## 0.3.2 (2018-09-21)
+- Build with [Vite](https://vitejs.dev/).
 
-## 0.3.1 (2015-07-16)
+## [v1.0.2] - 2021-08-23
 
-## 0.3.0 (2015-07-16)
+### Added
 
-## 0.1.2 (2015-03-20)
+- [#21] Support for Unicode fraction slash (`⁄`, `U+2044`).
 
-## 0.1.1 (2015-03-19)
+## [v1.0.1] - 2021-02-15
 
-## 0.1.0 (2015-03-18)
+### Fixed
+
+- Added description to [package.json](./package.json).
+
+## [v1.0.0] - 2021-02-11
+
+### Added
+
+- [#12] New build system ([tsdx](https://tsdx.io/)).
+
+## [v0.5.2] - 2021-02-08
+
+### Fixed
+
+- Updated CI badges on [README.md](./README.md).
+
+## [v0.5.1] - 2019-08-24
+
+### Fixed
+
+- [README.md](./README.md) note about return values.
+
+## [v0.5.0] - 2019-08-24
+
+### Changed
+
+- Returns `NaN` for invalid inputs instead of `-1`.
+
+### Fixed
+
+- [#3] Handles negative numbers.
+
+## [v0.4.2] - 2019-08-23
+
+### Fixed
+
+- Publish `dist` directory only.
+
+## [v0.4.1] - 2019-08-23
+
+### Changed
+
+- Rewritten in TypeScript.
+
+### Added
+
+- Build with [Rollup](https://rollupjs.org/).
+
+## [v0.4.0] - 2019-08-22
+
+### Added
+
+- ESM and CJS builds.
+
+## [v0.3.3] - 2019-07-21
+
+### Added
+
+- JSDoc comments for tooltips
+
+## [v0.3.2] - 2018-09-21
+
+### Added
+
+- TypeScript types.
+
+## [v0.3.1] - 2015-07-16
+
+### Fixed
+
+- Documentation update.
+
+## [v0.3.0] - 2015-07-16
+
+### Added
+
+- UMD support.
+
+### Fixed
+
+- Minor bug fixes.
+
+## [v0.2.0] - 2015-05-14
+
+### Added
+
+- [#1] Accept decimals without a leading zero.
+
+## [v0.1.2] - 2015-03-20
+
+### Fixed
+
+- Minor performance improvement.
+
+## [v0.1.1] - 2015-03-19
+
+### Changed
+
+- Use `parseInt`/`parseFloat` instead of `str - 0` to parse numbers from strings.
+
+## [v0.1.0] - 2015-03-18
+
+### Added
+
+- Initial release.
+
+<!-- Issue/PR links -->
+
+[#1]: https://github.com/jakeboone02/numeric-quantity/issues/1
+[#3]: https://github.com/jakeboone02/numeric-quantity/issues/3
+[#21]: https://github.com/jakeboone02/numeric-quantity/pull/21
+[#12]: https://github.com/jakeboone02/numeric-quantity/pull/12
+
+<!-- Release comparison links -->
+
+[unreleased]: https://github.com/jakeboone02/numeric-quantity/compare/v1.0.4...HEAD
+[v1.0.4]: https://github.com/jakeboone02/numeric-quantity/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/jakeboone02/numeric-quantity/compare/v1.0.2...v1.0.3
+[v1.0.2]: https://github.com/jakeboone02/numeric-quantity/compare/v1.0.1...v1.0.2
+[v1.0.1]: https://github.com/jakeboone02/numeric-quantity/compare/v1.0.0...v1.0.1
+[v1.0.0]: https://github.com/jakeboone02/numeric-quantity/compare/v0.5.2...v1.0.0
+[v0.5.2]: https://github.com/jakeboone02/numeric-quantity/compare/v0.5.1...v0.5.2
+[v0.5.1]: https://github.com/jakeboone02/numeric-quantity/compare/v0.5.0...v0.5.1
+[v0.5.0]: https://github.com/jakeboone02/numeric-quantity/compare/v0.4.2...v0.5.0
+[v0.4.2]: https://github.com/jakeboone02/numeric-quantity/compare/v0.4.1...v0.4.2
+[v0.4.1]: https://github.com/jakeboone02/numeric-quantity/compare/v0.4.0...v0.4.1
+[v0.4.0]: https://github.com/jakeboone02/numeric-quantity/compare/v0.3.3...v0.4.0
+[v0.3.3]: https://github.com/jakeboone02/numeric-quantity/compare/v0.3.2...v0.3.3
+[v0.3.2]: https://github.com/jakeboone02/numeric-quantity/compare/v0.3.1...v0.3.2
+[v0.3.1]: https://github.com/jakeboone02/numeric-quantity/compare/v0.3.0...v0.3.1
+[v0.3.0]: https://github.com/jakeboone02/numeric-quantity/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/jakeboone02/numeric-quantity/compare/v0.1.2...v0.2.0
+[v0.1.2]: https://github.com/jakeboone02/numeric-quantity/compare/v0.1.1...v0.1.2
+[v0.1.1]: https://github.com/jakeboone02/numeric-quantity/compare/v0.1.0...v0.1.1
+[v0.1.0]: https://github.com/jakeboone02/numeric-quantity/tree/v0.1.0

.yarnrc.yml

@@ -1,47 +1,74 @@
 # numeric-quantity
 
-[![npm version](https://badge.fury.io/js/numeric-quantity.svg)](//npmjs.com/package/numeric-quantity)
-![workflow status](https://github.com/jakeboone02/numeric-quantity/workflows/Continuous%20Integration/badge.svg)
-[![codecov.io](https://codecov.io/github/jakeboone02/numeric-quantity/coverage.svg?branch=master)](https://codecov.io/github/jakeboone02/numeric-quantity?branch=master)
+[![npm][badge-npm]](https://www.npmjs.com/package/numeric-quantity)
+![workflow status](https://github.com/jakeboone02/numeric-quantity/actions/workflows/main.yml/badge.svg)
+[![codecov.io](https://codecov.io/github/jakeboone02/numeric-quantity/coverage.svg?branch=main)](https://codecov.io/github/jakeboone02/numeric-quantity?branch=main)
 [![downloads](https://img.shields.io/npm/dm/numeric-quantity.svg)](http://npm-stat.com/charts.html?package=numeric-quantity&from=2015-08-01)
 [![MIT License](https://img.shields.io/npm/l/numeric-quantity.svg)](http://opensource.org/licenses/MIT)
 
-Converts a string to a number. The string can include mixed numbers or vulgar fractions.
+Converts a string to a number, like an enhanced version of `parseFloat`. The return value will be `NaN` if the provided string does not resemble a number.
 
-For the inverse operation (converting a number to an imperial measurement), check out [format-quantity](https://www.npmjs.com/package/format-quantity).
+Features:
 
-For a more complete solution to parsing recipe ingredients, try [parse-ingredient](https://www.npmjs.com/package/parse-ingredient).
+- In addition to plain integers and decimals, `numeric-quantity` can parse numbers with comma or underscore separators (`'1,000'` or `'1_000'`), mixed numbers (`'1 2/3'`), vulgar fractions (`'1⅖'`), and the fraction slash character (`'1 2⁄3'`).
+- To allow and ignore trailing invalid characters _à la_ `parseFloat`, pass `{ allowTrailingInvalid: true }` as the second argument.
+- To parse Roman numerals like `'MCCXIV'` or `'Ⅻ'`, pass `{ romanNumerals: true }` as the second argument or call `parseRomanNumerals` directly.
+- Results will be rounded to three decimal places by default. To avoid rounding, pass `{ round: false }` as the second argument. To round to a different number of decimal places, assign that number to the `round` option (`{ round: 5 }` will round to five decimal places).
 
-## Installation
+> _For the inverse operation—converting a number to an imperial measurement—check out [format-quantity](https://www.npmjs.com/package/format-quantity)._
+>
+> _For a more complete solution to parsing recipe ingredients, try [parse-ingredient](https://www.npmjs.com/package/parse-ingredient)._
 
-### npm
+## Usage
+
+### Installed
 
-```shell
-# npm
-npm i numeric-quantity
+```js
+import { numericQuantity } from 'numeric-quantity';
 
-# yarn
-yarn add numeric-quantity
+console.log(numericQuantity('1 1/2')); // 1.5
+console.log(numericQuantity('2 2/3')); // 2.667
 ```
 
-### Browser
+### CDN
 
-In the browser, available as a global function `numericQuantity`.
+As an ES module:
+
+```html
+<script type="module">
+  import { numericQuantity } from 'https://cdn.jsdelivr.net/npm/numeric-quantity/+esm';
+
+  console.log(numericQuantity('10½')); // 10.5
+</script>
+```
+
+As UMD (all exports are properties of the global object `NumericQuantity`):
 
 ```html
 <script src="https://unpkg.com/numeric-quantity"></script>
 <script>
-  console.log(numericQuantity('10 1/2')); // 10.5
+  console.log(NumericQuantity.numericQuantity('xii')); // 12
 </script>
 ```
 
-## Usage
+## Other exports
 
-```js
-import numericQuantity from 'numeric-quantity';
-
-console.log(numericQuantity('1 1/2')); // 1.5
-console.log(numericQuantity('2 2/3')); // 2.666
-```
+| Name                              | Type        | Description                                                                                          |
+| --------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- |
+| `numericRegex`                    | `RegExp`    | Regular expression matching a string that resembles a number (using Arabic numerals) in its entirety |
+| `numericRegexWithTrailingInvalid` | `RegExp`    | Same as `numericRegex`, but allows/ignores trailing invalid characters.                              |
+| `VulgarFraction`                  | `type`      | Union type of all unicode vulgar fraction code points                                                |
+| `vulgarFractionsRegex`            | `RegExp`    | Regular expression matching the first unicode vulgar fraction code point                             |
+| `vulgarFractionToAsciiMap`        | `object`    | Mapping of each vulgar fraction to its traditional ASCII representation (e.g., `'½'` to `'1/2'`)     |
+| `parseRomanNumerals`              | `function`  | Same function signature as `numericQuantity`, but only for Roman numerals (used internally)          |
+| `romanNumeralRegex`               | `RegExp`    | Regular expression matching valid Roman numeral sequences (uses modern, strict rules)                |
+| `romanNumeralUnicodeRegex`        | `RegExp`    | Regular expression matching any unicode Roman numeral code point                                     |
+| `romanNumeralUnicodeToAsciiMap`   | `object`    | Mapping of each Roman numeral to its traditional ASCII representation (e.g., `'Ⅻ'` to `'XII'`)       |
+| `romanNumeralValues`              | `object`    | Mapping of each valid Roman numeral sequence fragment to its numeric value                           |
+| `NumericQuantityOptions`          | `interface` | Shape of the (optional) second argument to `numericQuantity`                                         |
+| `RomanNumeralAscii`               | `type`      | Union type of allowable Roman numeral characters (uppercase only)                                    |
+| `RomanNumeralUnicode`             | `type`      | Union type of all Unicode Roman numeral characters (representing 1-12, 50, 100, 500, and 1000)       |
+| `RomanNumeral`                    | `type`      | Union type of `RomanNumeralAscii` and `RomanNumeralUnicode`                                          |
+| `defaultOptions`                  | `object`    | Object representing the default options                                                              |
 
-The return value will be `NaN` if the provided string does not resemble a number.
+[badge-npm]: https://img.shields.io/npm/v/numeric-quantity.svg?cacheSeconds=3600&logo=npm

CHANGELOG.md

@@ -0,0 +1,10 @@
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <title>numeric-quantity CI Test Page</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script src="src/index.ts"></script>
+  </body>
+</html>