npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-next-no-use-client-on-page

v1.0.3

Published

In NextJS app directory, disallow the use of "use client" on page files.

Downloads

5

Readme

ESLint Rule: No Client on Page

This is an ESLint custom rule that disallows the use of "use client" directive at the top of page files in a Next.js application directory. The rule enforces that Server Components should be the default and restricts client components from being used inappropriately.

Rule Details

This rule aims to ensure that in a Next.js application, the "use client" directive is not used at the top of files inside the app subfolder with names ending in page.ts, page.js, pages.tsx, or pages.jsx. The "use client" directive is used to separate server-only code and client code. Since Server Components are the default, all components are considered part of the Server Component module graph unless defined or imported into a module that starts with the "use client" directive.

Installation

Before installing the custom rule, make sure you have ESLint installed:

npm install eslint --save-dev
# or
yarn add eslint --dev

Clone this repository and navigate to the directory where the custom rule is located. Run the following command to link the package locally:

npm link
# or
yarn link

Navigate to your project directory and run:

npm link eslint-plugin-no-client-on-page
# or
yarn link eslint-plugin-no-client-on-page

Usage

Add the custom rule to your ESLint configuration file (.eslintrc.js or .eslintrc.json).

{
    "plugins": ["next-no-use-client-on-page"],
        "rules": {
        "no-use-client-on-page": "error"
    }
}

Testing

The custom rule comes with test cases to validate its functionality. To execute the tests, navigate to the directory where the custom rule is located and run:

npm test
# or
yarn test

Examples

Valid:

// File: ./app/components/page.ts
import React from 'react';
const Page = () => { return <div>Hello, Page!</div>; };
export default Page;

Invalid:

// File: ./app/components/page.ts
"use client";
import React from 'react';
const Page = () => { return <div>Hello, Page!</div>; };
export default Page;

Contributing

Contributions are welcome! Please make sure to update tests as appropriate.

License

MIT

References

Disclaimer

This custom rule is not officially supported by Next.js. It is a personal project that I created to learn more about ESLint custom rules and to help enforce best practices in my Next.js projects.

Author

Davin Young