Package Exports

github-typos-scan
github-typos-scan/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-typos-scan) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Github Typos Scan

Simple tool to look for typos in github repositories

screenshot-terminal-tools

Installation

# Download project
$ git clone git@github.com:caioagiani/github-typos-scan.git

# Join folder
$ cd github-typos-scan

# Install dependencies
$ npm install

Usage

As a CLI application:

$ npm install -g github-typos-scan

$ github-typos-scan --url https://github.com/caioagiani/github-typos-scan

As a NodeJS application:

Follow the Installation process;
Replace the line that says YOUR_GITHUB_URL_REPOSITORY at src/index.js with the url of a given repository you want to scan;
Run npm run start.

Example:

(async () => {
  const urlRepository = "https://github.com/CheetahTemplate3/cheetah3";

  await scanGithubRepository(urlRepository);
})();

Development

# Download project
$ git clone git@github.com: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

github-typos-scan