Skip to content

Commit 7ed02be

Browse files
committed
minor change to prevent remark errors
1 parent 03c6ea5 commit 7ed02be

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

scripts/storage-finder-data-generator/MAINTENANCE.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This approach aims to balance user-friendliness (content editors update the Goog
44

55
## What the CLI does
66

7-
- Reads a CSV export of the shared Google Sheet (either via `STORAGE_FINDER_SHEET_URL` or `--csv <path>`).
8-
- Applies the questions/choices/matchers defined in `scripts/storage-finder-data-generator/config.ts`.
9-
- Generates `facet-tree.json` and `service-list.json` with slug-based IDs.
7+
- Reads a CSV export of the shared Google Sheet (either via `STORAGE_FINDER_SHEET_URL` or `--csv <path>`).
8+
- Applies the questions/choices/matchers defined in `scripts/storage-finder-data-generator/config.ts`.
9+
- Generates `facet-tree.json` and `service-list.json` with slug-based IDs.
1010

1111
## How to regenerate data
1212

@@ -16,30 +16,30 @@ bun scripts/storage-finder-data-generator/generate.ts \
1616
--output src/data/storage-finder
1717
```
1818

19-
- Omit `--csv` to download from `STORAGE_FINDER_SHEET_URL`.
20-
- Use `--output` to write elsewhere (defaults to `src/data/storage-finder/generated` in the code).
21-
- If you do not have Bun, install it from [https://bun.sh/](https://bun.sh/) or run with `pnpm dlx tsx scripts/storage-finder-data-generator/generate.ts ...`. Node does not run TypeScript by default; `tsx` provides the TypeScript loader.
19+
- Omit `--csv` to download from `STORAGE_FINDER_SHEET_URL`.
20+
- Use `--output` to write elsewhere (defaults to `src/data/storage-finder/generated` in the code).
21+
- If you do not have Bun, install it from [https://bun.sh/](https://bun.sh/) or run with `pnpm dlx tsx scripts/storage-finder-data-generator/generate.ts ...`. Node does not run TypeScript by default; `tsx` provides the TypeScript loader.
2222

2323
## How to add or change a question
2424

25-
1. Add a column to the sheet that contains the signals you want to match.
26-
2. In `scripts/storage-finder-data-generator/config.ts`, add a new facet entry to `FACET_CONFIGS`:
27-
- Set `id` (slug), `name`, `controlType` (`radio` or `checkbox`), `column` (sheet column name), and `choices` (labels the app should show).
28-
- Add `matchers`: regex patterns that map cell text to choice IDs. Include `allowMultipleMatches: true` if a radio question legitimately matches more than one choice.
29-
- If no regex matches, `fallback: "all"` keeps the service visible; otherwise supply an explicit array of choice IDs.
30-
3. Regenerate with the CLI and verify in the app.
25+
1. Add a column to the sheet that contains the signals you want to match.
26+
2. In `scripts/storage-finder-data-generator/config.ts`, add a new facet entry to `FACET_CONFIGS`:
27+
- Set `id` (slug), `name`, `controlType` (`radio` or `checkbox`), `column` (sheet column name), and `choices` (labels the app should show).
28+
- Add `matchers`: regex patterns that map cell text to choice IDs. Include `allowMultipleMatches: true` if a radio question legitimately matches more than one choice.
29+
- If no regex matches, `fallback: "all"` keeps the service visible; otherwise supply an explicit array of choice IDs.
30+
3. Regenerate with the CLI and verify in the app.
3131

3232
## Service fields
3333

3434
Field definitions live in `scripts/storage-finder-data-generator/config.ts` (`FIELD_DEFINITIONS`). They map sheet columns to service detail rows (Links, Use Case, Limitations, Permission Settings, Eligibility, Synchronous Access, Alumni Access, Backup). Adjust labels or formatters there if the sheet schema changes.
3535

3636
## Naming and IDs
3737

38-
- Services are slugged from the `Title` column; duplicates get `-2`, `-3`, etc.
39-
- Facet and choice IDs are slugs defined in `config.ts`; keep them stable to avoid breaking references.
38+
- Services are slugged from the `Title` column; duplicates get `-2`, `-3`, etc.
39+
- Facet and choice IDs are slugs defined in `config.ts`; keep them stable to avoid breaking references.
4040

4141
## Validation rules
4242

43-
- Radio facets throw if more than one choice matches unless `allowMultipleMatches` is set.
44-
- Blank cells render as “Not Available” in service fields.
45-
- Regexes match against raw cell text; use clear keywords in the sheet for deterministic mapping.
43+
- Radio facets throw if more than one choice matches unless `allowMultipleMatches` is set.
44+
- Blank cells render as “Not Available” in service fields.
45+
- Regexes match against raw cell text; use clear keywords in the sheet for deterministic mapping.

0 commit comments

Comments
 (0)