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

sails-generate-eslintrc

v1.4.0

Published

generate eslint config file which contains sails's globals

Downloads

2,544

Readme

sails-generate-eslintrc

Description

Generate eslint config file which contains sails's globals. It will generate .eslintrc-sails(sails globals file ) and .eslintrc (eslint config file. If it exists, it will be updated).

Parameter

  • -m --mode
    • Default : Append default globals which contains [sails] and object under ['api/controllers', 'api/models', 'api/services']
    • append: Add other globals given by other parameters(-g, -f), which are appended in sails globals file(.eslintrc-sails)
    • override: Override sails globals file by other parameter(-g, -f). If no other parameters, an empty sails globals file(.eslintrc-sails) will be created.
  • -g --globals : Give globals array. Example: -g sails,test1,test2.
  • -f --folders : Give folders array containing globals. Example: -f api/models,api/controllers.
  • -c --config : Set eslint config file name.
  • -p --preset : Set preset code style when creates a new eslint config file.
  • -s --show : Show globals added.

Files Example

  • .eslintrc-sails

    {
        "globals": {
            "sails": true,
            "UserController": true,
            "User": true
        }
    }
  • .eslintrc

    • If not exists: it will be created.

      {
          "extends": [
              "google",
              ".eslintrc-sails"
          ]
      }
    • If exists: it will be updated(fourth line)

      {
          "extends": [
              "google",
              ".eslintrc-sails"
          ],
          "env": {
              "node": true,
              "browser": true
          },
          "plugins": [
              "jsdoc"
          ],
          "globals": {}
      }  

Usage

  • global install(Recommend)

    • Install:

      npm install sails-generate-eslintrc -g
    • Run:

      • When you run it first:You can run it under project root path in command line.It will add [sails] and object under ['api/controllers', 'api/models', 'api/services']

        sails-generate-eslintrc
      • When you want to append some globals:

        sails-generate-eslintrc -g sails -f api/models -m append
      • When you want to override config file with globals given by paramters:

        sails-generate-eslintrc -g sails -f api/models -m override
  • install in project path

    • Install:

      npm install sails-generate-eslintrc
    • Run:

      • You need run it under project root path in command line

        node_modules/.bin/sails-generate-eslintrc

Tips

  • extend: google
    • If you want to use google or others as coding style, you may have to install:
    npm install eslint-config-google