{"id":20937013,"url":"https://github.com/levp/sqrup","last_synced_at":"2026-04-26T09:32:35.318Z","repository":{"id":57368409,"uuid":"155883291","full_name":"levp/sqrup","owner":"levp","description":"Surround text with a rectangle and draw attention to it.","archived":false,"fork":false,"pushed_at":"2018-11-04T16:34:32.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-29T10:13:52.015Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/levp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-02T15:12:49.000Z","updated_at":"2018-11-04T16:34:34.000Z","dependencies_parsed_at":"2022-09-05T19:20:18.835Z","dependency_job_id":null,"html_url":"https://github.com/levp/sqrup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/levp/sqrup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levp%2Fsqrup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levp%2Fsqrup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levp%2Fsqrup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levp%2Fsqrup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/levp","download_url":"https://codeload.github.com/levp/sqrup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levp%2Fsqrup/sbom","scorecard":{"id":586322,"data":{"date":"2025-08-11","repo":{"name":"github.com/levp/sqrup","commit":"e5f4efaa09f97556f187f90bdebeb8a19ef8d164"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"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":"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/27 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":"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":"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":"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":"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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"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"}}]},"last_synced_at":"2025-08-20T20:36:33.869Z","repository_id":57368409,"created_at":"2025-08-20T20:36:33.869Z","updated_at":"2025-08-20T20:36:33.869Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32292876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T08:29:33.829Z","status":"ssl_error","status_checked_at":"2026-04-26T08:29:18.366Z","response_time":129,"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":[],"created_at":"2024-11-18T22:31:27.765Z","updated_at":"2026-04-26T09:32:35.297Z","avatar_url":"https://github.com/levp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://i.imgur.com/MvMTdgF.png)\n\n# sqrup\n\nSurround text with a rectangle and draw attention to it.\n\n```js\nconst sqrup = require('sqrup');\n\nconst result = sqrup('Hello,\\nworld!');\n\nconsole.log(result);\n```\n\nOutput:\n```\n************\n*  Hello,  *\n*  world!  *\n************\n```\n\n## Install\n\n`npm i sqrup`\n\n\n## API\n\nFunction signature:\n```js\nfunction sqrup(text, options)\n````\n\nWith TypeScript types:\n```typescript\nfunction sqrup(text: string | string[], options: string | sqrup.SquareUpOptions): string\n```\n\n```typescript\ntype SquareUpOptions = {\n  default?: string;\n  // Sides\n  left?: string;\n  right?: string;\n  top?: string;\n  bottom?: string;\n  // Corners\n  topLeft?: string;\n  topRight?: string;\n  bottomLeft?: string;\n  bottomRight?: string;\n  // Pad\n  padLeft?: number;\n  padRight?: number;\n  padBottom?: number;\n  padTop?: number;\n}\n```\n\nOr you can just take a look at the included `index.d.ts` file.\n\n## Examples\n\n### 1. Use custom character\n(Instead of the default asterisk `*`)\n\n```js\nsqrup('One,\\nTwo,\\nThree.', 'x');\n```\n```\nxxxxxxxxxxxx\nx  One,    x\nx  Two,    x\nx  Three.  x\nxxxxxxxxxxxx\n```\n\n### 2. Control the padding between the text and the square\n```js\nsqrup('WELCOME\\n HOME', {\n                   // defaults:\n    default: 'o',  // '*'\n    padLeft: 8,    // 2\n    padRight: 8,   // 2\n    padTop: 2,     // 0\n    padBottom: 2,  // 0\n});\n```\n```\nooooooooooooooooooooooooo\no                       o\no                       o\no        WELCOME        o\no         HOME          o\no                       o\no                       o\nooooooooooooooooooooooooo\n```\n\n### 3. Fine grained customization\n\n```js\nsqrup('Look Ma,\\n I\\'m in a box!', {\n  // default:  ...,\n  // The `default` option does nothing in this specific scenario\n  // since all of the edge charactrers are specified individually\n  // in the options at the bottom.\n\n  // Pad\n  padLeft: 8,\n  padRight: 2,\n  padBottom: 0,\n  padTop: 2,\n\n  // All of the following options use the character specifeid\n  // in the `defeault` if not given any value:\n\n  // Sides\n  left: '▶',\n  right: '◀',\n  top: '▼',\n  bottom: '▲',\n  // Corners\n  topLeft: '◢',\n  topRight: '◣',\n  bottomLeft: '◥',\n  bottomRight: '◤',\n});\n```\n\n```\n◢▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼◣\n▶                        ◀\n▶                        ◀\n▶        Look Ma,        ◀\n▶         I'm in a box!  ◀\n◥▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲◤\n```\n\n## Defaults\n\n```typescript\ntype SquareUpOptions = {\n  default?: string;      // '*'\n\n  // Pad\n  padLeft?: number;      // 2\n  padRight?: number;     // 2\n  padBottom?: number;    // 0\n  padTop?: number;       // 0\n\n  // The following 8 options will all use the value of the `default`\n  // option if they are not explicitly specified.\n\n  // Sides\n  left?: string;         // use `default`\n  right?: string;        // use `default`\n  top?: string;          // use `default`\n  bottom?: string;       // use `default`\n  // Corners\n  topLeft?: string;      // use `default`\n  topRight?: string;     // use `default`\n  bottomLeft?: string;   // use `default`\n  bottomRight?: string;  // use `default`\n}\n```\n\n## Extra - How to produce the image at the top\n\n```js\nsqrup('\\u001b[32msqrup\\u001b[39m', {\n  default: '\\u001b[33m*\\u001b[39m',\n  // Sides\n  left: '\\u001b[33m⁑\\u001b[39m',\n  right: '\\u001b[33m⁑\\u001b[39m',\n  // Pad\n  padLeft: 6,\n  padRight: 6,\n  padBottom: 2,\n  padTop: 2,\n});\n```\n\n![](https://i.imgur.com/MvMTdgF.png)\n\n## License\n\n[ISC](https://opensource.org/licenses/ISC)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevp%2Fsqrup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flevp%2Fsqrup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevp%2Fsqrup/lists"}