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

grunt-eslint-config

v1.0.0

Published

Loads `.eslintrc.js` or `.eslintignore` for being used as the options of `grunt-eslint`. Helps keeping the configuration at a single place.

Downloads

8

Readme

grunt-eslint-config

Latest version Dependency status Coverage

Loads .eslintrc.js or .eslintignore for being used as the options of grunt-eslint. Helps keeping the configuration at a single place.

See grunt-eslintignore for reusing just eslintignore.

How It Works

Let's say that you let all JavaScript files in your project checked as simply as possible by eslint '**/*.js'. You'll use .eslintrc.js or .eslintignore to exclude generated files and build tools. This setup allows using IDE extensions with eslint. However, if you use grunt for building your project, you'll find that grunt-eslint doesn't use ignore patterns from .eslintrc.js or .eslintignore. You'd have to duplicate the ignored patterns in the Gruntfile, when specifying the file patterns to check. You'll be able to reuse .eslintrc.js or .eslintignore , when configuring the eslint task:

const { readEslintConfigFileSync } = require('grunt-eslint-config')

module.exports = grunt => {
  grunt.initConfig({
    eslint: readEslintConfigFileSync()
  })

  grunt.loadNpmTasks('grunt-eslint')
  grunt.registerTask('default', ['eslint'])
}

The contents of .eslintrc.js, for example:

module.exports = {
  extends: ['eslint:recommended'],
  parserOptions: { ecmaVersion: 'latest' },
  env: { node: true }
}

The contents of .eslintignore, for example:

dist/
node_modules/

The options returned by readEslintConfigFileSync are ready to be used for grunt-eslint, for example:

{
  "options": { "overrideConfigFile": ".eslintrc.js" },
  "validate": [
    "**/*.{js,cjs,mjs}",
    "!dist/**/*",
    "!node_modules/**/*"
  ]
}

Alternatively, you can set the ignore patterns to the ignorePatterns property in .eslintrc.js instead of supplying eslintignore.

Installation

This module can be installed in your project using NPM, PNPM or Yarn. Make sure, that you use Node.js version 16 or newer.

$ npm i grunt grunt-eslint@^24 grunt-eslint-config
$ pnpm i grunt grunt-eslint@^24 grunt-eslint-config
$ yarn add grunt grunt-eslint@^24 grunt-eslint-config

Files .eslintignore and the traditional .eslintrc.js were deprecated in eslint 9. If you use them, you probably pin eslint to ^8 and grunt-eslint to ^24.

API

interface ReadEslintConfigOptions {
  // Override the default configuration file name (`.eslintrc.{js,cjs,mjs}`).
  configFileName?: string

  // Override the default pattern for validating scripts (`['**/*.{js,cjs,mjs}']`).
  scriptFiles?: string[]

  // Override the default file name (`.eslintignore`).
  ignoreFileName?: string

  // Override the default current working directory (returned by `process.cwd()`).
  currentWorkingDir?: string

  // The root directory of the current project. It's the directory with `package.json`,
  // where `.eslintignore` is expected. It can be an absolute path or a path relative
  // to `currentWorkingDir`.
  //
  // If this property isn't set, the project directory will be looked by traversing
  // the current working directory and its ancestors until `package.json` is found.
  // The check for `package.json` and going up wil be repeated on `maxDepthToRoot` times.
  projectRootDir?: string

  // The root directory of the current project. It's the directory with `package.json`,
  // where `.eslintignore` is expected. It can be an absolute path or a path relative
  // to `currentWorkingDir`.
  // 
  // How many times will `package.json` be looked up and if not found,
  // go up to the parent directory. The default value is `10`.
  maxDepthToRoot?: number
}

// An object to be used as options for the grunt task `eslint`.
interface GruntEslintOptions {
  options: { overrideConfigFile: string },
  validate: string[]
}

// Reads the contents of `.eslintrc.{js,cjs,mjs}` and returns an object with options
// for the `grunt-eslint` task. If no config file is found, an error will be thrown.
//
// options: see `ReadEslintConfigOptions`
// returns: see `GruntEslintOptions`
function readEslintConfigFile(options?: ReadEslintConfigOptions): Promise<GruntEslintOptions>

// Reads the contents of `.eslintrc.{js,cjs,mjs}` and returns an object with options
// for the `grunt-eslint` task. If no config file is found, an error will be thrown.
//
// options: see `ReadEslintConfigOptions`
// returns: see `GruntEslintOptions`
function readEslintConfigFileSync(options?: ReadEslintConfigOptions): GruntEslintOptions

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2024 Ferdinand Prantl

Licensed under the MIT license.