feat: cli scraping

README.md

@@ -5,7 +5,7 @@ Scrap food recipe data from various websites that support JSON+LD and Microdata
 ## Install
 
 ```bash
-> npm install --save @dimfu/recipe-scraper
+npm install --save @dimfu/recipe-scraper
 ```
 
 ## Usage
@@ -148,6 +148,30 @@ getRecipeData(options).then((recipe) => {
 
 You can specify the URL by either passing it as the first parameter, or by setting it in the options object.
 
+## Command line usage
+
+### Using without installation
+
+```bash
+npx @dimfu/recipe-scraper https://example/recipes/creamy-courgette-potato-bake 
+```
+
+> Note: Use this method only if you plan to use for one time, installing globally (see-below) is recommended for multiple time usages.
+
+### Installation
+
+```bash
+npm install @dimfu/recipe-scraper -g
+```
+
+> Note for Linux & MacOS users: DO NOT use sudo to install global packages! The correct way is to tell npm where to install its global packages: npm config set prefix ~/.local. Make sure ~/.local/bin is added to PATH.
+
+### Usage after installation
+
+```
+@dimfu/recipe-scraper https://example/recipes/creamy-courgette-potato-bake
+```
+
 ## License
 
 Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimfu/recipe-scraper",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Extract recipe data from the web effortlessly",
   "publishConfig": {
     "access": "public"
@@ -30,16 +30,18 @@
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "bin": "./dist/cli.js",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build-fast": "tsup src/index.ts --format cjs,esm",
+    "build-fast": "tsup src/index.ts --format cjs,esm && tsup src/cli.ts",
     "build": "pnpm run build-fast --dts-resolve",
     "prepublishOnly": "pnpm run build"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^0.39.4",
+    "@types/node": "^20.2.5",
     "eslint": "^8.41.0",
     "lint-staged": "^13.2.2",
     "simple-git-hooks": "^2.8.1",
@@ -55,6 +57,7 @@
   "dependencies": {
     "axios": "^1.4.0",
     "cheerio": "1.0.0-rc.12",
+    "commander": "^10.0.1",
     "iso8601-duration": "^2.1.1",
     "jsonschema": "^1.4.1",
     "microdata-node": "^2.0.0",

src/cli.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+import { program } from 'commander'
+import pkg from '../package.json'
+import getRecipeData from '.'
+
+const { name, description, version } = pkg
+
+program.name(`npx ${name}`).version(version).allowExcessArguments(false).arguments('<url>').description(description, { url: 'food recipe url' }).action(async (url) => {
+  try {
+    console.log(await (getRecipeData(url)))
+  }
+  catch (err: unknown) {
+    console.error((err as { message: string }).message)
+    process.exit(1)
+  }
+})
+
+program.parseAsync().catch((e: unknown) => {
+  console.error((e as { message: string }).message)
+  process.exit(1)
+})