Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/massivdash/projectanalyzer
Cli for investigating project structure and complexity
https://github.com/massivdash/projectanalyzer
Last synced: 1 day ago
JSON representation
Cli for investigating project structure and complexity
- Host: GitHub
- URL: https://github.com/massivdash/projectanalyzer
- Owner: MassivDash
- Created: 2024-07-13T13:49:19.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T03:11:06.000Z (about 2 months ago)
- Last Synced: 2024-11-07T06:47:41.483Z (8 days ago)
- Language: TypeScript
- Size: 2.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
📦 Project Analyzer
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](https://spaceout.pl/folders-files-and-everything-in-between)
---
## Installation
**Minimal node version**
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.
### CI uses
```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](https://spaceout.pl/)
(x/tweeter)[https://x.com/SpaceoutPl]