Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caioagiani/github-typos-scan
Simple tool to look for typos in github repositories
https://github.com/caioagiani/github-typos-scan
cli github-typos-scan javascript nodejs npm-package puppeteer tools typos-check typos-scan word-typos
Last synced: about 2 months ago
JSON representation
Simple tool to look for typos in github repositories
- Host: GitHub
- URL: https://github.com/caioagiani/github-typos-scan
- Owner: caioagiani
- License: agpl-3.0
- Created: 2022-01-31T12:27:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-03T18:10:24.000Z (almost 3 years ago)
- Last Synced: 2024-10-29T03:40:03.037Z (about 2 months ago)
- Topics: cli, github-typos-scan, javascript, nodejs, npm-package, puppeteer, tools, typos-check, typos-scan, word-typos
- Language: JavaScript
- Homepage:
- Size: 227 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Github Typos Scan
Simple tool to look for typos in github repositories
## Installation
```bash
# Download project
$ git clone [email protected]:caioagiani/github-typos-scan.git
# Join folder
$ cd github-typos-scan
# Install dependencies
$ npm install
```
## Usage
### As a CLI application:
```bash
$ npm install -g github-typos-scan
$ github-typos-scan --url https://github.com/caioagiani/github-typos-scan
```
### As a NodeJS application:
- Follow the [Installation](#installation) process;
- Replace the line that says `YOUR_GITHUB_URL_REPOSITORY` at [src/index.js](./src/index.js) with the url of a given repository you want to scan;
- Run `npm run start`.
Example:
```js
(async () => {
const urlRepository = "https://github.com/CheetahTemplate3/cheetah3";
await scanGithubRepository(urlRepository);
})();
```
## Development
```bash
# Download project
$ git clone [email protected]:caioagiani/github-typos-scan.git
# Join folder
$ cd github-typos-scan
# Install dependencies
$ npm install
# Install this app as a global module
$ npm install -g .
# Run the app
$ github-typos-scan --url https://github.com/caioagiani/github-typos-scan
```
## License
Copyright © 2022 [caioagiani](https://github.com/caioagiani).
Este projeto é licenciado [GNU AGPL](https://github.com/caioagiani/github-typos-scan/blob/master/LICENSE).