chore: Renaming to nuqs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,10 +10,10 @@ assignees: ''
 
 ## Context
 
-What's your version of `next-usequerystate`?
+What's your version of `nuqs`?
 
 ```
--> Paste result from `cat package.json | grep next-usequerystate` here
+-> Paste result from `cat package.json | grep -e nuqs -e next-usequerystate` here
 ```
 
 Next.js information (obtained by running `next info`):

CONTRIBUTING.md

@@ -12,7 +12,7 @@ First off, thanks for your help!
 
 This monorepo contains:
 
-- The source code for the `next-usequerystate` NPM package, in [`packages/next-usequerystate`](./packages/next-usequerystate).
+- The source code for the `nuqs` NPM package, in [`packages/next-usequerystate`](./packages/next-usequerystate).
 - A Next.js app under [`packages/playground`](./packages/playground) that serves as a playground deployed at <https://next-usequerystate.vercel.app>
 - A test bench for [end-to-end tests](./packages/e2e) driven by Cypress
 

errors/NUQS-409.md

@@ -1,13 +1,13 @@
 # Multiple versions of the library are loaded
 
-This error occurs if two different versions of `next-usequerystate` are
+This error occurs if two different versions of `nuqs` are
 loaded in the same application.
 
-This may happen if you are using a package that embeds next-usequerystate and
-you are also using next-usequerystate directly.
+This may happen if you are using a package that embeds `nuqs` and
+you are also using `nuqs` directly.
 
 ## Possible Solutions
 
-Inspect your dependencies for duplicate versions of `next-usequerystate` and
+Inspect your dependencies for duplicate versions of `nuqs` and
 use the `resolutions` field in `package.json` to force all dependencies
 to use the same version.

errors/NUQS-500.md

@@ -26,7 +26,7 @@ import {
   createSearchParamsCache,
   parseAsInteger,
   parseAsString
-} from 'next-usequerystate/parsers'
+} from 'nuqs/parsers'
 
 const cache = createSearchParamsCache({
   q: parseAsString,

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "next-usequerystate-monorepo",
+  "name": "nuqs-monorepo",
   "version": "0.0.0",
   "private": true,
   "license": "MIT",

packages/e2e/package.json

@@ -1,7 +1,7 @@
 {
   "name": "e2e",
   "version": "0.0.0-internal",
-  "description": "End-to-end test bench for next-usequerystate",
+  "description": "End-to-end test bench for nuqs",
   "license": "MIT",
   "private": true,
   "author": {

packages/e2e/src/app/layout.tsx

@@ -2,7 +2,7 @@ import React, { Suspense } from 'react'
 import { HydrationMarker } from '../components/hydration-marker'
 
 export const metadata = {
-  title: 'next-usequerystate playground',
+  title: 'nuqs playground',
   description:
     'useQueryState hook for Next.js - Like React.useState, but stored in the URL query string'
 }

packages/next-usequerystate/parsers.d.ts

@@ -1,5 +1,5 @@
 // This file is needed for projects that have `moduleResolution` set to `node`
-// in their tsconfig.json to be able to `import {} from 'next-usequerystate/parsers'`.
+// in their tsconfig.json to be able to `import {} from 'nuqs/parsers'`.
 // Other module resolutions strategies will look for the `exports` in `package.json`,
 // but with `node`, TypeScript will look for a .d.ts file with that name at the
 // root of the package.

packages/next-usequerystate/src/debug.ts

@@ -1,3 +1,4 @@
+// todo: Remove check for `next-usequerystate` in v2
 const enabled =
   (typeof localStorage === 'object' &&
     (localStorage.getItem('debug')?.includes('next-usequerystate') ??

packages/next-usequerystate/src/errors.ts

@@ -6,6 +6,6 @@ export const errors = {
 } as const
 
 export function error(code: keyof typeof errors) {
-  return `[next-usequerystate] ${errors[code]}
+  return `[nuqs] ${errors[code]}
   See https://err.47ng.com/NUQS-${code}`
 }

packages/next-usequerystate/src/sync.ts

@@ -3,9 +3,9 @@ import { debug } from './debug'
 import { error } from './errors'
 import { getQueuedValue } from './update-queue'
 
-export const SYNC_EVENT_KEY = Symbol('__nextUseQueryState__SYNC__')
-export const NOSYNC_MARKER = '__nextUseQueryState__NO_SYNC__'
-const NOTIFY_EVENT_KEY = Symbol('__nextUseQueryState__NOTIFY__')
+export const SYNC_EVENT_KEY = Symbol('__nuqs__SYNC__')
+export const NOSYNC_MARKER = '__nuqs__NO_SYNC__'
+const NOTIFY_EVENT_KEY = Symbol('__nuqs__NOTIFY__')
 
 export type QueryUpdateSource = 'internal' | 'external'
 export type QueryUpdateNotificationArgs = {
@@ -23,7 +23,7 @@ export const emitter = Mitt<EventMap>()
 
 declare global {
   interface History {
-    __nextUseQueryState_patched?: string
+    __nuqs_patched?: string
   }
 }
 
@@ -32,7 +32,7 @@ declare global {
  * method is no longer needed as you can use `useSearchParams`, which will
  * react to changes in the URL when the `windowHistorySupport` experimental flag
  * is set.
- * This method will be removed in `next-usequerystate@2.0.0`, when Next.js
+ * This method will be removed in `nuqs@2.0.0`, when Next.js
  * decides to land the `windowHistorySupport` flag in GA.
  */
 export function subscribeToQueryUpdates(
@@ -50,7 +50,7 @@ function patchHistory() {
   // This is replaced with the package.json version by scripts/prepack.sh
   // after semantic-release has done updating the version number.
   const version = '0.0.0-inject-version-here'
-  const patched = history.__nextUseQueryState_patched
+  const patched = history.__nuqs_patched
   if (patched) {
     if (patched !== version) {
       console.error(error(409), patched, version)
@@ -60,7 +60,7 @@ function patchHistory() {
   debug('[nuqs] Patching history with %s', version)
   for (const method of ['pushState', 'replaceState'] as const) {
     const original = history[method].bind(history)
-    history[method] = function nextUseQueryState_patchedHistory(
+    history[method] = function nuqs_patchedHistory(
       state: any,
       title: string,
       url?: string | URL | null
@@ -116,7 +116,7 @@ function patchHistory() {
       return original(state, title === NOSYNC_MARKER ? '' : title, url)
     }
   }
-  Object.defineProperty(history, '__nextUseQueryState_patched', {
+  Object.defineProperty(history, '__nuqs_patched', {
     value: version,
     writable: false,
     enumerable: false,

packages/playground/src/components/debug-control.tsx

@@ -8,15 +8,17 @@ export default function DebugControl() {
       return false
     }
     return (
-      localStorage.getItem('debug')?.includes('next-usequerystate') ?? false
+      localStorage.getItem('debug')?.includes('next-usequerystate') ??
+      localStorage.getItem('debug')?.includes('nuqs') ??
+      false
     )
   })
   const update = React.useCallback(() => {
     setChecked(c => {
       const checked = !c
       if (typeof localStorage !== 'undefined') {
         if (checked) {
-          localStorage.setItem('debug', 'next-usequerystate')
+          localStorage.setItem('debug', 'nuqs')
         } else {
           localStorage.removeItem('debug')
         }