Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/angular-experts-io/ng-parsel

Parse your Angular code base to JSON abstraction - Great for displaying APIs and running custom analysis
https://github.com/angular-experts-io/ng-parsel

Last synced: 23 days ago
JSON representation

Parse your Angular code base to JSON abstraction - Great for displaying APIs and running custom analysis

Host: GitHub
URL: https://github.com/angular-experts-io/ng-parsel
Owner: angular-experts-io
License: mit
Created: 2022-11-28T10:31:39.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-03-14T16:37:34.000Z (9 months ago)
Last Synced: 2024-03-15T08:55:49.819Z (9 months ago)
Language: TypeScript
Homepage:
Size: 9.63 MB
Stars: 9
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-angular - ng-parsel - Parse your Angular code base to JSON abstraction - Great for displaying APIs and running custom analysis. (Table of contents / Third Party Components)
fucking-awesome-angular - ng-parsel - Parse your Angular code base to JSON abstraction - Great for displaying APIs and running custom analysis. (Table of contents / Third Party Components)

README

# ng-parsel

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)

[![Coverage Status](https://coveralls.io/repos/github/angular-experts-io/ng-parsel/badge.svg?branch=main)](https://coveralls.io/github/angular-experts-io/ng-parsel?branch=main)

> Convert your Angular components to JSON

- [What is this module about](#what-is-this-module-about)
- [Getting started](#getting-started)
- [Install](#install)
- [Init configuration](#init-configuration)
- [Commands](#commands)
- [Parse](#parse)
- [Parse script](#parse-script)
- [NPX](#npx)
- [Configuration](#configuration)
- [Stats](#stats)
- [Stats script](#stats-script)
- [NPX](#npx-1)
- [Types](#types)
- [Type detection](#type-detection)
- [Outputs](#outputs)
- [Contributors](#contributors)

## What is this module about

This module extracts the most important information of your Angular code base and converts it into JSON. Having the most
important parts of your Angular code base as JSON can be very useful to perform custom analysis or to display APIs.
Displaying APIs is especially useful for library authors that want to illustrate their library in a component showcase.

## Getting started

### Install

Install ng-parsel as a dev dependency in your repository.

```bash
npm i -D @angular-experts/ng-parsel
```

### Init configuration

Once installed you can use npx to create an initial configuration for ng-parsel.

```bash
npx @angular-experts/ng-parsel init
```

Running this command will create a `.parselrc.json` configuration file in the root of your repository. Check the initial
configuration and adjust if needed. The configuration properties and their meaning are explained in
the [configuration section](#configuration).

## Commands

### Parse

To parse the code base you can either create a parse script in your `package.json`which calls `ng-parsel` or you can use
npx.

#### Parse script

Add the following script to your `package.json`.

```json
"parse": "@angular-experts/ng-parsel parse"
```

Once added, you can open up a terminal and run the following command.

```bash
npm run parse
```

#### NPX

To parse your code base with npx you can run the follwoing command inisde a terminal of your choice.

```bash
npx @angular-experts/ng-parsel parse
```

#### Configuration

ng-parsel offers the following configurations.

| Property | Default value | Description |
| --------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| src | 'src' | Glob to query all the src files that should be parsed |
| out | 'ng-parsel' | Output directory |
| parseComponents | true | If set to `true` ng-parsel will parse Angular Components and include them in the output. |
| parseServices | true | If set to `true` ng-parsel will parse Angular Services and include them in the output. |
| parsePipes | true | If set to `true` ng-parsel will parse Angular Pipes and include them in the output. |
| parseDirectives | true | If set to `true` ng-parsel will parse Angular Directives and include them in the output. |
| parseModules | true | If set to true ng-parsel will parse Angular Modules and include them in the output. |
| parseHarnesses | true | If set to true ng-parsel will parse Harness test files (all files ending with `.harness.ts`) and include them in the output. |
| parseValidators | true | If set to true ng-parsel will parse Validators (all files ending with `.validator.ts`) and include them in the output. |
| parseSpecs | true | If set to true ng-parsel will parse testing files (all files ending with `.spec.ts`) and include them in the output. |
| singleFile | true | If set to to `true` the output will be written to a `ng-parsel.json` file in the output directory. If set to false, ng-parsel will generate multiple output files, one for each `componentType`. (Find out more on component types in the [next section](#component-type)) |

### Stats

The stats command is a command that gives you a quick overview of your Angular application. It shows you how many components, services, pipes, directives, modules, harnesses and specs you have in your application. Furthermore, it shows you interesting insights, like how many are standanlone and how many are part of a module.
To run the stats command you can either create a stats script in your `package.json`which calls `ng-parsel` or you can use `npx`;

#### Stats script

```json
"stats": "@angular-experts/ng-parsel stats"
```

#### NPX

```bash
npx @angular-experts/ng-parsel stats
```

## Types

Currently ng-parsel classifies each file into one of the following `NgParselOutputType`.

- Component
- Service
- Pipes
- Modules
- Directives
- Harnesses
- Specs
- Unknown

Unknown files will not be parsed. If you need support for additional types please raise an issue or open a PR.

## Type detection

Harnesses, Specs and Validators are detected by the filename. Everything that ends with `.spec` will be classified
as a spec file. Everything that ends with `.harness` will be classified as a harness file. Everything that ends with
`.validator` will be classified as a validator file.

All other types are detected by their Angular decorators.

## Outputs

Single outputs will be written to a `ng-parsel.json` file in the output directory.
If `singleFile` is set to `false` ng-parsel will generate multiple output files, one for each `componentType`. (Find out more on [component types](#component-type))

## Contributors

_{Kevin Kreuzer}
💻 🐛 🖋 📖 🎨 🤔 🚧 📦 🔬

_@NgDaddy
🤔

_{Ilir Beqiri}
💻 ⚠️

_Quentin
🚧 💻