Skip to content

Commit f0c92c5

Browse files
docs(components): align package scopes with published npm names (#645)
Audit every first-party package reference against npm and update the docs to the name actually published, plus point repository links at the repos' current HarperFast org locations. - @harperfast/vite-plugin is deprecated ("Renamed to @harperfast/vite"); the Known Custom Components entry now lists @harperfast/vite. - The Next.js plugin reference in the Harper Applications in Depth guide now uses @harperfast/nextjs (2.x) instead of the legacy @harperdb/nextjs (1.x). - apollo, astro, status-check, prometheus-exporter, and acl-connect stay on @HarperDB, which is the only scope each is published under. - Add a one-line note under Known Custom Components explaining why both scopes appear, so readers seeing both are not confused. Closes #503 Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
1 parent be93441 commit f0c92c5

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

learn/developers/harper-applications-in-depth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Beyond the component system, Harper also includes some other important subsystem
5050

5151
### Component Classification: Built-in vs Custom
5252

53-
Harper further classifies components (plugins and applications) as either built-in or custom. **Built-in** components are internal to Harper, require no additional installation steps, and are immediately accessible for use. The `graphqlSchema` and `rest` plugins are great examples of built-in plugins. **Custom** components are external to Harper, generally available as an npm package or git repository, and do require additional installation steps in order to be used. Custom components can be authored by anyone, including Harper. Any of Harper's official custom components are published using the `@harperdb` and `@harperfast` package scopes, such as the [`@harperdb/nextjs`](https://github.com/HarperDB/nextjs) plugin for developing Next.js applications or the [`@harperdb/status-check`](https://github.com/HarperDB/status-check) application.
53+
Harper further classifies components (plugins and applications) as either built-in or custom. **Built-in** components are internal to Harper, require no additional installation steps, and are immediately accessible for use. The `graphqlSchema` and `rest` plugins are great examples of built-in plugins. **Custom** components are external to Harper, generally available as an npm package or git repository, and do require additional installation steps in order to be used. Custom components can be authored by anyone, including Harper. Any of Harper's official custom components are published using the `@harperdb` and `@harperfast` package scopes, such as the [`@harperfast/nextjs`](https://github.com/HarperFast/nextjs) plugin for developing Next.js applications or the [`@harperdb/status-check`](https://github.com/HarperFast/status-check) application.
5454

5555
Harper's reference documentation contains detailed documentation for all [built-in components](/reference/v5/components/overview#built-in-extensions-reference). Custom components are documented within their respective repositories.
5656

reference/components/overview.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,16 +136,18 @@ Extensions require an `extensionModule` option pointing to the extension source.
136136

137137
## Known Custom Components
138138

139+
Harper's official components are published under two npm scopes — `@harperfast` for packages already migrated as part of the HarperDB to HarperFast transition, and `@harperdb` for those still on the original scope — so install each one using exactly the name listed below.
140+
139141
### Applications
140142

141-
- [`@harperdb/status-check`](https://github.com/HarperDB/status-check)
142-
- [`@harperdb/prometheus-exporter`](https://github.com/HarperDB/prometheus-exporter)
143-
- [`@harperdb/acl-connect`](https://github.com/HarperDB/acl-connect)
143+
- [`@harperdb/status-check`](https://github.com/HarperFast/status-check)
144+
- [`@harperdb/prometheus-exporter`](https://github.com/HarperFast/prometheus-exporter)
145+
- [`@harperdb/acl-connect`](https://github.com/HarperFast/acl-connect)
144146

145147
### Plugins
146148

147149
- [`@harperfast/nextjs`](https://github.com/HarperFast/nextjs) — Run a Next.js application on Harper ([docs](./nextjs.md))
148-
- [`@harperfast/vite-plugin`](https://github.com/HarperFast/vite-plugin) — Develop and serve Vite-built front-ends from Harper, with HMR via `harper run`
150+
- [`@harperfast/vite`](https://github.com/HarperFast/vite) — Develop and serve Vite-built front-ends from Harper, with HMR via `harper run`
149151

150152
### Extensions
151153

0 commit comments

Comments
 (0)