portaljs-add-resource

$npx mdskill add datopian/portaljs/portaljs-add-resource

Add a resource file to an existing PortalJS dataset.

  • Solves adding a second file like a data dictionary or methodology.
  • Depends on Read, Write, Edit, Bash, and WebFetch tools.
  • Determines the dataset's current resources array and appends the new file.
  • Updates the dataset's metadata file and optionally fetches the resource content.

SKILL.md

.github/skills/portaljs-add-resourceView on GitHub ↗
---
name: portaljs-add-resource
description: Add another file (resource) to an EXISTING dataset in a PortalJS portal — a data dictionary, methodology, or an additional data file. Turns a single-file dataset into a multi-resource one; the showcase renders a section per resource. Use when a dataset needs a second file, such as a data dictionary, methodology doc, or an additional period's data.
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(curl:*), Bash(mkdir:*), Bash(cp:*), WebFetch
version: 1.0.0
author: Datopian <[email protected]>
license: MIT
compatibility: Claude Code with PortalJS portals (Next.js 14, React 18, Node 18+). Runs from any project via the plugin, a personal ~/.claude/commands install, or a portaljs clone.
tags:
  - portaljs
  - data-portal
  - resource
  - data-dictionary
  - metadata
  - catalog
---

# PortalJS — Add Resource

## Overview

Add a resource — an additional file — to a dataset that already exists in a
`portaljs-catalog` portal. Where `/portaljs-add-dataset` creates a **new** dataset
(one file), this skill adds a file to an **existing** one: a data dictionary, a
methodology document, or another data file (e.g. a second year's figures).

Mirrors the Frictionless Data Package model: a dataset holds a `resources[]` array,
and the showcase at `/@<namespace>/<slug>` renders one section per resource (preview,
schema, download). A single-file dataset migrates to `resources[]` automatically the
first time a second file is added — no data is lost.

## Prerequisites

- An existing PortalJS portal (`portaljs-catalog` template) with `datasets.json`,
  `package.json`, and `pages/[owner]/[slug].tsx` present.
- The target dataset already registered in `datasets.json`.
- The new resource's source: a local file path or a public URL, in CSV, TSV, JSON
  (array), or GeoJSON format.
- Node 18+ installed to run `npx next build` for verification.

## Instructions

The canonical, full step-by-step workflow lives in
[`.claude/commands/portaljs-add-resource.md`](https://github.com/datopian/portaljs/blob/main/.claude/commands/portaljs-add-resource.md)
in this repository — that file is the single source of truth. Read and follow it. Summary:

1. Gather input (interview if thin): `DATASET` (slug or `namespace/slug`), `SOURCE`
   (path or URL), `PORTAL_DIR` (default `.`), `RESOURCE_NAME`, `RESOURCE_TITLE`,
   `DESCRIPTION`. If `DATASET` or `SOURCE` is missing, list datasets from
   `datasets.json` and ask.
2. Validate the portal and locate the dataset entry by slug (and namespace, if
   given). If the dataset does not exist, offer `/portaljs-add-dataset` instead.
3. Detect the format from extension/Content-Type, fetch (check HTTP status) or
   confirm the local path exists, then copy into `PORTAL_DIR/public/data/` under a
   non-colliding filename.
4. Update `datasets.json`: if the dataset has no `resources` yet, migrate its
   top-level `file`/`format`/`schema` into the first resource (lossless), then
   append the new resource; if `resources` already exists, just append, keeping
   `name` unique within the array.
5. Verify the build with `npx next build`, capturing output to a log file; fix
   malformed JSON before reporting success.
6. Report the outcome (see Output below).

## Output

```
✓ Resource added to DATASET: RESOURCE_TITLE (RESOURCE_NAME.EXT)
  - Data file: public/data/RESOURCE_NAME.EXT
  - Manifest:  datasets.json (dataset now has <n> resources)
  - Showcase:  /@<namespace>/<slug> renders a section per resource
```

If this was the first migration to multi-resource, note that the dataset's single
`file` was moved into `resources[]` with no data lost.

## Error Handling

| Symptom | Cause | Fix |
|---|---|---|
| "Dataset not found" | `DATASET` slug/namespace doesn't match any entry in `datasets.json` | List datasets from `datasets.json` and ask the user to pick, or run `/portaljs-add-dataset` to create it |
| `npx next build` fails with a JSON parse error | Manually edited `datasets.json` has a trailing comma or unescaped character | Re-open the file, fix the JSON, and rebuild before reporting success |
| Resource file fails to fetch (non-2xx) | `SOURCE` URL is wrong, private, or the host is down | Confirm the URL in a browser or with `curl -I SOURCE`; ask for a corrected URL or a local path |
| New resource's filename collides with an existing one in `/public/data` | Auto-derived `RESOURCE_NAME` matches an existing file stem | Pick a distinct `RESOURCE_NAME`, or let the skill append a numeric suffix |
| Showcase doesn't render the new section after build | `name` in the new resource object duplicates an existing resource's `name` | Rename the resource's `name` to something unique within that dataset's `resources[]` |

## Examples

### Example 1 — Add a data dictionary to a single-file dataset

```
/portaljs-add-resource orders ./data/orders-data-dictionary.csv --title "Data dictionary"
```
`orders` was a single CSV. It is migrated to a two-resource dataset (the original
data plus the dictionary), and its showcase now renders a section for each.

### Example 2 — Add a resource by URL to a dataset that already has resources

```
/portaljs-add-resource climate-observations https://example.org/data/methodology.json --name methodology --title "Methodology notes"
```
The skill fetches the URL, checks the HTTP status, copies it to
`public/data/methodology.json`, and appends it to the existing `resources[]` array.

### Example 3 — Run with no arguments (interview mode)

```
/portaljs-add-resource
```
With no arguments, the skill lists datasets from `datasets.json`, asks which one to
extend and for the new file's path or URL, then proceeds through steps 2-6 above.

## Resources

- [`.claude/commands/portaljs-add-resource.md`](https://github.com/datopian/portaljs/blob/main/.claude/commands/portaljs-add-resource.md) — canonical workflow this skill follows
- [`references/reference.md`](references/reference.md) — resource entry fields, single-to-multi-resource layout, troubleshooting
- Related skills: `/portaljs-add-dataset` (create a new dataset), `/portaljs-define-schema` (describe a resource's fields)
- [Frictionless Data — Data Package resources](https://datapackage.org/standard/data-resource/) — the data model this feature mirrors

More from datopian/portaljs

SkillDescription
arcgis-to-portaljsMigrate a whole ArcGIS Hub site into a PortalJS Arc portal end-to-end. Harvests the Hub /data.json (DCAT-US) inventory, exports every FeatureService layer through the ArcGIS REST query API with resultOffset paging, converts each to the serverless dual tier (PMTiles render + GeoParquet query) with tabular items to Parquet, pushes everything to Cloudflare R2 via Git LFS, appends dual-tier datasets.json entries, and writes a source-vs-derived parity report. Use to move a City or sector ArcGIS Hub open-data portal onto PortalJS with no server-side compute.
portaljs-add-chartAdd a chart (line, bar, area, pie, or scatter) to a dataset's showcase in a PortalJS portal. Installs recharts, writes a reusable Chart component, and renders it in the showcase Views section. Use when visualizing a dataset already registered in datasets.json.
portaljs-add-datasetAdd a dataset (CSV, TSV, JSON, or GeoJSON) to an existing PortalJS portal. Appends an entry to datasets.json so the catalog and showcase render it automatically; routes the data by source (local file vs remote URL) — R2 via Git LFS by default, remote URLs by passthrough. Use when registering a new dataset in a scaffolded portal.
portaljs-add-dcatMake a PortalJS portal harvestable by national/EU/US open-data portals — emit standards-compliant DCAT catalog feeds (DCAT 2/3, DCAT-AP, DCAT-US, national profiles) in JSON-LD, Turtle, and RDF/XML at build, with autodiscovery and per-profile conformance checking. Use when a portal needs to be harvested by data.europa.eu, data.gov, or a national open-data catalog.
portaljs-add-geoAuto-ingest a geospatial file (GeoJSON, Shapefile, GeoPackage, KML/KMZ, FlatGeobuf, CSV-with-geometry) into a PortalJS portal on the user's own machine, with no server. Normalizes CRS to EPSG:4326, derives a PMTiles render tier and a GeoParquet query tier, pushes all three artifacts to Cloudflare R2 via Git LFS, and appends one dual-tier datasets.json entry the showcase auto-renders. Use when the source is a vector geo format that needs a map or spatial-query view.
portaljs-add-mapRender a GeoJSON dataset on an interactive Leaflet map in the Views section of a dataset's showcase. Installs react-leaflet and a Map component, then renders the map for the chosen dataset. Use when a dataset's data is geographic and a map view is needed alongside the showcase's default metadata and download.
portaljs-architectRecommend a data-portal architecture (storage, compute, catalog, access, hosting, metadata) from stated needs, then hand off to the build skills. The advisory entry point. Use when starting a new data-portal project and the underlying architecture has not yet been decided.
portaljs-check-data-qualityAudit a local or remote tabular file (CSV/TSV) for common data quality issues — schema, nulls, types, duplicates. Read-only. Use when a dataset needs a quality check before publishing, or a showcase renders wrong (blank cells, garbled numbers, an unsortable date column) and the cause needs isolating.
portaljs-connect-ckanWire a scaffolded PortalJS portal to a CKAN backend over its API. Generates a tiny server-side fetch client (no runtime dependency) and feeds the /search catalog and /@namespace/slug showcases from CKAN instead of datasets.json. Use when connecting an existing portal to a live CKAN instance instead of a static manifest.
portaljs-define-schemaDefine a dataset's metadata profile — infer a Frictionless Table Schema from its data, add Data Package metadata (license, sources, keywords), and write it into datasets.json so the showcase renders a typed field table. Extend or customize via the L0-L3 profile ladder. Use when a registered dataset needs field types, constraints, or catalog metadata before publishing.