Skip to content

Commit

Permalink
docs(scanner): update readme and add history
Browse files Browse the repository at this point in the history
  • Loading branch information
bjohansebas committed Sep 1, 2024
1 parent ef905e0 commit 5102ab8
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 38 deletions.
50 changes: 12 additions & 38 deletions packages/scanner/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# @rapidapp/scanner

[![NPM Version][npm-version-image]][npm-url]
[![NPM Install Size][npm-install-size-image]][npm-install-size-url]

> A simple scan the technologies used in a TypeScript/JavaScript project
## Install

```sh
npm install ora
npm install @bjohansebas/scanner
```

## Usage


```js
import { generateReport } from '@rapidapp/scanner'
import { scanFolder } from '@rapidapp/scanner/helpers'
import { generateReport } from '@bjohansebas/scanner'
import { scanFolder } from '@bjohansebas/scanner/helpers'

const files = await scanFolder(process.cwd())

Expand Down Expand Up @@ -63,40 +66,11 @@ Type: `string`

Path where it will start searching for all files

## CLI

### Installation

```bash
npm i -g rapidapp
```

### Usage

```bash
rapidapp scan <project-directory>
```

### Output

```json
[
"name": "project-name",
"packages": [
{
"name": "package-name",
"languages": ["typescript","javascript"],
"linters": ["eslint"],
"formatter": ["prettier"]
}
],
"languages": ["typescript","javascript"],
"package_manager": "pnpm",
"linters": ["biome"],
"formatter": ["biome"]
]
```

## License

[Mozilla Public License Version 2.0](https://github.com/bjohansebas/rapidapp/blob/main/LICENSE)
[Mozilla Public License Version 2.0](https://github.com/bjohansebas/pkgs/blob/main/LICENSE)

[npm-install-size-image]: https://badgen.net/packagephobia/install/@bjohansebas/scanner
[npm-install-size-url]: https://packagephobia.com/result?p=%40bjohansebas%2Fscanner
[npm-url]: https://npmjs.com/package/@bjohansebas/scanner
[npm-version-image]: https://badgen.net/npm/v/@bjohansebas/scanner
8 changes: 8 additions & 0 deletions packages/scanner/history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
0.1.0
==========

* Support eslint report
* Support biome report
* Support prettier report
* Support Typescript and Javascript report
* Support package manager report

0 comments on commit 5102ab8

Please sign in to comment.