{"id":18470230,"url":"https://github.com/caioagiani/github-typos-scan","last_synced_at":"2025-04-08T10:33:06.447Z","repository":{"id":43409704,"uuid":"453997795","full_name":"caioagiani/github-typos-scan","owner":"caioagiani","description":"Simple tool to look for typos in github repositories","archived":false,"fork":false,"pushed_at":"2022-03-03T18:10:24.000Z","size":232,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T07:09:37.746Z","etag":null,"topics":["cli","github-typos-scan","javascript","nodejs","npm-package","puppeteer","tools","typos-check","typos-scan","word-typos"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caioagiani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://nubank.com.br/pagar/3lf5k/hgTQsUWzua"]}},"created_at":"2022-01-31T12:27:26.000Z","updated_at":"2024-05-22T14:27:05.000Z","dependencies_parsed_at":"2022-08-26T20:57:13.796Z","dependency_job_id":null,"html_url":"https://github.com/caioagiani/github-typos-scan","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fgithub-typos-scan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fgithub-typos-scan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fgithub-typos-scan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fgithub-typos-scan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caioagiani","download_url":"https://codeload.github.com/caioagiani/github-typos-scan/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247824406,"owners_count":21002267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","github-typos-scan","javascript","nodejs","npm-package","puppeteer","tools","typos-check","typos-scan","word-typos"],"created_at":"2024-11-06T10:13:21.752Z","updated_at":"2025-04-08T10:33:05.899Z","avatar_url":"https://github.com/caioagiani.png","language":"JavaScript","readme":"\u003c!--\n/*\n * Thanks for downloading this project, if you have any ideas, tweaks, etc...\n * fork the repository and create a Pull Request.\n */\n--\u003e\n\n# Github Typos Scan\n\n\u003cdiv align=\"left\"\u003e\n  \u003cimg alt=\"GitHub language count\" src=\"https://img.shields.io/github/languages/count/caioagiani/github-typos-scan\"\u003e\n  \u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/caioagiani/github-typos-scan\"\u003e\n  \u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/caioagiani/github-typos-scan\"\u003e\n  \u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/badge/license-GNU%20AGPL-blue.svg\"\u003e\n\u003c/div\u003e\n\n\u003ch3 align=\"left\"\u003eSimple tool to look for typos in github repositories\u003c/h3\u003e\n\n![screenshot-terminal-tools](https://github.com/caioagiani/github-typos-scan/blob/main/.github/assets/terminal.png)\n\n## Installation\n\n```bash\n# Download project\n$ git clone git@github.com:caioagiani/github-typos-scan.git\n\n# Join folder\n$ cd github-typos-scan\n\n# Install dependencies\n$ npm install\n```\n\n## Usage\n\n### As a CLI application:\n\n```bash\n$ npm install -g github-typos-scan\n\n$ github-typos-scan --url https://github.com/caioagiani/github-typos-scan\n```\n\n### As a NodeJS application:\n\n- Follow the [Installation](#installation) process;\n- 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;\n- Run `npm run start`.\n\nExample:\n\n```js\n(async () =\u003e {\n  const urlRepository = \"https://github.com/CheetahTemplate3/cheetah3\";\n\n  await scanGithubRepository(urlRepository);\n})();\n```\n\n## Development\n\n```bash\n# Download project\n$ git clone git@github.com:caioagiani/github-typos-scan.git\n\n# Join folder\n$ cd github-typos-scan\n\n# Install dependencies\n$ npm install\n\n# Install this app as a global module\n$ npm install -g .\n\n# Run the app\n$ github-typos-scan --url https://github.com/caioagiani/github-typos-scan\n```\n\n## License\n\nCopyright © 2022 [caioagiani](https://github.com/caioagiani).\u003cbr /\u003e\nEste projeto é licenciado [GNU AGPL](https://github.com/caioagiani/github-typos-scan/blob/master/LICENSE).\n","funding_links":["https://nubank.com.br/pagar/3lf5k/hgTQsUWzua"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaioagiani%2Fgithub-typos-scan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaioagiani%2Fgithub-typos-scan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaioagiani%2Fgithub-typos-scan/lists"}