{"id":41179580,"url":"https://github.com/jkomyno/pate","last_synced_at":"2026-01-22T20:03:45.070Z","repository":{"id":57320622,"uuid":"113587031","full_name":"jkomyno/pate","owner":"jkomyno","description":"Modern and light-fast CLI app that scans all the desired files of a certain folder and returns a list with the name of the files which contain a certain RegEx pattern","archived":false,"fork":false,"pushed_at":"2020-07-21T12:38:50.000Z","size":286,"stargazers_count":24,"open_issues_count":12,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-30T11:22:34.154Z","etag":null,"topics":["async","cli","fs","node","readstream","reduce","typescript","utility"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jkomyno.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}},"created_at":"2017-12-08T15:13:44.000Z","updated_at":"2022-12-28T17:03:48.000Z","dependencies_parsed_at":"2022-08-25T21:00:50.395Z","dependency_job_id":null,"html_url":"https://github.com/jkomyno/pate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jkomyno/pate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jkomyno%2Fpate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jkomyno%2Fpate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jkomyno%2Fpate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jkomyno%2Fpate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jkomyno","download_url":"https://codeload.github.com/jkomyno/pate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jkomyno%2Fpate/sbom","scorecard":{"id":522573,"data":{"date":"2025-08-11","repo":{"name":"github.com/jkomyno/pate","commit":"736677b87135ad63597554c83384fcfebb8f838f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/5 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"70 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-xp63-6vf5-xf3v","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T03:26:22.130Z","repository_id":57320622,"created_at":"2025-08-20T03:26:22.130Z","updated_at":"2025-08-20T03:26:22.130Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28670366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T19:36:09.361Z","status":"ssl_error","status_checked_at":"2026-01-22T19:36:05.567Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["async","cli","fs","node","readstream","reduce","typescript","utility"],"created_at":"2026-01-22T20:03:45.008Z","updated_at":"2026-01-22T20:03:45.056Z","avatar_url":"https://github.com/jkomyno.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pate\n\nModern and light-fast CLI app that scans all the desired files of a certain folder and returns a list with the name of the files which contain a RegEx pattern.\n\n--------------------------------\n\n[![Travis](https://img.shields.io/travis/jkomyno/pate.svg?branch=master)](https://travis-ci.org/jkomyno/pate)\n[![npm](https://img.shields.io/npm/v/pate.svg)](https://npmjs.com/package/pate)\n[![npm](https://img.shields.io/npm/dm/pate.svg)](https://npmjs.com/package/pate)\n[![codecov](https://codecov.io/gh/jkomyno/pate/branch/master/graph/badge.svg)](https://codecov.io/gh/jkomyno/pate)  \n\n- [Overview](#overview)\n- [Installation](#installation)\n- [Motivation](#motivation)\n- [CLI](#cli)\n  - [Usage](#usage)\n  - [Examples](#examples)\n- [Contributing](#contributing)\n  - [Development Scripts](#development-scripts)\n  - [Build Note](#build-note)\n- [Other links](#other-links)\n- [Credits](#credits)\n- [License](#license)\n\n## Overview\n\n**pate** is a library that, given a RegExp pattern and a folder path, filters out every nested file in that folder\nwhich doesn't match the pattern. Optionally it's possible either to write the list of files that match to a file,\nto log every single action that's happening internally, or even to filter the files via a glob pattern.\n\nCurrently it isn't fully tested, so I'd be glad to receive PRs that enhance the current test suite.\n\nIt requires at least NodeJS 8.5.0 installed.\nTo the Windows users: the CLI app has a better UX if you use Git Bash.\n\n## Installation\n\nTo install the library:\n\nWith yarn:\n\n- `yarn add pate`\n\nOr, with npm:\n\n- `npm i -S pate`\n\nTo install the CLI app:\n\nWith yarn:\n\n- `yarn global add pate`\n\nOr, with npm:\n\n- `npm i -g pate`\n\n## Motivation\n\nI wanted to demonstrate a non-trivial use case for NodeJS' WriteStream and ReadStream API, while writing a solid\nand extensible library which might be actually useful for somebody. Also, I wanted it to be as fast as possible, and I also took time to make the command line interface to be as user friendly as possible.\n\n## CLI\n\n### Usage\n\n`$ pate --help` output:\n\n```\nUsage: pate [-v|--verbose] [-o|--output FILE] [-g|--glob 'glob pattern']\n          [-i|--ignore 'ignore pattern'] -m [MATCHPATTERN] -p [PATH]\n\nOptions:\n  --help         Show help                                             [boolean]\n  --version      Show version number                                   [boolean]\n  -m, --match    match pattern to look for in the files located in PATH\n                                                                      [required]\n  -p, --path     path where files will be collected                   [required]\n  -g, --glob     Filter files in PATH via a glob pattern. Note: it needs quotes\n                 to be properly parsed.                         [default: \"*.*\"]\n  -o, --output   file which will contain the list of the files in PATH that\n                 match MATCHPATTERN\n  -v, --verbose  Show current operation details in real-time\n                                                      [boolean] [default: false]\n  -i, --ignore   pattern that defines folders or files to exclude from the\n                 discovery                                 [array] [default: []]\n\nExamples:\n  pate  To look for every 'require' word in the js files inside node_modules,\n        saving the result to result.txt, you'd do:\n\n        pate -g '*.js' -o result.txt -m require -p ./node_modules\n\nDeveloped by jkomyno - Copyright 2017\nSubmit issues at https://github.com/jkomyno/pate\n```\n\n### Examples\n\nNote that glob patterns always require to be quoted (suggestion: use single quotes),\nwhile match patterns only need quotes when you're using RegEx specific syntax.\n\n\u003e list all *md* files in *./node_modules* which contain the sequence of characters *awesome*\n\n- `$ pate -p ./node_modules -m awesome -g '*.md' -v`\n\n\u003e list all **.d.ts* files in *./node_modules/@types* which contain the word *extends*\n\n- `$ pate -p ./node_modules/@types -m 'extends\\b' -g '*.d.ts' -v`\n\n\u003e list all **.js* files in */absolute/path* which contain the RegEx pattern *a?b+$*,\n  and redirect the list to ./found.txt\n\n-  `$ pate -p /absolute/path -m 'a?b+$' -g '*.js' -o ./found.txt`\n\n\u003e list all files whose extension is *js* or *ts* in *./node_modules*, which contain either the word *reduce* or *map*, redirect the list to ./found.txt while ignoring every index.js or index.ts file\n\n-  `$ pate -p ./node_modules -m 'reduce\\b|map\\b' -g '*.+(js|ts)' -i '**/index.+(js|ts)' -o ./found.txt`\n\n## Contributing\n\nAs always, contributions are always welcome, and remember:\n\n-   ⇄ Pull requests and ★ Stars are really welcome too.\n-   Just check out the dev scripts right below to get started.\n\n### Development scripts\n\n#### `build`\n\n\u003e traspiles the .ts files in ./src to a brand new ./dist folder\n\n-   `build:watch` - run build process in watch-mode\n\n#### `flow`\n\n\u003e checks if Flow definitions are written properly\n\n#### `lint`\n\n\u003e checks if code conforms to linting rules (tslint)\n\n-   `lint --fix` - will automatically fix ts files\n\n#### `publish`\n\n\u003e Runs all the linting/test suites\n\u003e Creates a brand new build\n\u003e Pushes a release to npm\n\n#### `test`\n\n\u003e checks if all unit tests pass (jest / ts-jest)\n\n-   `test:watch` - run tests in watch-mode\n-   `test:cov` - run tests and displays coverage\n\n## Other links\n\n- [Blog post on Medium.com](https://hackernoon.com/introducing-pate-my-latest-open-source-side-project-12da4fccd9fc)\n\n## Credits\n\n- [yargs](https://github.com/yargs/yargs): awesome CLI parser for NodeJS\n- [glob](https://github.com/isaacs/node-glob): shell-like match pattern for files\n- [chalk](https://github.com/chalk/chalk): used to bring colorful terminal logs\n\n## License\n\nThis project is [MIT](LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjkomyno%2Fpate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjkomyno%2Fpate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjkomyno%2Fpate/lists"}