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-config-simplesense

v6.0.2

Published

ESLint Config for Simplesense Styles

Downloads

19,229

Readme

Simplesense ESLint Config

GitHub Pages Build

Generating Documentation

All rules must be documented so they can be searched in GitHub Pages. Documentation is auto-generated using the generate-docs script. Most ESLint plugins provide individual rules' documentation with the file structure of docs/<rule-name>.md in their source. Some plugins will ship the docs directory within their package, others exclude them by not providing the docs directory within their package configuration.

  • When docs are shipped with the NPM module, use the writeFromModules method.
  • When docs exist, but are not available within node_modules, use the writeFromGitHub method.
  • When no docs are provided, create individual markdown files, following docs/static/<plugin-name>/<rule-name>.md, and use the writeFromStatic method.

Adding Plugins / Configurations

Adding plugins is fairly straightforward.

Step 1

  • To simply use a recommended configuration, add the plugin as a dependency and add config to the config directory that imports the recommended rules and the plugin itself. Then add the config to the exported array in index.js.
  • To configure custom rules for a plugin, add a new file, rules/<plugin-name>.js, and export the rules object. Then add the config by following the details in the previous step, however, use the custom rules by themselves or with the exported recommended rules of the plugin.
  • If the new plugin lints a new file type, add a index.<filetype> file to the filetypes directory and update the lint:eslint script in package.json to include the new extension.

Step 2

Add your new plugin to the docs-config helper, specifiying the necessary properties required to generate the documentation.

Step 3

Verify everything builds as expected.

npm install
npm run lint
npm run test
npm run docs:dev
# navigate to the URL provided by Vitepress