Skip to content

Commit

Permalink
chore: Rename repository references (#442)
Browse files Browse the repository at this point in the history
  • Loading branch information
franky47 authored Jan 4, 2024
1 parent 8cd6a48 commit 9a6faed
Show file tree
Hide file tree
Showing 33 changed files with 83 additions and 79 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Feature idea
url: https://github.com/47ng/next-usequerystate/discussions/new?category=ideas
url: https://github.com/47ng/nuqs/discussions/new?category=ideas
about: Please share ideas for new features as discussion
- name: Question
url: https://github.com/47ng/next-usequerystate/discussions/new?category=q-a
url: https://github.com/47ng/nuqs/discussions/new?category=q-a
about: Please use the discussions to ask the community for help
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# useQueryState for Next.js

[![NPM](https://img.shields.io/npm/v/next-usequerystate?color=red)](https://www.npmjs.com/package/next-usequerystate)
[![MIT License](https://img.shields.io/github/license/47ng/next-usequerystate.svg?color=blue)](https://github.com/47ng/next-usequerystate/blob/next/LICENSE)
[![Continuous Integration](https://github.com/47ng/next-usequerystate/workflows/Continuous%20Integration/badge.svg?branch=next)](https://github.com/47ng/next-usequerystate/actions)
[![Depfu](https://badges.depfu.com/badges/acad53fa2b09b1e435a19d6d18f29af4/count.svg)](https://depfu.com/github/47ng/next-usequerystate?project_id=22104)
[![MIT License](https://img.shields.io/github/license/47ng/nuqs.svg?color=blue)](https://github.com/47ng/nuqs/blob/next/LICENSE)
[![Continuous Integration](https://github.com/47ng/nuqs/workflows/Continuous%20Integration/badge.svg?branch=next)](https://github.com/47ng/nuqs/actions)
[![Depfu](https://badges.depfu.com/badges/acad53fa2b09b1e435a19d6d18f29af4/count.svg)](https://depfu.com/github/47ng/nuqs?project_id=22104)

<!-- [![Coverage Status](https://coveralls.io/repos/github/47ng/next-usequerystate/badge.svg?branch=next)](https://coveralls.io/github/47ng/next-usequerystate?branch=next) -->
<!-- [![Coverage Status](https://coveralls.io/repos/github/47ng/nuqs/badge.svg?branch=next)](https://coveralls.io/github/47ng/nuqs?branch=next) -->

useQueryState hook for Next.js - Like React.useState, but stored in the URL query string

Expand Down Expand Up @@ -41,13 +41,13 @@ npm install nuqs
### Which version should I use?

| Next.js version range | Supported `nuqs` / `next-usequerystate` version |
| --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| >=14.0.4 | `nuqs@latest` |
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/next-usequerystate/issues/417) |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/next-usequerystate/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| >= 13.1 && <= 14.0.1 | `nuqs@latest` |
| < 13.1 | `[email protected]` |
| Next.js version range | Supported `nuqs` / `next-usequerystate` version |
| --------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
| >=14.0.4 | `nuqs@latest` |
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| >= 13.1 && <= 14.0.1 | `nuqs@latest` |
| < 13.1 | `[email protected]` |

## Usage

Expand All @@ -68,7 +68,7 @@ export default () => {
}
```

![](https://raw.githubusercontent.com/47ng/next-usequerystate/next/useQueryState.gif)
![](https://raw.githubusercontent.com/47ng/nuqs/next/useQueryState.gif)

## Documentation

Expand Down Expand Up @@ -635,7 +635,7 @@ Log lines will be prefixed with `[nuqs]` for `useQueryState` and `[nuq+]` for
User timings markers are also recorded, for advanced performance analysis using
your browser's devtools.

Providing debug logs when opening an [issue](https://github.com/47ng/next-usequerystate/issues)
Providing debug logs when opening an [issue](https://github.com/47ng/nuqs/issues)
is always appreciated. 🙏

## Caveats
Expand Down Expand Up @@ -715,7 +715,7 @@ Upon reloading the page, the state will be incorrectly set to 1.2345.

## License

[MIT](https://github.com/47ng/next-usequerystate/blob/next/LICENSE)
[MIT](https://github.com/47ng/nuqs/blob/next/LICENSE)

Made with ❤️ by [François Best](https://francoisbest.com)

Expand Down
2 changes: 1 addition & 1 deletion errors/NUQS-429.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ every keypress, or a slider (`<input type="range">`).
## Possible Solutions

The library has a built-in throttling mechanism, that can be configured per
instance. See the [throttling](https://github.com/47ng/next-usequerystate#throttling)
instance. See the [throttling](https://github.com/47ng/nuqs#throttling)
docs for more information.

## Safari
Expand Down
2 changes: 1 addition & 1 deletion errors/NUQS-500.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ they are not re-rendered when the page renders.

In this case, your only option is to turn the server component into a client
component, and read the search params with `useQueryStates`. You can
[feed it the same parser object](https://github.com/47ng/next-usequerystate#accessing-searchparams-in-server-components)
[feed it the same parser object](https://github.com/47ng/nuqs#accessing-searchparams-in-server-components)
you used to create the cache, and it you'll get the same
type safety.

Expand Down
2 changes: 1 addition & 1 deletion errors/NUQS-501.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Search params cache already populated

This error occurs when a [search params cache](https://github.com/47ng/next-usequerystate#accessing-searchparams-in-server-components)
This error occurs when a [search params cache](https://github.com/47ng/nuqs#accessing-searchparams-in-server-components)
is being fed searchParams more than once.

Internally, the cache object will be frozen for the duration of the page render
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/47ng/next-usequerystate"
"url": "https://github.com/47ng/nuqs"
},
"scripts": {
"dev": "FORCE_COLOR=3 turbo run dev",
Expand Down
12 changes: 6 additions & 6 deletions packages/docs/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ npm install next-usequerystate
| --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| < 13.1 | `[email protected]` |
| >= 13.1 && \<\= 14.0.1 | `next-usequerystate@latest` |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/next-usequerystate/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| 14.0.3 | `next-usequerystate@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/next-usequerystate/issues/417) |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| 14.0.3 | `next-usequerystate@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
| >=14.0.4 | `next-usequerystate@latest` |

## Usage
Expand Down Expand Up @@ -167,7 +167,7 @@ export default function ServerPage({ searchParams }: PageProps) {
}
```

See the [server-side parsing demo](https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/server-side-parsing/)
See the [server-side parsing demo](https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/server-side-parsing/)
for a live example showing how to reuse parser configurations between
client and server code.

Expand Down Expand Up @@ -407,7 +407,7 @@ useQueryState(
)
```

Note: see this example running in the [hex-colors demo](https://github.com/47ng/next-usequerystate/blob/next/packages/docs/src/app/(pages)/playground/hex-colors/page.tsx).
Note: see this example running in the [hex-colors demo](https://github.com/47ng/nuqs/blob/next/packages/docs/src/app/(pages)/playground/hex-colors/page.tsx).

## Multiple Queries (batching)

Expand Down Expand Up @@ -632,7 +632,7 @@ Log lines will be prefixed with `[nuqs]` for `useQueryState` and `[nuq+]` for
User timings markers are also recorded, for advanced performance analysis using
your browser's devtools.

Providing debug logs when opening an [issue](https://github.com/47ng/next-usequerystate/issues)
Providing debug logs when opening an [issue](https://github.com/47ng/nuqs/issues)
is always appreciated. 🙏

## Caveats
Expand Down Expand Up @@ -712,7 +712,7 @@ Upon reloading the page, the state will be incorrectly set to 1.2345.

## License

[MIT](https://github.com/47ng/next-usequerystate/blob/next/LICENSE)
[MIT](https://github.com/47ng/nuqs/blob/next/LICENSE)

Made with ❤️ by [François Best](https://francoisbest.com)

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/content/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ bun add nuqs
| Next.js version range | Supported `nuqs` / `next-usequerystate` version |
| --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| >=14.0.4 | `nuqs@latest` |
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/next-usequerystate/issues/417) |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/next-usequerystate/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
| >= 13.1 && \<\= 14.0.1 | `nuqs@latest` |
| < 13.1 | `[email protected]` |

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/app/(pages)/_landing/hero.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export function HeroSection() {
Documentation
</Link>
<a
href="https://github.com/47ng/next-usequerystate"
href="https://github.com/47ng/nuqs"
className={cn(
buttonVariants({
size: 'lg',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export default function BasicCounterDemoPage() {
</nav>
<p>Counter: {counter}</p>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/basic-counter/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/basic-counter/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/app/(pages)/playground/batching/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export default function BuilderPatternDemoPage() {
</code>
</pre>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/batching/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/batching/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export default function BuilderPatternDemoPage() {
</em>
</p>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/builder-pattern/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/builder-pattern/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export default function CompoundParsersDemo() {
</pre>
</section>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/compound-parsers/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/compound-parsers/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export default function CrosslinkDemoPage() {
</code>
</pre>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/crosslink/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/crosslink/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export default function BasicCounterDemoPage() {
<span>{sort.bar}</span>
</nav>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/custom-parser/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/custom-parser/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export default function HexColorsDemo() {
}}
></div>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/hex-colors/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/hex-colors/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/app/(pages)/playground/parsers/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export default function BasicCounterDemoPage() {
</li>
</ul>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/parsers/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/parsers/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default function PrettyURLsDemoPage() {
</li>
</ul>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/pretty-urls/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/pretty-urls/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/src/app/(pages)/playground/repro-359/page.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// https://github.com/47ng/next-usequerystate/issues/359
// https://github.com/47ng/nuqs/issues/359

'use client'

Expand Down Expand Up @@ -41,7 +41,7 @@ export default function Home() {
<>
<h1>
Repro for issue{' '}
<a href="https://github.com/47ng/next-usequerystate/issues/359">#359</a>
<a href="https://github.com/47ng/nuqs/issues/359">#359</a>
</h1>
<div className="border p-5">
{component === TargetComponent.Comp1 ? <Component1 /> : null}
Expand Down Expand Up @@ -92,7 +92,7 @@ export default function Home() {
</button>
</div>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/repro-359/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/repro-359/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default function ReproPage() {
</nav>
<p>Query: {searchQueryUrl}</p>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/repro-376/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/repro-376/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default function ServerSideParsingDemo({ searchParams }: PageProps) {
</ServerSideParsingDemoClient>
</Suspense>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/server-side-parsing/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/server-side-parsing/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default function BuilderPatternDemoPage() {
<em>Check the console</em>
</p>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/subscribeToQueryUpdates/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/subscribeToQueryUpdates/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default async function ThottlingDemoPage({ searchParams }: PageParams) {
<Client />
</Suspense>
<p>
<a href="https://github.com/47ng/next-usequerystate/tree/next/packages/docs/src/app/(pages)/playground/throttling/page.tsx">
<a href="https://github.com/47ng/nuqs/tree/next/packages/docs/src/app/(pages)/playground/throttling/page.tsx">
Source on GitHub
</a>
</p>
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/app/(pages)/stats/lib/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const repositoryQuerySchema = z.object({
})

export async function fetchRepository(
slug = '47ng/next-usequerystate'
slug = '47ng/nuqs'
): Promise<GitHubRepositoryData> {
const [owner, repo] = slug.split('/')
const query = `query {
Expand Down Expand Up @@ -100,7 +100,7 @@ const starHistoryQuerySchema = z.object({
})

export async function getStarHistory(
slug = '47ng/next-usequerystate'
slug = '47ng/nuqs'
): Promise<GitHubStarHistory> {
const [owner, repo] = slug.split('/')
const query = `query {
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/app/docs/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export default function RootDocsLayout({ children }: { children: ReactNode }) {
nav={{
title: <NuqsWordmark className="px-3" />,
items: navItems,
githubUrl: 'https://github.com/47ng/next-usequerystate'
githubUrl: 'https://github.com/47ng/nuqs'
}}
sidebar={{
collapsible: false,
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/components/nav.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const navLinks: NavLinkProps[] = [
{
label: 'GitHub',
icon: <GithubIcon className="h-5 w-5" />,
href: 'https://github.com/47ng/next-usequerystate',
href: 'https://github.com/47ng/nuqs',
external: true
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export default function ServerSideCounterPage({
<p>Client counter: {counter}</p>
<p>Server counter: {serverSideCounter}</p>
<p>
<a href="https://github.com/47ng/next-usequerystate/blob/next/src/pages/demos/pages/server-side-counter.tsx">
<a href="https://github.com/47ng/nuqs/blob/next/src/pages/demos/pages/server-side-counter.tsx">
Source on GitHub
</a>
</p>
Expand Down
Loading

0 comments on commit 9a6faed

Please sign in to comment.