Skip to content

Commit 2b80325

Browse files
committed
chore(package-name): change to nuxt-edgedb-module (nuxt-edgedb already taken)
1 parent 65f4d04 commit 2b80325

3 files changed

Lines changed: 19 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## Features
1313

14-
- 🍱  Zero-config setup; just add `nuxt-edgedb` to your `modules`
14+
- 🍱  Zero-config setup; just add `nuxt-edgedb-module` to your `modules`
1515
- 🧙  [EdgeDB CLI install](https://www.edgedb.com/docs/cli/index) and [project init](https://www.edgedb.com/docs/cli/edgedb_project/edgedb_project_init) wizards
1616
- 🎩  Watchers on `dbschema/*`, `queries/*`, `dbschema/migrations/*` bringing _HMR_ to your database
1717
- 🛟  Auto-imported typed database query client provided by [`@edgedb/generate`](https://www.edgedb.com/docs/clients/js/generation)
@@ -21,25 +21,25 @@
2121

2222
## Quick Setup
2323

24-
1. Add `nuxt-edgedb` dependency to your project
24+
1. Add `nuxt-edgedb-module` dependency to your project
2525

2626
```bash
2727
# Using pnpm
28-
pnpm add -D nuxt-edgedb
28+
pnpm add -D nuxt-edgedb-module
2929

3030
# Using yarn
31-
yarn add --dev nuxt-edgedb
31+
yarn add --dev nuxt-edgedb-module
3232

3333
# Using npm
34-
npm install --save-dev nuxt-edgedb
34+
npm install --save-dev nuxt-edgedb-module
3535
```
3636

37-
2. Add `nuxt-edgedb` to the `modules` section of `nuxt.config.ts`
37+
2. Add `nuxt-edgedb-module` to the `modules` section of `nuxt.config.ts`
3838

3939
```js
4040
export default defineNuxtConfig({
4141
modules: [
42-
'nuxt-edgedb'
42+
'nuxt-edgedb-module'
4343
],
4444
// Optional, all options has sufficient defaults.
4545
edgedb: {
@@ -260,6 +260,14 @@ If you do not want any of these features, just set `watch` to false and you are
260260

261261
> HMR on your database obviously has **NO** effect in production context.
262262
263+
### Why the name isn't `nuxt-edgedb`
264+
265+
Because that handle is already taken on NPM.
266+
267+
It seem to be taken by [`ohmree`](https://github.com/ohmree), but the package seem inactive.
268+
269+
If anyone happens to know him, I would be happy to get in contact!
270+
263271
## Development
264272

265273
```bash

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "nuxt-edgedb",
2+
"name": "nuxt-edgedb-module",
33
"version": "0.0.2",
44
"description": "Nuxt 3 integration for EdgeDB.",
55
"repository": "tahul/nuxt-edgedb",
@@ -47,4 +47,4 @@
4747
"nuxt": "^3.8.1",
4848
"vitest": "^0.34.6"
4949
}
50-
}
50+
}

src/module.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const { resolve: resolveLocal } = createResolver(import.meta.url)
2626

2727
export default defineNuxtModule<ModuleOptions>({
2828
meta: {
29-
name: 'nuxt-edgedb',
29+
name: 'nuxt-edgedb-module',
3030
configKey: 'edgeDb'
3131
},
3232
// Default configuration options of the Nuxt module
@@ -148,7 +148,7 @@ export default defineNuxtModule<ModuleOptions>({
148148
nuxt.hook('devtools:customTabs', (tabs) => {
149149
tabs.push({
150150
// unique identifier
151-
name: 'nuxt-edgedb',
151+
name: 'nuxt-edgedb-module',
152152
// title to display in the tab
153153
title: 'EdgeDB',
154154
// any icon from Iconify, or a URL to an image

0 commit comments

Comments
 (0)