{"id":13447712,"url":"https://github.com/yamafaktory/shrimpit","last_synced_at":"2025-03-22T01:31:14.208Z","repository":{"id":14272012,"uuid":"76205631","full_name":"yamafaktory/shrimpit","owner":"yamafaktory","description":"Shrimpit 🍤 is a small CLI analysis tool for checking unused JavaScript, JSX \u0026 Vue templates ES6 exports in your project.","archived":true,"fork":false,"pushed_at":"2024-08-22T11:57:17.000Z","size":1549,"stargazers_count":258,"open_issues_count":30,"forks_count":16,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-18T02:26:11.639Z","etag":null,"topics":["es6","export","exports","import","imports","javascript","jsx","modules","tool","vuejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yamafaktory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-11T23:04:52.000Z","updated_at":"2024-08-31T20:05:53.000Z","dependencies_parsed_at":"2024-04-17T05:35:19.685Z","dependency_job_id":"e9b5373c-5193-4dff-8cdf-77ded3db614a","html_url":"https://github.com/yamafaktory/shrimpit","commit_stats":{"total_commits":265,"total_committers":5,"mean_commits":53.0,"dds":0.4226415094339623,"last_synced_commit":"64866939edf724f0aacd2fb39373241fe36d03b6"},"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamafaktory%2Fshrimpit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamafaktory%2Fshrimpit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamafaktory%2Fshrimpit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamafaktory%2Fshrimpit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yamafaktory","download_url":"https://codeload.github.com/yamafaktory/shrimpit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244893431,"owners_count":20527589,"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":["es6","export","exports","import","imports","javascript","jsx","modules","tool","vuejs"],"created_at":"2024-07-31T05:01:25.007Z","updated_at":"2025-03-22T01:31:13.703Z","avatar_url":"https://github.com/yamafaktory.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","📦 Legacy \u0026 Inactive Projects"],"sub_categories":[],"readme":"# Shrimpit :fried_shrimp: [![Build Status](https://github.com/yamafaktory/shrimpit/workflows/ci/badge.svg)](https://github.com/yamafaktory/shrimpit/actions) [![npm version](https://img.shields.io/npm/v/shrimpit.svg?style=flat)](https://www.npmjs.com/package/shrimpit) [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)\n\n\n\nShrimpit is a small CLI analysis tool for checking unused JavaScript, JSX \u0026 Vue templates ES6 exports in your project.\n\n## Install\n\n### npm\n\n```shell\nnpm i -g shrimpit\n```\n\n### yarn\n\n```shell\nyarn global add shrimpit\n```\n\n## Usage\n\n```shell\nshrimpit path/to/your/files /another/path\n```\n\nGlobbing patterns are also supported:\n\n```shell\nshrimpit test/**/*.js\n```\n\nAdding the `--tree` flag will output the complete files tree with all the imports and the exports per file:\n\n```shell\nshrimpit --tree path/to/your/files\n```\n\nPlease note that default unnamed exports are rendered as `default (unnamed)`:\n\n```shell\nshrimpit test --tree\n Shrimpit!\n\n \u003e Files tree\n\n{ test:\n   { core:\n      { a:\n         { 'a.js':\n            { imports:\n               [ { location: 'test/core/b/b.js',\n                   name: 'test',\n                   unnamedDefault: true },\n                 { location: 'test/core/b/b.js',\n                   name: 'a',\n                   unnamedDefault: false },\n                 { location: 'test/core/c/c.js',\n                   name: 'User',\n                   unnamedDefault: true } ],\n              exports:\n               [ { location: 'test/core/a/a.js',\n                   name: 'a',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js',\n                   name: 'c',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js', name: 'd', unnamedDefault: true } ] } },\n        b:\n         { 'b.js':\n            { imports:\n               [ { location: 'test/core/c/c.js',\n                   name: 'Cat',\n                   unnamedDefault: false },\n                 { location: 'test/core/d/d.js',\n                   name: 'unamedFunction',\n                   unnamedDefault: true },\n                 { location: 'test/core/a/a.js',\n                   name: 'a',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js',\n                   name: 'c',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js', name: 'd', unnamedDefault: true } ],\n              exports:\n               [ { location: 'test/core/b/b.js',\n                   name: 'a',\n                   unnamedDefault: false },\n                 { location: 'test/core/b/b.js',\n                   name: 'b',\n                   unnamedDefault: false },\n                 { location: 'test/core/b/b.js',\n                   name: 'default (unnamed)',\n                   unnamedDefault: true } ] } },\n        c:\n         { 'c.js':\n            { imports:\n               [ { location: 'test/core/a/a.js',\n                   name: 'a',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js',\n                   name: 'c',\n                   unnamedDefault: false },\n                 { location: 'test/core/a/a.js',\n                   name: 'd',\n                   unnamedDefault: false },\n                 { location: 'test/core/b/b.js',\n                   name: 'b',\n                   unnamedDefault: false } ],\n              exports:\n               [ { location: 'test/core/c/c.js',\n                   name: 'Cat',\n                   unnamedDefault: false },\n                 { location: 'test/core/c/c.js',\n                   name: 'User',\n                   unnamedDefault: true } ] } },\n        d:\n         { 'd.js':\n            { imports: [],\n              exports:\n               [ { location: 'test/core/d/d.js',\n                   name: 'test/core/d',\n                   unnamedDefault: true } ] } } } } }\n\n \u003e Unused exports\n\nAll Clear Ahead, Captain.\n```\n\n## Flow \u0026 Vue\n\nShrimpit supports [Flow annotations](https://flowtype.org/) and Vue templates out of the box!\n\n# TypeScript (experimental)\n\nSince Babel 7, the TypeScript AST can directly be parsed. You can use the `--typescript` flag to enable it:\n\n```shell\nshrimpit --tree --typescript path/to/your/files\n```\n\nPlease note that the Flow and TypeScript parsers are mutually exclusive.\n\n## Linting\n\nThe code quality is checked by the [JavaScript Standard Style](http://standardjs.com/).\n\n## License\n\nReleased under the [MIT license](https://opensource.org/licenses/MIT) by Davy Duperron.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamafaktory%2Fshrimpit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamafaktory%2Fshrimpit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamafaktory%2Fshrimpit/lists"}