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

@noaignite-dk/eslint-config

v1.6.3

Published

ESLint config for JS projects

Downloads

368

Readme

@noaignite-dk/eslint-config

Commitizen friendly

Provides extensible base eslint configuration. There are 4 variants;

Installation

npm install @noaignite-dk/eslint-config --save-dev

or

yarn add @noaignite-dk/eslint-config --dev

@noaignite-dk/eslint-config

Use this configuration if your project uses JavaScript.

Usage

In your project's .eslintrc.js, add the following:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config'],
};

@noaignite-dk/eslint-config/typescript

Use this configuration if your project uses TypeScript.

Usage

Create an eslint specific tsconfig file (tsconfig.eslint.json) with the following contents:

{
	"extends": "./tsconfig.json",
	"compilerOptions": {
		"allowJs": true,
		"checkJs": false,
	},
	"include": [
		"**/*.ts",
		"**/*.tsx",
		"**/*.js",
		"**/.*.js",
	],
	"exclude": ["node_modules"]
}

Then, in your project's .eslintrc.js, add the following:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config/typescript'],
	parserOptions: {
		project: require.resolve('./tsconfig.eslint.json'),
	},
};

@noaignite-dk/eslint-config/react

Use this configuration if your project uses React + Typescript.

Usage

Create an eslint specific tsconfig file (tsconfig.eslint.json) with the following contents:

{
	"extends": "./tsconfig.json",
	"compilerOptions": {
		"allowJs": true,
		"checkJs": false,
	},
	"include": [
		"**/*.ts",
		"**/*.tsx",
		"**/*.js",
		"**/.*.js",
	],
	"exclude": ["node_modules"]
}

Then, in your project's .eslintrc.js, add the following:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config/react'],
	parserOptions: {
		project: require.resolve('./tsconfig.eslint.json'),
	},
};

@noaignite-dk/eslint-config/next

Use this configuration if your project uses Next.js + Typescript.

Usage

Create an eslint specific tsconfig file (tsconfig.eslint.json) with the following contents:

{
	"extends": "./tsconfig.json",
	"compilerOptions": {
		"allowJs": true,
		"checkJs": false,
	},
	"include": [
		"next-env.d.ts",
		"**/*.ts",
		"**/*.tsx",
		"**/*.js",
		"**/.*.js",
	],
	"exclude": ["node_modules"]
}

Then, in your project's .eslintrc.js, add the following:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config/next'],
	parserOptions: {
		project: require.resolve('./tsconfig.eslint.json'),
	},
};

If Next.js isn't installed in your root directory (such as a monorepo) rootDir must be configured in .eslintrc.js:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config/next'],
	settings: {
		next: {
			rootDir: "packages/my-app/"
		},
		'import/resolver': {
			typescript: {
				project: require.resolve('./tsconfig.eslint.json'),
			},
		},
	},
	parserOptions: {
		project: require.resolve('./tsconfig.eslint.json'),
	},
};

@noaignite-dk/eslint-config/import

Use this configuration to add sorting for your project.

Usage

Create an eslint specific tsconfig file (tsconfig.eslint.json) with the following contents:

{
	"extends": "./tsconfig.json",
	"compilerOptions": {
		"allowJs": true,
		"checkJs": false,
	},
	"include": [
		"**/*.ts",
		"**/*.tsx",
		"**/*.js",
		"**/.*.js",
	],
	"exclude": ["node_modules"]
}

Then, in your project's .eslintrc.js, add the following:

/** @type {import('eslint').Linter.Config} */
module.exports = {
	extends: ['@noaignite-dk/eslint-config/import'],
};

Common errors

1. Unable to resolve path to module '@alias/file'. eslint(import/no-unresolved)

This error typically occurs when eslint-import-resolver-typescript cannot resolve the correct tsconfig.json or a baseUrl is missing.

Resolutions:

  1. Make sure a baseUrl is set:

(tsconfig.eslint.json)

{
  "compilerOptions": {
    "baseUrl": "."
  }
}
  1. Try explicitly passing the tsconfig to the resolver:

(.eslintrc.js)

module.exports = {
	// [...]
	settings: {
		'import/resolver': {
			typescript: {
				project: require.resolve('./tsconfig.eslint.json'),
			},
		},
	},
	parserOptions: {
		project: require.resolve('./tsconfig.eslint.json'),
	},
};

Development

Install all necessary development dependencies by running pnpm install

Release

To release a new version, run pnpm release and follow the instructions.