Merge pull request #14 from jakeboone02/trailing-quantities

Add support for trailing quantity/range and UOM

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Documentation
+on:
+  push:
+    branches: [main]
+
+jobs:
+  generate:
+    name: Generate documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun run docs
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: 'docs/'
+
+  deploy:
+    name: Deploy documentation site
+    needs: generate
+    runs-on: ubuntu-latest
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -3,3 +3,4 @@
 node_modules
 dist
 coverage
+docs

CHANGELOG.md

@@ -7,7 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-- N/A
+### Changed
+
+- `compactStringArray` has been removed. (`array.filter(Boolean)` is functionally equivalent to `compactStringArray(array)`.)
+
+### Added
+
+- If no quantity is detected at the beginning of an ingredient line, the _end_ of the line will be scanned for quantity/range and unit of measure.
 
 ## [v1.0.1] - 2023-07-26
 

README.md

@@ -50,14 +50,11 @@ If present (i.e., not `null`), the `unitOfMeasureID` property corresponds to a k
 
 ## Installation
 
-### npm/yarn
+### npm
 
 ```shell
-# npm
 npm i parse-ingredient
-
-# yarn
-yarn add parse-ingredient
+# OR yarn add / pnpm add / bun add
 ```
 
 ### Browser
@@ -132,6 +129,17 @@ console.log(parseIngredient('For cake:'));
 //     isGroupHeader: true,
 //   }
 // ]
+console.log(parseIngredient('Ripe tomato x2'));
+// [
+//   {
+//     quantity: 2,
+//     quantity2: null,
+//     unitOfMeasure: null,
+//     unitOfMeasureID: null,
+//     description: 'Ripe tomato',
+//     isGroupHeader: false,
+//   }
+// ]
 ```
 
 ## Options