@rent-scraper/create-config 1.0.31 → 1.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
|
1
1
|
# @rent-scraper/create-config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Interactive CLI wizard for creating and updating `config.zillow.yaml` / `config.redfin.yaml`.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Start wizard (production build)
|
|
9
|
+
pnpm run create-config
|
|
10
|
+
|
|
11
|
+
# Start wizard (dev, no build)
|
|
12
|
+
pnpm run create-config:dev
|
|
13
|
+
|
|
14
|
+
# Validate and update an existing config (generate region IDs etc.)
|
|
15
|
+
pnpm run check-config
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## What It Does
|
|
19
|
+
|
|
20
|
+
On first run, the wizard asks for:
|
|
21
|
+
|
|
22
|
+
- **Source** — Zillow or Redfin
|
|
23
|
+
- **Output path** — where scraped data and CSVs are saved
|
|
24
|
+
- **Zip codes** — comma-separated list (validates format, lets you fix invalid entries)
|
|
25
|
+
- **Days listed** — how many days back to search (1–90)
|
|
26
|
+
|
|
27
|
+
The config is saved as YAML. Subsequent runs detect the existing file and prompt only for missing or updated fields.
|
|
28
|
+
|
|
29
|
+
## Config File Location
|
|
30
|
+
|
|
31
|
+
In a pnpm workspace (development), the config is written alongside the workspace root:
|
|
32
|
+
|
|
33
|
+
- `config.zillow.yaml`
|
|
34
|
+
- `config.redfin.yaml`
|
|
35
|
+
|
|
36
|
+
Outside a workspace (production / `npx` usage), a pointer file is stored at the platform config directory (via `env-paths`) and the actual config is saved to `~/rent-scraper/` by default.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rent-scraper/create-config",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.33",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
"minimist": "^1.2.8",
|
|
47
47
|
"picocolors": "^1.1.1",
|
|
48
48
|
"puppeteer": "^24.11.2",
|
|
49
|
-
"@rent-scraper/
|
|
50
|
-
"@rent-scraper/
|
|
51
|
-
"@rent-scraper/
|
|
49
|
+
"@rent-scraper/browser-server": "1.0.33",
|
|
50
|
+
"@rent-scraper/api": "1.0.33",
|
|
51
|
+
"@rent-scraper/utils": "1.0.33"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"@types/minimist": "^1.2.5",
|