{"id":19853007,"url":"https://github.com/ship-components/ship-components-banner","last_synced_at":"2025-02-28T21:18:45.851Z","repository":{"id":57317646,"uuid":"40464061","full_name":"ship-components/ship-components-banner","owner":"ship-components","description":null,"archived":false,"fork":false,"pushed_at":"2018-10-23T19:00:21.000Z","size":130,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2024-04-24T08:27:31.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ship-components.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":"2015-08-10T05:03:33.000Z","updated_at":"2018-10-23T18:58:49.000Z","dependencies_parsed_at":"2022-08-25T21:12:02.640Z","dependency_job_id":null,"html_url":"https://github.com/ship-components/ship-components-banner","commit_stats":null,"previous_names":["isuttell/package-banner"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-banner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-banner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-banner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-banner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ship-components","download_url":"https://codeload.github.com/ship-components/ship-components-banner/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241241886,"owners_count":19932836,"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":[],"created_at":"2024-11-12T14:05:10.645Z","updated_at":"2025-02-28T21:18:45.827Z","avatar_url":"https://github.com/ship-components.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ship-components-banner\n\n[![npm version](https://img.shields.io/npm/v/ship-components-banner.svg?style=flat)](https://www.npmjs.com/package/ship-components-banner)\n[![dependencies](https://img.shields.io/david/ship-components/ship-components-banner.svg?style=flat)](https://david-dm.org/ship-components/ship-components-banner)\n\nGenerates a banner from a package.json file.\n\n## Install\n\n```shell\nnpm install ship-components-banner --save-dev\n```\n\n## Usage\n\n```js\nvar ShipComponentsBanner = require('ship-components-banner');\n\n// Basic Usage\nvar banner = new ShipComponentsBanner().build();\n\nconsole.log(banner);\n\n/*!\n * ___.\n * \\_ |__ _____    ____   ____   ___________\n *  | __ \\\\__  \\  /    \\ /    \\_/ __ \\_  __ \\\n *  | \\_\\ \\/ __ \\|   |  \\   |  \\  ___/|  | \\/\n *  |___  (____  /___|  /___|  /\\___  \u003e__|\n *      \\/     \\/     \\/     \\/     \\/\n * ship-components-banner X.X.X\n * Description: Generates a fancy banner from a package.json file\n * Author: Isaac Suttell \u003cisaac.suttell@sony.com\u003e\n * License: MIT\n */\n\n```\n\n## Options\n\n```js\nvar ShipComponentsBanner = require('ship-components-banner');\n\nvar banner = new ShipComponentsBanner({\n  /**\n   * Either takes a path or an object. It defaults to the package.json in your process.cwd()\n   * @type    {String|Object}\n   */\n  pkg: 'package.json',\n\n  /**\n   * ASCII Font to use. See below for more options.\n   * @type    {String}\n   */\n  font: 'Graffiti',\n\n  /**\n   * Should an ascii art title be generated?\n   * @type    {Boolean}\n   */\n  fancy: true,\n\n  /**\n   * Default line ending us UNIX\n   * @type    {String}\n   */\n  lineEnding: '\\n',\n\n  /**\n   * Wrap everything in a comment or just create the text\n   * @type    {Boolean}\n   */\n  wrap: true,\n\n  /**\n   * Add a line break at the end\n   * @type    {Boolean}\n   */\n  lastLineBreak: true,\n\n  /**\n   * Add a timestamp which can be useful for automated build systems\n   * @type    {Boolean}\n   */\n  timestamp: false,\n\n  /**\n   * An array of keys to include in order\n   * @type    {Array}\n   */\n  keys: ['name', 'description', 'author', 'homepage', 'bugs', 'license'],\n\n}).build();\n\n```\n\n## Fonts\n\nYou can get a list of fonts with a preview of each by running:\n\n```shell\n$ npm run fonts\n```\n\nFrom the command line of your project.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 SHIP\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fship-components%2Fship-components-banner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fship-components%2Fship-components-banner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fship-components%2Fship-components-banner/lists"}