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-optimal-modules

v3.0.0

Published

An ESLint plugin to enforce optimal JavaScript module design.

Downloads

812

Readme

eslint-plugin-optimal-modules

An ESLint plugin to enforce optimal JavaScript module design.

Installation

To install eslint-plugin-optimal-modules with npm, run:

npm install eslint-plugin-optimal-modules --save-dev

To use the recommended config, add the following ESLint “flat” config in eslint.config.mjs:

// @ts-check

import eslintPluginOptimalModules from "eslint-plugin-optimal-modules";

/**
 * ESLint config.
 * @satisfies {Array<import("eslint").Linter.Config>}
 */
const eslintConfig = [eslintPluginOptimalModules.configs.recommended];

export default eslintConfig;

Alternatively, manually configure the plugin and the desired rules:

// @ts-check

import eslintPluginOptimalModules from "eslint-plugin-optimal-modules";

/**
 * ESLint config.
 * @satisfies {Array<import("eslint").Linter.Config>}
 */
const eslintConfig = [
  {
    plugins: {
      "optimal-modules": eslintPluginOptimalModules,
    },
    rules: {
      "optimal-modules/no-named-exports": "error",
    },
  },
];

export default eslintConfig;

To allow named exports in Storybook story modules that have a Component Story Format (CSF):

// @ts-check

import eslintPluginOptimalModules from "eslint-plugin-optimal-modules";

/**
 * ESLint config.
 * @satisfies {Array<import("eslint").Linter.Config>}
 */
const eslintConfig = [
  eslintPluginOptimalModules.configs.recommended,
  {
    files: ["**/*.stories.{mjs,cjs,js,mts,cts,ts,tsx}"],
    rules: {
      "optimal-modules/no-named-exports": "off",
    },
  },
];

export default eslintConfig;

Rules

Rule no-named-exports

Prohibits using named exports for optimal module design.

Valid examples:

// No exports.
const a = true;
// Default export.
export default true;
// Default export.
const a = true;
export { a as default };
// TypeScript type default export.
type A = boolean;
export type { A as default };

Invalid examples:

// Named export.
export const a = true;
// Named export.
const a = true;
export { a };
// TypeScript type named export.
export type A = boolean;

To fix the above errors, move the thing being exported to its own module as a default export.

Configs

Config recommended

Enabled rules:

Requirements

Supported runtime environments:

  • Node.js versions ^18.18.0 || ^20.9.0 || >=21.1.0.

Projects must configure TypeScript to use types from the CommonJS modules that have a // @ts-check comment:

Exports

These CommonJS modules are exported via the package.json field exports: