📦 Project Analyzer

!codeQL!CI!Compliation!CodeCoverage

Welcome to Project Analyzer, a global npm package that provides code complexity scores and codebase statistics for your projects.

More info on used method to calculate score here

---

Installation

Minimal node version

!Static Badge

To install Project Analyzer, simply run the following command:

``
npm i -g project-analyzer
`

Usage

Once installed, you can execute Project Analyzer in any folder to analyze the complexity and statistics of your codebase.

`
projectAnalyzer
`

Arguments

`bash

Usage: projectAnalyzer [options]

Options:
-h, --help display help for command
-p, --path specify the path to the directory to analyze
-o, --output

specify the output file name
-m, --markdown output the results in markdown format
-s, --silent do not output the results to the console
-t, --tree output folder structure as a tree

`

---

Features

- Code complexity scoring
- Codebase statistics

Authentication

Project Analyzer does not require any authentication. It analyzes your codebase locally without the need for any external services.

$3

`yml
name: "Test"
on:
pull_request:

jobs:
test:
runs-on: ubuntu-latest

permissions:
# Required to checkout the code
contents: read
# Required to put a comment into the pull-request
pull-requests: write

steps:
- uses: actions/checkout@v4
- name: "Install Node"
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Run project analyzer
run: npm i -g project-analyzer && projectAnalyzer -m
- name: Add Project Analysis PR Comment
uses: marocchino/sticky-pull-request-comment@v2
if: github.event_name == 'pull_request'
with:
recreate: true
path: analysis.md
``

Thank you for choosing Project Analyzer for your code analysis needs!

---

Luke Celitan, Spaceghost

(x/tweeter)[https://x.com/SpaceoutPl]