Nonlinear Performance Magnification

    github-typos-scan

    0.1.3 • Public • Published

    Github Typos Scan

    GitHub language count GitHub top language GitHub repo size GitHub license

    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

    Copyright © 2022 caioagiani.
    Este projeto é licenciado GNU AGPL.

    Install

    npm i github-typos-scan

    DownloadsWeekly Downloads

    1

    Version

    0.1.3

    License

    MIT

    Unpacked Size

    44.2 kB

    Total Files

    11

    Last publish

    Collaborators

    • caioagiani