jQAssistant npm Plugin

This is the npm Plugin for jQAssistant. It provides a scanner for package.json files of npm projects.

Installation

Add the plugin to the plugins section of the jqassistant.yml configuration file:

jqassistant:
  plugins:
    # Includes the jQAssistant NPM plugin
    - group-id: org.jqassistant.plugin
      artifact-id: jqassistant-npm-plugin
      version: 2.1.0
  scan:
    include:
      files:
        - ${project.basedir}/package.json

Reference Documentation

The plugin provides a scanner which accepts files with the name package.json and creates the structure as described in this section, using the items defined in the npm Docs and having nodes labeled with :NPM:Package:Json:File as entry point.

Node-Types:

• :NPM:Package:Json:File
  • :NPM:Binary
  • :NPM:BugTracker
  • :NPM:Config
  • :NPM:Cpu
  • :NPM:Dependency
  • :NPM:DevEngine
  • :NPM:Engine
  • :NPM:Export:File
  • :NPM:Funding
  • :NPM:Man
  • :NPM:Os
  • :NPM:Overrides
  • :NPM:Person
  • :NPM:PublishConfig
  • :NPM:Repository
  • :NPM:Script
  • :NPM:Workspace:File:Directory