{"id":30754196,"url":"https://github.com/sdgluck/argsy","last_synced_at":"2025-09-04T09:08:20.207Z","repository":{"id":63252882,"uuid":"102373894","full_name":"sdgluck/argsy","owner":"sdgluck","description":":maple_leaf: Awesome argument assertion","archived":false,"fork":false,"pushed_at":"2017-11-05T15:04:35.000Z","size":156,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-10T23:24:03.796Z","etag":null,"topics":[],"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/sdgluck.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-09-04T15:07:26.000Z","updated_at":"2017-11-10T03:37:20.000Z","dependencies_parsed_at":"2022-11-15T21:15:36.041Z","dependency_job_id":null,"html_url":"https://github.com/sdgluck/argsy","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/sdgluck/argsy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdgluck%2Fargsy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdgluck%2Fargsy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdgluck%2Fargsy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdgluck%2Fargsy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdgluck","download_url":"https://codeload.github.com/sdgluck/argsy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdgluck%2Fargsy/sbom","scorecard":{"id":807017,"data":{"date":"2025-08-11","repo":{"name":"github.com/sdgluck/argsy","commit":"caa3bdb924d649da4fc2776256a4d4aecb25b741"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"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":"Vulnerabilities","score":0,"reason":"57 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","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-9vvw-cc9w-f27h","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","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-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-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","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-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-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-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp","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-23T12:04:24.915Z","repository_id":63252882,"created_at":"2025-08-23T12:04:24.915Z","updated_at":"2025-08-23T12:04:24.915Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273581224,"owners_count":25131393,"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","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-09-04T09:07:03.840Z","updated_at":"2025-09-04T09:08:20.185Z","avatar_url":"https://github.com/sdgluck.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/sdgluck/argsy/blob/master/assets/maple.png\" /\u003e\n\u003c/p\u003e\n\n\u003cp\u003e\u003ch1 align=\"center\"\u003eargsy\u003c/h1\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eAwesome argument assertion\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eMade with ❤ at \u003ca href=\"http://www.twitter.com/outlandish\"\u003e@outlandish\u003c/a\u003e\u003c/p\u003e\n  \n\u003cp align=\"center\"\u003e\n    \u003ca href=\"http://badge.fury.io/js/argsy\"\u003e\u003cimg alt=\"npm version\" src=\"https://badge.fury.io/js/argsy.svg\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr/\u003e\n\nArgument-oriented assertions...\n\n- assertions that name offending arguments\n- collects assertion failures and groups them in a single error\n- reports function name, location, and [clean stack trace](https://github.com/sdgluck/error-clean-stack)\n- support for optional arguments\n\n\u003cimg src=\"https://github.com/sdgluck/argsy/blob/master/example.gif\" /\u003e\n \n## Example\n\n#### Before\n\n```js\nfunction hello (name, message) {\n  if (typeof name !== 'string' || !name.length) {\n    throw new Error('expecting name to be non-empty string')\n  } else if (message \u0026\u0026 typeof message !== 'string') {\n    throw new Error('expecting message to be string')\n  }\n  console.log('hello', name, message)\n}\nhello() //=\u003e Error: expecting name to be non-empty string\n```\n\n#### After\n\n```js\nfunction hello (name, message) {\n  assert('hello')\n    .nonEmptyStr(name)\n    .optional.str(message).$()\n  console.log('hello', name, message)\n}\nhello()\n//=\u003e  Error: Failed argument assertions in call to \"hello\" at C:/hello.js:1:\n//      - expecting name to be non-empty string\n```\n \n## Install\n\n```sh\nnpm install --save argsy\n```\n\n```sh\nyarn add argsy\n```\n\n## Import\n\n```js\n// ES2015\nimport assert from 'argsy'\n```\n\n```js\n// CommonJS\nvar assert = require('argsy')\n```\n\n## API\n\n### `assert.{method}(val[, subject][, name[, name2]])`\n\nAssert `val` is of type indicated by `method` (see below).\n\n- __val__ {*} value to assert\n- __subject__ {*} _(optional)_ subject of assert\n- __name__ {String} name to report in error message\n- __nam2__ {String} _(optional)_ name of subject\n\nNo return value.\n\n## `AssertionInstance`\n\n### `assert([name]) : AssertionInstance`\n\nCreate a new assertion instance.\n\n- __name__ {String} _(optional)_ name of the assertion instance \n\nReturns an `AssertionInstance`.\n\n### `AssertionInstance.{method}(val[, subject][, name[, name2]])`\n\nAssert `val` is of type indicated by `method` (see below).\n\n- __val__ {*} value to assert\n- __subject__ {*} _(optional)_ subject of assert\n- __name__ {String} name to report in error message\n- __nam2__ {String} _(optional)_ name of subject\n\nReturns the `AssertionInstance`.\n\n#### Methods\n\n```\nok\nnotOk\nstr\nobj\nnonEmptyStr\nnum\nsym\nint\nbool\nundef\nnull\nnan\nelem (use subject arg)\nkey (use subject arg)\n```\n\n### `AssertionInstance.optional.{method}()`\n\nAssert an optional value. \n\nShares the same API as `AssertionInstance.method` (see above).\n\nReturns the `AssertionInstance`.\n\n### `AssertionInstance.$eval()`\n\nAssert the arguments.\n\nThis should be called last in the chain of assertion declarations.\n\n## More Examples\n\n### `examples/report.js`\n\nEvaluates all assertions, groups them, and reports all failures.\n\nNote call to `$eval` at the end.\n\n```js\nfunction add (a, b) {\n  assert('add')\n    .num(a, 'a')\n    .num(b, 'b')\n    .$eval() // or just .$()\n    \n  return a + b\n}\n\nconst a = Number(process.argv[1])\nconst b = Number(process.argv[2])\nconst result = add(a, b)\n\nconsole.log(a, '+', b, '=', result)\n```\n\n#### Good\n\n```sh\n$ node examples/add.js 1 2\n1+2=3\n```\n\n#### Bad\n\n```sh\n$ node add.js\nError: Failed argument assertions in call to \"add\" at C:/argsy/examples/report.js:10:\n  - expecting a to be number\n  - expecting b to be number\n    at Function.evaluate (C:/argsy/src/index.js:63:13)\n    at add (C:/argsy/examples/report.js:10:6)\n    at Object.\u003canonymous\u003e (C:/argsy/examples/report.js:18:16)\n```\n\n### `examples/spongebob.js`\n\nStops and throws at first failed assertion.\n\n```js\nimport assert from 'argsy'\n\nfunction person (name, occupation) {\n  assert\n    .nonEmptyStr(name, 'name')\n    .optional.nonEmptyStr(occupation, 'occupation')\n\n  console.log(name + ' is a ' + (occupation || 'sponge'))\n}\n\nperson('Spongebob')\n//=\u003e Spongebob is a sponge\n\nperson(['Spongebob'], 'crabby patty flipper')\n//=\u003e Error: Expecting name to be a non-empty string\n\nperson('Spongebob', 'crabby patty flipper')\n//=\u003e Spongebob is a crabby patty flipper\n```\n\n## Contributing\n\nAll pull requests and issues welcome!\n\nIf you're not sure how, check out the [great video tutorials on egghead.io](http://bit.ly/2aVzthz)!\n\n## License\n\nMIT © [Sam Gluck](https://github.com/sdgluck)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdgluck%2Fargsy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdgluck%2Fargsy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdgluck%2Fargsy/lists"}