From 2b80325bcc3bce232916f4de27b987cb9f2b4f47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ya=C3=ABl=20Guilloux?= Date: Sat, 11 Nov 2023 05:32:50 +0100 Subject: [PATCH] chore(package-name): change to nuxt-edgedb-module (nuxt-edgedb already taken) --- README.md | 22 +++++++++++++++------- package.json | 4 ++-- src/module.ts | 4 ++-- 3 files changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 600c34b..a731c08 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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: { @@ -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 diff --git a/package.json b/package.json index 8f215d7..e3d1ad2 100644 --- a/package.json +++ b/package.json @@ -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", @@ -47,4 +47,4 @@ "nuxt": "^3.8.1", "vitest": "^0.34.6" } -} \ No newline at end of file +} diff --git a/src/module.ts b/src/module.ts index ba50e22..2f19081 100644 --- a/src/module.ts +++ b/src/module.ts @@ -26,7 +26,7 @@ const { resolve: resolveLocal } = createResolver(import.meta.url) export default defineNuxtModule({ meta: { - name: 'nuxt-edgedb', + name: 'nuxt-edgedb-module', configKey: 'edgeDb' }, // Default configuration options of the Nuxt module @@ -148,7 +148,7 @@ export default defineNuxtModule({ 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