{"id":21887315,"url":"https://github.com/borracciablu/banner-cli","last_synced_at":"2025-04-15T09:50:31.211Z","repository":{"id":36586783,"uuid":"471213103","full_name":"borracciaBlu/banner-cli","owner":"borracciaBlu","description":"CLI tool to add a banner comment to your files.","archived":false,"fork":false,"pushed_at":"2024-09-24T12:10:45.000Z","size":780,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T19:44:26.705Z","etag":null,"topics":["banner","cli","comments","npm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cjpatoilo/banner-cli","license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/borracciaBlu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-18T02:40:00.000Z","updated_at":"2025-02-26T18:40:58.000Z","dependencies_parsed_at":"2024-03-29T23:27:12.087Z","dependency_job_id":"6af18e57-5bfb-46ff-8276-5534bd32ab49","html_url":"https://github.com/borracciaBlu/banner-cli","commit_stats":{"total_commits":130,"total_committers":1,"mean_commits":130.0,"dds":0.0,"last_synced_commit":"930648b69bcd4d1c5595fffdfcba2edad7d7e2bb"},"previous_names":[],"tags_count":83,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borracciaBlu%2Fbanner-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borracciaBlu%2Fbanner-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borracciaBlu%2Fbanner-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borracciaBlu%2Fbanner-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/borracciaBlu","download_url":"https://codeload.github.com/borracciaBlu/banner-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048713,"owners_count":21204305,"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":["banner","cli","comments","npm"],"created_at":"2024-11-28T11:09:17.872Z","updated_at":"2025-04-15T09:50:31.194Z","avatar_url":"https://github.com/borracciaBlu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/borracciaBlu/banner-cli/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/borracciaBlu/banner-cli/assets/2061731/fafb01f3-aec4-45d8-b316-73b9294c3aeb\" width=\"114px\" height=\"55px\" alt=\"banner-cli\" /\u003e\n  \u003c/a\u003e\n\n  \u003cbr\u003e\n  \u003cspan align=\"center\"\u003e\n    CLI tool to add a comment banner to your files.\n  \u003c/span\u003e\n\u003c/p\u003e\n\n\n\n\n\u003cp dir=\"auto\"  align=\"center\"\u003e\n    \u003ca href=\"https://badge.fury.io/js/%40borracciablu%2Fbanner-cli\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40borracciablu%2Fbanner-cli.svg\" alt=\"npm version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://coveralls.io/github/borracciaBlu/banner-cli?branch=main\"\u003e\u003cimg src=\"https://coveralls.io/repos/github/borracciaBlu/banner-cli/badge.svg?branch=main\" alt=\"Coverage Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/borracciaBlu/banner-cli/actions?query=workflow%3Abuild-test\"\u003e\u003cimg src=\"https://github.com/borracciaBlu/banner-cli/workflows/build-test/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/borracciaBlu/banner-cli/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n```\n\n    /*! \n     * [name] v[tag]\n     * [homepage]\n     *\n     * Copyright (c) [year] [author]\n     * [license]\n     */\n\n\n```\n\nBy default it will use the values in `package.json`.  \nAll values are overridable.  \n\nIf you are evaluating the use of banners please read:\n- [Versioning, banners and why you may consider using it](https://adropincalm.com/blog/versioning-and-banners/)\n\n## Installing\n\n`npm install @borracciablu/banner-cli`\n\n\n## API Reference\n\n```\nUsage: banner-cli [options] [source]\n\nCLI tool to add a banner comment to your files.\n\nArguments:\n  source                   Files to bannerize\n\nOptions:\n  -V, --version            output the version number\n  -n, --name \u003cname\u003e        override project name\n  -t, --tag \u003ctag\u003e          override tag version\n  -s, --site \u003csite\u003e        override homepage\n  -a, --author \u003cauthor\u003e    override author\n  -y, --year \u003cyear\u003e        override year\n  --template \u003ctemplate\u003e    override template\n  -l, --license \u003clicense\u003e  override license\n  -d, --debug              debug options and args\n  --dry-run                test the command, simulate without actually doing it\n  -h, --help               display help for command\n```\n\n### Template feature\n\nThe `--template` option allows you to inject tags.  \n\n**The avalable tags are:**\n\n```\n\u003cbr\u003e      := new line. Like using \\n. \n[name]    := project name\n[tag]     := project tag version\n[site]    := project homepage\n[author]  := project author\n[year]    := copyright year\n[license] := license\n[time]    := unix timestamp in seconds\n```\n\n### Examples\n**Basic:**\n\n```\n# add banner to each js file\n$ banner-cli 'dist/**/*.js'\n\n# add banner to each css file\n# override author, license, site\n$ banner-cli 'dist/**/*.css' --author 'Mr Developer' --license MIT --site https://project.js.org\n\n# use template \n$ banner-cli 'dist/**/*.css' --template '/*! v[tag] :: [time] */'\n```\n\n**Advanced:**\n\n```\n// in package.json \n// inject next tag \n{\n    \"scripts\" : {\n        \"banner:patch\": \"NEXT_TAG=$(semver $npm_package_version -i patch) banner-cli 'dist/*.js' --template='/*! v[tag] :: [time] */' --tag=$NEXT_TAG\"\n    }\n}\n\n```\n\n## Notes \nThis package is highly inspired by [banner-cli](https://www.npmjs.com/package/banner-cli) and is currently a superset.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborracciablu%2Fbanner-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborracciablu%2Fbanner-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborracciablu%2Fbanner-cli/lists"}