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

static-code-analysis

v0.1.9

Published

Analyzes the ESLINT/Code Coverage/Lines of Code and uploads results to Firebase

Downloads

13

Readme

static-code-analysis

Script to analyze the eslint/code coverage/lines of code and upload to firebase (dashboard repo coming later)

Installation

npm install --save-dev static-code-analysis sloc

You can also install the sloc module as well, in order to get number of lines of code reported.

Usage

To use this project you simply have to create an entry in your package.json to point to the paths where your eslint/karma/sloc outputs are:

"staticCodeAnalysis": {
    "type": "javascript",
    "locations": {
      "eslint": "/coverage/eslint.json",
      "sloc": "/coverage/sloc.json",
      "karma-coverage": "/coverage/coverage.txt"
    }
}

The locations key directly correlates to the parser that will be used. You will find a parser with the same name under static-code-analysis/parsers.

You will then want to add a few NPM scripts to make your life easier:

"lint:save": "eslint public server -f node_modules/static-code-analysis/formatters/eslint.js > ./coverage/eslint.json",
"loc": "sloc public/ --format json > ./coverage/sloc.json",
"presca": "npm run lint:save && npm run loc",
"sca": "sca"

This will make sure to run the eslint and sloc before calling the sca module, which uploads the results to Firebase.

Configuring the Build

You will want to configure your jenkins build to first Inject environment variables to the build process

# SECTION: Properties Content 
# GALAXY VARIABLES
GALAXY_FIREBASE=#YOUR_FIREBASE_URL#
SLACK_WEBHOOK=#YOUR_SLACK_WEBHOOK#
SLACK_CHANNEL=#YOUR_CHANNEL#

and then you can call the sca tool via an execute shell build step

# Static Code Analysis
npm run sca ${GALAXY_FIREBASE} ${SLACK_WEBHOOK} ${SLACK_CHANNEL}

Creating a New Parser

In order to create a new parser, you first will want to have whatever tool output into a JSON/TXT/XML/etc file. Then you will create a new parser inside the static-code-analysis/parsers folder. This parser will read the file and put it in a readable format for Galaxy (follow the other parsers). You then can just supply that new location into your package.json.

You might be required to make changes to the Galaxy UI in order to be able to consume the new metrics.