Skip to content

Commit

Permalink
chore(package-name): change to nuxt-edgedb-module (nuxt-edgedb alread…
Browse files Browse the repository at this point in the history
…y taken)
  • Loading branch information
Tahul committed Nov 11, 2023
1 parent 65f4d04 commit 2b80325
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

## Features

- 🍱  Zero-config setup; just add `nuxt-edgedb` to your `modules`
- 🍱  Zero-config setup; just add `nuxt-edgedb-module` to your `modules`
- 🧙  [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
- 🎩  Watchers on `dbschema/*`, `queries/*`, `dbschema/migrations/*` bringing _HMR_ to your database
- 🛟  Auto-imported typed database query client provided by [`@edgedb/generate`](https://www.edgedb.com/docs/clients/js/generation)
Expand All @@ -21,25 +21,25 @@

## Quick Setup

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

```bash
# Using pnpm
pnpm add -D nuxt-edgedb
pnpm add -D nuxt-edgedb-module

# Using yarn
yarn add --dev nuxt-edgedb
yarn add --dev nuxt-edgedb-module

# Using npm
npm install --save-dev nuxt-edgedb
npm install --save-dev nuxt-edgedb-module
```

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

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

> HMR on your database obviously has **NO** effect in production context.
### Why the name isn't `nuxt-edgedb`

Because that handle is already taken on NPM.

It seem to be taken by [`ohmree`](https://github.com/ohmree), but the package seem inactive.

If anyone happens to know him, I would be happy to get in contact!

## Development

```bash
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "nuxt-edgedb",
"name": "nuxt-edgedb-module",
"version": "0.0.2",
"description": "Nuxt 3 integration for EdgeDB.",
"repository": "tahul/nuxt-edgedb",
Expand Down Expand Up @@ -47,4 +47,4 @@
"nuxt": "^3.8.1",
"vitest": "^0.34.6"
}
}
}
4 changes: 2 additions & 2 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const { resolve: resolveLocal } = createResolver(import.meta.url)

export default defineNuxtModule<ModuleOptions>({
meta: {
name: 'nuxt-edgedb',
name: 'nuxt-edgedb-module',
configKey: 'edgeDb'
},
// Default configuration options of the Nuxt module
Expand Down Expand Up @@ -148,7 +148,7 @@ export default defineNuxtModule<ModuleOptions>({
nuxt.hook('devtools:customTabs', (tabs) => {
tabs.push({
// unique identifier
name: 'nuxt-edgedb',
name: 'nuxt-edgedb-module',
// title to display in the tab
title: 'EdgeDB',
// any icon from Iconify, or a URL to an image
Expand Down

0 comments on commit 2b80325

Please sign in to comment.