{"_id":"@capaj/ts-prune","_rev":"1-f41b649435bdc9e3ad6f06b50ce635b7","name":"@capaj/ts-prune","dist-tags":{"latest":"0.11.1"},"versions":{"0.11.0":{"name":"@capaj/ts-prune","version":"0.11.0","description":"Find potentially unused exports in your Typescript project with zero configuration.","keywords":["find","unused","exports","typescript","deadcode"],"main":"lib/index.js","author":{"name":"Nadeesha Cabral","email":"n@nadeesha.me"},"license":"MIT","scripts":{"build":"tsc","prepublish":"rm -rf lib && yarn build","test":"jest --coverage","test:integration":"sh integration/test.sh","lint":"eslint . --cache --fix --ext .ts,.tsx","semantic-release":"semantic-release"},"devDependencies":{"@types/jest":"^29.2.3","@types/json5":"^0.0.30","@types/lodash":"^4.14.190","@types/node":"^18.11.9","@typescript-eslint/parser":"^5.44.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","jest":"^29.3.1","prettier":"^2.8.0","semantic-release":"^19.0.5","ts-jest":"^29.0.3","ts-node":"^10.9.1","typescript":"^4.9.3"},"dependencies":{"chalk":"4.1.2","commander":"^9.4.1","cosmiconfig":"^8.0.0","json5":"^2.2.1","lodash":"^4.17.21","true-myth":"^6.2.0","ts-morph":"^17.0.1"},"bin":{"ts-prune":"lib/index.js"},"repository":{"type":"git","url":"git@github.com:nadeesha/ts-prune.git"},"release":{"branches":["master"]},"types":"lib/index.d.ts","_id":"@capaj/ts-prune@0.11.0","dist":{"shasum":"e33fb72966c3bd01582e626efd197ad90754e1b6","integrity":"sha512-2RVy/yG3O0HISpCttB1oXGw71JNHVKFpSjLaaW0E4kb4ievM9lVRYOL50la0WqmlDEDpWbIVzqx2P2PmdecWBQ==","tarball":"https://registry.npmjs.org/@capaj/ts-prune/-/ts-prune-0.11.0.tgz","fileCount":38,"unpackedSize":50686,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDAT3ztzkq+hHQcf7lKbiiecj+NPto4pp4BLcCiDt3+SgIhALzuX/yaXmOCpEO0lNDNpjzTyN+8VdIxXtm9p7964F6M"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjhfa0ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqVMhAAgLBoJyTQBP/HcnVF0OKHoO2mwowpWndTpFfVHHBPkfmP2y8b\r\nruseDq7JYz+2hvnk7R1epLkTWMCEVmBvZvgrQ8HF3pvvvEk/r98GDmHXdkdk\r\nlV/6ydxZ/nFl9tmsmzODY8W0w+9EqqLQNFvfVHHOagkW/lrSa0R3BI/buwum\r\nt/MyLoD4PgLDqJOtXMC6QOmS3AVQGAyVyVZab8LaKgaNxC5U7ToQOEvS/FsI\r\nfOO8/PZ1iwT6hVeUV09KBLlLC962+D183lC7RtXyYbJbq6MMgNzDbEK9HXoX\r\nQ2Tx5tOsv1db07D3bURKQBYgMt+Z2uTKTRlKwu25Yhoi8YPUf/gASpcdbmvx\r\nf8igCl5amhpL8qB23cB3ApZG6XNoKkgQx2rLhjqdwfc7mI/q9iWmmQn3K9VM\r\nGW2oXlIRpf4of4tJkP2R4NjSA4kGmkUFawf2QB5Jitojjo+QZb6WI1KPZ7rJ\r\nS+P1J+Sjp7e7qj8RM+qy66S84NzP8/114KYTHCrNI+Vewg0MtaI73DspdzN/\r\nc+kpArUYp95E966bvrvoqqcCPHI3UyHvKFM4ZOO2eBBlIVWfvRtdCaWnZN3s\r\nA1itj00zlwF0eWDQLh7NjjxkBLJ8FRVl+tItgdU+MHu0G6KQh7NifDS30zb2\r\n3YAsRisV2rdciVv4CZTPdhZjta+DLQA7uoI=\r\n=JZNL\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"capaj","email":"capajj@gmail.com"},"directories":{},"maintainers":[{"name":"capaj","email":"capajj@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-prune_0.11.0_1669723828075_0.8231656538633474"},"_hasShrinkwrap":false},"0.11.1":{"name":"@capaj/ts-prune","version":"0.11.1","description":"Find potentially unused exports in your Typescript project with zero configuration.","keywords":["find","unused","exports","typescript","deadcode"],"main":"lib/index.js","author":{"name":"Nadeesha Cabral","email":"n@nadeesha.me"},"license":"MIT","scripts":{"build":"tsc","prepublish":"rm -rf lib && yarn build","test":"jest --coverage","test:integration":"sh integration/test.sh","lint":"eslint . --cache --fix --ext .ts,.tsx","semantic-release":"semantic-release"},"devDependencies":{"@types/jest":"^29.2.3","@types/json5":"^0.0.30","@types/lodash":"^4.14.190","@types/node":"^18.11.9","@typescript-eslint/parser":"^5.44.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","jest":"^29.3.1","prettier":"^2.8.0","semantic-release":"^19.0.5","ts-jest":"^29.0.3","ts-node":"^10.9.1","typescript":"^4.9.3"},"dependencies":{"chalk":"4.1.2","commander":"^9.4.1","cosmiconfig":"^8.0.0","json5":"^2.2.1","lodash":"^4.17.21","true-myth":"^6.2.0","ts-morph":"^17.0.1"},"bin":{"ts-prune":"lib/index.js"},"repository":{"type":"git","url":"git@github.com:nadeesha/ts-prune.git"},"release":{"branches":["master"]},"types":"lib/index.d.ts","_id":"@capaj/ts-prune@0.11.1","dist":{"shasum":"6d2b72845e1152d0ca71c80c649f0a4b5f2d62d3","integrity":"sha512-2UEAwlLrsl8x4wNGDgYRpRGzdjqRxdOoAdunJws1qAb5fAy5jELmVukCS0+tFF7cnMbFg8vnxTN2l3h/xqKbVg==","tarball":"https://registry.npmjs.org/@capaj/ts-prune/-/ts-prune-0.11.1.tgz","fileCount":38,"unpackedSize":50594,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBfGFAEGOovo9tVHcwmG+mNBWjuz7Ny8JjfsnpuuCpRVAiBAOFnMalkePO1s9DA4PkNzOPo4ngk3e2kHL4J4v6+sWQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjhfcMACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq38g/8CCfPHFDigka7cOaKpsAXQ5Qa5RYKzVlbtN/RUPHpXmE2FMa0\r\nrtMb6uKrTZsnqT46YN45ws4Zf+SwJHaQQDpHWzHaDJXuYqO/Gy6xdYTgRhLk\r\n4tEk/Z5xsZ1cG8NAxkXJnEajbtKVlFz7Sfy35BMTNojaynL75F0bloTjgfOs\r\npSzy6efseEpRIjPBAygDOArCXZCpG8fbuXpxRgc+hqL/gYx3zvdZNWmpxyoF\r\n9BjhN5Ihe0Yt6zcCn0iL96NAaQGed9TLoMTcglVB4p9ad7WbqmlTcvkCLn5V\r\nOtIQFCs/wnjCpUAT+LVE3/jR628/kpsDQY1IB8XaJz9G/6s+osfmUm9MpcOK\r\nV83bxrlgDd2BmoiD5T1h0JuF3LqRMDUKRIvyI2Ba/B4FdTTs1QMYotubNy54\r\n8dJ7xJSr4909pjgYHy4JfLr34A42G6tA9/RqJqNd13ZQlm1oHwJzoTSco762\r\nQ7cPbFSxmVzNfP2yH3XJkgY0y5s7npJ6pRtgRz6b6BEJ9pfk0nXNVLxDUnMg\r\ntDutr1XRvhUAxYaC3fkxivObjO3fxqD24mauG1Ce3as1bI54TC+RLxNblTCj\r\nOGEP333mEcFOmw+5k9bTDN+BE3XRorADz/qYKXL5WkwqeqkODSimYG/YPql6\r\nBvZdSh/ANFikBrYdAvwSgZ+od5VHsoisq5k=\r\n=AgT5\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"capaj","email":"capajj@gmail.com"},"directories":{},"maintainers":[{"name":"capaj","email":"capajj@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-prune_0.11.1_1669723916038_0.5377676900705521"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-29T12:10:27.974Z","0.11.0":"2022-11-29T12:10:28.233Z","modified":"2022-11-29T12:11:56.318Z","0.11.1":"2022-11-29T12:11:56.207Z"},"maintainers":[{"name":"capaj","email":"capajj@gmail.com"}],"description":"Find potentially unused exports in your Typescript project with zero configuration.","keywords":["find","unused","exports","typescript","deadcode"],"repository":{"type":"git","url":"git@github.com:nadeesha/ts-prune.git"},"author":{"name":"Nadeesha Cabral","email":"n@nadeesha.me"},"license":"MIT","readme":"![Build](https://img.shields.io/github/workflow/status/nadeesha/ts-prune/Run%20CI%20Pipeline) ![npm](https://img.shields.io/npm/dm/ts-prune) ![GitHub issues](https://img.shields.io/github/issues-raw/nadeesha/ts-prune)\n\n# ts-prune\n\nFind potentially unused exports in your Typescript project with zero configuration.\n\n[![asciicast](https://asciinema.org/a/liQKNmkGkedCnyHuJzzgu7uDI.svg)](https://asciinema.org/a/liQKNmkGkedCnyHuJzzgu7uDI) [![Join the chat at https://gitter.im/ts-prune/community](https://badges.gitter.im/ts-prune/community.svg)](https://gitter.im/ts-prune/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n## Getting Started\n\n`ts-prune` exposes a cli that reads your tsconfig file and prints out all the unused exports in your source files.\n\n### Installing\n\nInstall ts-prune with yarn or npm\n\n```sh\n# npm\nnpm install ts-prune --save-dev\n# yarn\nyarn add -D ts-prune\n```\n\n### Usage\n\nYou can install it in your project and alias it to a npm script in package.json.\n\n```json\n{\n \"scripts\": {\n \"find-deadcode\": \"ts-prune\"\n }\n}\n```\n\nIf you want to run against different Typescript configuration than tsconfig.json:\n\n```sh\nts-prune -p tsconfig.dev.json\n```\n\n### Examples\n\n- [gatsby-material-starter](https://github.com/Vagr9K/gatsby-material-starter/blob/bdeba4160319c1977c83ee90e035c7fe1bd1854c/themes/material/package.json#L147)\n- [DestinyItemManager](https://github.com/DestinyItemManager/DIM/blob/aeb43dd848b5137656e6f47812189a2beb970089/package.json#L26)\n\n### Configuration\n\nts-prune supports CLI and file configuration via [cosmiconfig](https://github.com/davidtheclark/cosmiconfig#usage) (all file formats are supported).\n\n#### Configuration options\n\n- `-p, --project` - **tsconfig.json** path(`tsconfig.json` by default)\n- `-i, --ignore` - errors ignore RegExp pattern\n- `-e, --error` - return error code if unused exports are found\n- `-s, --skip` - skip these files when determining whether code is used. (For example, `.test.ts?` will stop ts-prune from considering an export in test file usages)\n\nCLI configuration options:\n\n```bash\nts-prune -p my-tsconfig.json -i my-component-ignore-patterns?\n```\n\nConfiguration file example `.ts-prunerc`:\n\n```json\n{\n \"ignore\": \"my-component-ignore-patterns?\"\n}\n```\n\n### FAQ\n\n#### How do I get the count of unused exports?\n\n```sh\nts-prune | wc -l\n```\n\n#### How do I ignore a specific path?\n\nYou can either,\n\n##### 1. Use the `-i, --ignore` configuration option:\n\n```sh\nts-prune --ignore 'src/ignore-this-path'\n```\n\n##### 2. Use `grep -v` to filter the output:\n\n```sh\nts-prune | grep -v src/ignore-this-path\n```\n\n#### How do I ignore multiple paths?\n\nYou can either,\n\n##### 1. Use the `-i, --ignore` configuration option:\n\n```sh\nts-prune --ignore 'src/ignore-this-path|src/also-ignore-this-path'\n```\n\n##### 2. Use multiple `grep -v` to filter the output:\n\n```sh\nts-prune | grep -v src/ignore-this-path | grep -v src/also-ignore-this-path\n```\n\n#### How do I ignore a specific identifier?\n\nYou can either,\n\n##### 1. Prefix the export with `// ts-prune-ignore-next`\n\n```ts\n// ts-prune-ignore-next\nexport const thisNeedsIgnoring = foo;\n```\n\n##### 2. Use `grep -v` to ignore a more widely used export name\n\n```sh\nts-prune | grep -v ignoreThisThroughoutMyCodebase\n```\n\n### Acknowledgements\n\n- The excellent [ts-morph](https://github.com/dsherret/ts-morph) library. And [this gist](https://gist.github.com/dsherret/0bae87310ce24866ae22425af80a9864) by [@dsherret](https://github.com/dsherret).\n\n### Contributors\n\n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n\n
\n \n Nadeesha\n
\n Nadeesha Cabral\n \n 		\n \n Snyk\n
\n Snyk bot\n \n 		\n \n Dan\n
\n Dan Vanderkam\n \n 		\n \n Josh\n
\n Josh Goldberg\n \n 		\n \n Vitaly\n
\n Vitaly Iegorov\n \n 		\n \n Amir\n
\n Amir Arad\n \n
\n \n Caleb\n
\n Caleb Peterson\n \n 		\n \n David\n
\n David Graham\n \n 		\n \n Davis\n
\n Davis Ford\n \n 		\n \n Ivo\n
\n Ivo Raisr\n \n 		\n \n Jacob\n
\n Jacob Bandes-Storch\n \n 		\n \n Kristján\n
\n Kristján Oddsson\n \n
\n \n Mikhail\n
\n Mikhail Belyaev\n \n 		\n \n Reece\n
\n Reece Daniels\n \n 		\n \n Simon\n
\n Simon Jang\n \n 		\n \n The\n
\n The Gitter Badger\n \n 		\n \n Tim\n
\n Tim Bodeit\n \n 		\n \n Tim\n
\n Tim Saunders\n \n
\n \n Torkel\n
\n Torkel Rogstad\n \n 		\n \n Victor\n
\n Victor Nogueira\n \n 		\n \n William\n
\n William Candillon\n \n 		\n \n curtvict/\n
\n curtvict\n \n 		\n \n phiresky/\n
\n phiresky\n \n
\n","readmeFilename":"README.md"}