github-typos-scan

Typos github scan

0.1.3
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 1; decreased by-85.71%

Maintainers: 1

Weekly downloads

Created: 3 years ago

Source

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

License

Keywords

FAQs

What is github-typos-scan?

Is github-typos-scan popular?

Is github-typos-scan well maintained?

Package last updated on 26 Feb 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install