rent-scraper 1.0.0 → 1.0.6

package/README.md

@@ -0,0 +1,39 @@
+# rent-scraper
+
+Scrape data from rental listings
+
+### Prerequisites
+
+- Node.js >= 22
+- pnpm package manager
+- Google Chrome or Brave browser installed
+
+### Setup Steps
+
+1. Install pnpm globally (if not already installed):
+
+   ```bash
+   npm install -g pnpm
+   ```
+
+2. Clone the repository and install dependencies:
+
+   ```bash
+   git clone [repository-url]
+   cd rent-scraper
+   pnpm install
+   ```
+
+3. Build the project:
+
+   ```bash
+   pnpm run build
+   ```
+
+## Usage
+
+### Running the Scraper
+
+```bash
+pnpm run rent-scraper
+```

package/package.json

@@ -1,53 +1,48 @@
 {
   "name": "rent-scraper",
-  "version": "1.0.0",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
-    }
-  },
-  "author": "Max Stein <maxwell.stein@gmail.com> (https://maxstein.net)",
+  "version": "1.0.6",
   "license": "MIT",
-  "description": "Scrape data from rental listings from the command line",
+  "description": "Tools for scraping rent data",
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "start": "node --env-file-if-exists=.env dist/bin/run-rent-scraper.mjs",
-    "dev": "tsx --env-file-if-exists=.env src/bin/run-rent-scraper.ts",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "prepublish": "npm run lint && npm run build",
-    "release": "npm run lint && npm run build && bumpp && npm publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/rent-brigade/rent-scraper.git",
-    "directory": "packages/cli"
-  },
-  "dependencies": {
-    "@clack/prompts": "alpha",
-    "@rent-scraper/api": "workspace:*",
-    "@rent-scraper/browser-server": "workspace:*",
-    "@rent-scraper/create-config": "workspace:*",
-    "@rent-scraper/scrape-listings": "workspace:*",
-    "@rent-scraper/utils": "workspace:*",
-    "axios": "^1.10.0",
-    "bumpp": "^10.2.3",
-    "dayjs": "^1.11.13",
-    "minimist": "^1.2.8",
-    "picocolors": "^1.1.1"
-  },
+  "type": "module",
   "devDependencies": {
-    "@types/minimist": "^1.2.5",
-    "tsx": "^4.20.3",
-    "unbuild": "^3.5.0"
+    "@eslint/js": "^9.30.1",
+    "@stylistic/eslint-plugin": "^5.1.0",
+    "eslint": "^9.30.1",
+    "globals": "^16.3.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.6.2",
+    "typescript-eslint": "^8.35.1"
   },
   "engines": {
     "node": "22.x"
+  },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "eslint"
+    ],
+    "*.{json,md}": [
+      "prettier --write"
+    ]
+  },
+  "scripts": {
+    "build": "pnpm run --parallel build",
+    "browser-server:dev": "pnpm run --filter browser-server dev",
+    "browser-server": "pnpm run --silent --filter browser-server start",
+    "check-config:dev": "pnpm run --filter create-config check-config:dev",
+    "check-config": "pnpm run --silent --filter create-config check-config",
+    "scrape-listings:dev": "pnpm run --filter scrape-listings dev",
+    "scrape-listings": "pnpm run --silent --filter scrape-listings start",
+    "create-config:dev": "pnpm run --filter create-config dev",
+    "create-config": "pnpm run --silent --filter create-config start",
+    "rent-scraper:dev": "pnpm run --filter rent-scraper dev",
+    "rent-scraper": "pnpm run --silent --filter rent-scraper start",
+    "typecheck": "pnpm run --parallel typecheck",
+    "lint": "pnpm run --parallel lint",
+    "lint:fix": "pnpm run --parallel lint:fix",
+    "release": "pnpm --parallel prepublish && bumpp -r && pnpm publish -r --no-git-checks --access=public"
   }
-}
+}

package/dist/bin/run-rent-scraper.d.mts

@@ -1 +0,0 @@
-

package/dist/bin/run-rent-scraper.mjs

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import e from"minimist";import{log as s}from"@clack/prompts";import{parseError as t}from"@rent-scraper/utils";import{runRentScraper as i}from"../index.mjs";import"@rent-scraper/utils/config";import"@rent-scraper/create-config";import"@rent-scraper/scrape-listings";const m=e(process.argv.slice(2)),p=m.source??"zillow";i(p).then(()=>process.exit(0)).catch(r=>{const{message:o}=t(r);s.error(o),process.exit(1)});

package/dist/index.d.mts

@@ -1,5 +0,0 @@
-import { ListingsSource } from '@rent-scraper/api';
-
-declare function runRentScraper(source: ListingsSource): Promise<void>;
-
-export { runRentScraper };

package/dist/index.mjs

@@ -1 +0,0 @@
-import{checkForConfigFile as a}from"@rent-scraper/utils/config";import{runCreateConfig as n,runCheckConfig as i,runGenerateRegionIds as t}from"@rent-scraper/create-config";import{runScrapeListings as e}from"@rent-scraper/scrape-listings";async function o(r){await a(r)||await n(),await i(r),await t(r),await e()}export{o as runRentScraper};