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

@hyperse/eslint-config-hyperse

v1.2.7

Published

๐Ÿ›  These are settings for TypeScript / ESLint / Prettier in a project

Downloads

820

Readme

@hyperse/eslint-config-hyperse

๐Ÿ›  These are my settings for TypeScript / ESLint / Prettier in a project, also support mono / esm ๐Ÿ“ฆ

These are the ESLint and Prettier settings for a Next.js project โšก๏ธ

Table of Contents

What it does

  • Lints JavaScript / TypeScript based on the latest standards
  • Multiple configs react hooks next..
  • Shared tsconfig.json
  • Fixes issues and formatting errors with Prettier
  • Check for accessibility rules on JSX elements.

Local / Per Project Install

  1. If you don't already have a package.json file, create one with npm init.

  2. Then we need to install the config:

npm i -D @hyperse/eslint-config-hyperse
  1. Create a eslint.config.js file in the root of your project's directory (it should live where package.json does). Your eslint.config.js file should look like this:
  2. if you are using commonjs, just change eslint.config.js to eslint.config.mjs
  3. Extends your config with the minimal base of @hyperse config :
import { base, defineConfig } from '@hyperse/eslint-config-hyperse';

export default defineConfig([
  // ...typescript
  ...base,
  {
    rules: {
      '@typescript-eslint/no-explicit-any': 'off',
    },
  },
]);

Extends tsconfig.json

you can write you tsconfig.json via extends @hyperse/eslint-config-hyperse/tsconfig.base.json

{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@hyperse/eslint-config-hyperse/tsconfig.base.json",
  "compilerOptions": {
    "baseUrl": "./",
    "rootDir": ".",
    "outDir": "dist",
    "types": ["vitest/globals"],
    "paths": {}
  },
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"]
}

write you tsconfig.build.json as below

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src",
    "baseUrl": "./",
    "incremental": false,
    "paths": {}
  },
  "exclude": ["**/*.stories.tsx", "**/*.stories.mdx", ".storybook/**", "dist"]
}

Scripts

You can add two scripts to your package.json to lint and/or fix your code:

{
  "scripts": {
    "lint": "tsc --noEmit && eslint .",
    "lint:fix": "npm run lint -- --fix"
  }
}
{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "npm run lint -- --fix"
  }
}

If you use Next.js

You can also add additional rules for Next.js

import { defineConfig, nextjs } from '@hyperse/eslint-config-hyperse';

export default defineConfig([
  // ...typescript
  ...nextjs,
  {
    rules: {
      '@typescript-eslint/no-explicit-any': 'off',
    },
  },
]);

If you use React.js

You can also add additional rules for only React.js ecosystem (without Next.js).

import { defineConfig, reactjs } from '@hyperse/eslint-config-hyperse';

export default defineConfig([
  // ...typescript
  ...reactjs,
  {
    rules: {
      '@typescript-eslint/no-explicit-any': 'off',
    },
  },
]);

If you use VS Code

Once you have done. You probably want your editor to lint and fix for you.

  1. Install the ESLint package
  2. Now we need to setup some VS Code settings. Create a .vscode folder at your root project, and create a settings.json file in this folder. Then, add this little config:
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
  "editor.codeActionsOnSave": {
    "source.fixAll": "explicit",
    "source.organizeImports": "never"
  },
  "[jsonc]": {
    "editor.formatOnSave": false
  },
  "[json]": {
    "editor.formatOnSave": false
  }
}

Notes

we need to disable vscode editor language formatter for json, jsonc

{
  "[jsonc]": {
    "editor.formatOnSave": false
  },
  "[json]": {
    "editor.formatOnSave": false
  }
}
  1. Isolated Modules - isolatedModules (default:true)
  2. Verbatim Module Syntax - verbatimModuleSyntax (default:true)