{"id":20996527,"url":"https://github.com/ymotongpoo/vsc-licenser","last_synced_at":"2025-04-06T06:14:12.803Z","repository":{"id":7102834,"uuid":"56170606","full_name":"ymotongpoo/vsc-licenser","owner":"ymotongpoo","description":"License handler extension for Visual Studio Code.","archived":false,"fork":false,"pushed_at":"2025-03-28T22:19:26.000Z","size":713,"stargazers_count":46,"open_issues_count":17,"forks_count":39,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-03-30T04:09:55.143Z","etag":null,"topics":["license","typescript","vscode-extension"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ymotongpoo.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":"2016-04-13T17:03:32.000Z","updated_at":"2025-01-09T06:18:27.000Z","dependencies_parsed_at":"2025-02-24T04:10:40.138Z","dependency_job_id":"7133c18d-0aee-44f8-b1ef-348e3d4ddb7d","html_url":"https://github.com/ymotongpoo/vsc-licenser","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ymotongpoo%2Fvsc-licenser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ymotongpoo%2Fvsc-licenser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ymotongpoo%2Fvsc-licenser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ymotongpoo%2Fvsc-licenser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ymotongpoo","download_url":"https://codeload.github.com/ymotongpoo/vsc-licenser/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441062,"owners_count":20939239,"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":["license","typescript","vscode-extension"],"created_at":"2024-11-19T07:35:57.893Z","updated_at":"2025-04-06T06:14:12.767Z","avatar_url":"https://github.com/ymotongpoo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Licenser\n\nAn extension for adding license headers and LICENSE files into your workspace.\nYou can find this extension on [Marketplace for VS Code](https://marketplace.visualstudio.com/items?itemName=ymotongpoo.licenser).\n\n## Install\n\nLaunch VS Code, go to the *Quick Open* menu (`Ctrl+P` on Windows/Linux, `⌘P` on macOS), and type:\n\n```\next install licenser\n```\n\n## Commands and features\n\nThis extension provides shortcuts to insert license headers to source code files and\nto create a LICENSE file based on the configurations in `settings.json`. This extension\nnot only provides shortcuts but also enables auto-insertion of license header on creation\nof new file.\n\nYou can call these commands via *Command Palette* (`Ctrl+Shift+P` on Windows/Linux, `⌘⇧P` on OS X):\n\n* \"licenser: Create LICENSE file\"\n  * create LICENSE file in your repository.\n* \"licenser: Insert license header\"\n  * insert license header into the currently opened source code file.\n* \"licenser: Arbitrary license header\"\n  * insert arbitrary license header into the currently opened source code file.\n* \"licenser: Insert license headers to contents\"\n  * insert license header into multiple files under specific directory.\n\nProgramming languages supported by this extension are (alphabetical order):\n\n* bat\n* C\n* Clojure\n* CMake\n* C++\n* C#\n* CSS\n* D\n* Dart\n* Dockerfile\n* Elixir\n* Erlang\n* F#\n* GN\n* Go\n* Groovy\n* Haskell\n* HTML\n* ini\n* Java\n* JavaScript\n* Julia\n* JSX (JavaScript, TypeScript support)\n* LaTeX\n* LISP (CommonLisp, Scheme)\n* Lua\n* Makefile\n* Markdown\n* Nim (and Nimble)\n* Objective-C\n* OCaml\n* Pascal\n* Perl\n* PHP\n* Plain text\n* PowerShell\n* Python\n* Ruby\n* Rust\n* TypeScript\n* SCSS (Sass)\n* ShellScript\n* SQL\n* Starlark\n* Swift\n* XML\n* YAML\n\nThe following programing languages/frameworks are supported in the manual configurations of this extension (see `contributes.languages` in `package.json`):\n\n* ADVPL\n* Crystal\n* D\n* Dart\n* Elixir\n* Erlang\n* GN\n* Haskell\n* Julia\n* LaTeX\n* LISP (CommonLisp, Scheme)\n* Nim (and Nimble)\n* OCaml\n* Pascal\n* PureScript\n* Starlark (used in Bazel)\n* Svelte\n* Vue\n\n## Configurations\n\n### licenser.license\n\n```\n\"licenser.license\": \"AL2\"\n```\n\nThis setting defines the license used by the project.\n\nCurrently, supported licenses are:\n\n* \"AGPLv3\": GNU Affero General Public License version 3\n* \"AL2\": Apache License version 2\n* \"BSD2\": BSD 2-clause License\n* \"BSD3\": BSD 3-clause License (New BSD License)\n* \"BSL1\": Boost Software License - Version 1.0\n* \"BUSL-1.1\": Business Source License 1.1\n* \"EUPL-1.2\": European Union Public License version 1.2\n* \"GPLv2\": GNU General Public License version 2\n* \"GPLv3\": GNU General Public License version 3\n* \"LGPLv3\": GNU Lesser General Public License version 3\n* \"MIT\": MIT License\n* \"MPLv2\": Mozilla Public License version 2\n* \"CC-BY-3\": Creative Commons Attribution 3.0\n* \"CC-BY-SA-3\": Creative Commons Attribution-ShareAlike 3.0\n* \"CC-BY-NC-3\": Creative Commons Attribution-NonCommercial 3.0\n* \"CC-BY-ND-3\": Creative Commons Attribution-NoDerivs 3.0\n* \"CC-BY-NC-SA-3\": Creative Commons Attribution-NonCommercial-ShareAlike 3.0\n* \"CC-BY-NC-ND-3\": Creative Commons Attribution-NonCommercial-NoDerivs 3.0\n* \"CC-BY-4\": Creative Commons Attribution 4.0\n* \"CC-BY-SA-4\": Creative Commons Attribution-ShareAlike 4.0\n* \"CC-BY-NC-4\": Creative Commons Attribution-NonCommercial 4.0\n* \"CC-BY-ND-4\": Creative Commons Attribution-NoDerivs 4.0\n* \"CC-BY-NC-SA-4\": Creative Commons Attribution-NonCommercial-ShareAlike 4.0\n* \"CC-BY-NC-ND-4\": Creative Commons Attribution-NonCommercial-NoDerivs 4.0\n* \"CC0-1\": CC0 1.0\n* \"UNL\": The Unlicense\n* \"WTFPL\": Do What The Fuck You Want To Public License\n* \"zlib\": zlib License\n* \"Custom\": User-defined (see `licenser.custom*` settings below)\n\n### licenser.author\n\n```\n\"licenser.author\": \"Yoshi Yamaguchi\"\n```\n\nThis setting defines the author name that would be inserted into the\nlicense header template.\n\n### licenser.projectName\n\n```\n\"licenser.projectName\": \"Awesome project\"\n```\n\n**This setting should be in Workspace settings.** This setting defines the project name you are working on.\nThis setting is only used in the template for GPLv2 and GPLv3. Default value would be\nyour workspace root directory name. Be aware that this setting should be in Workspace setting,\nnot in User setting, since User setting affects all workspaces which are not relevant to this project name.\n\n### licenser.useSingleLineStyle\n\n```\n\"licenser.useSingleLineStyle\": true\n```\n\nThis setting defines your preference of comment style. If this setting is set as `true`,\nlicenser uses single line comment style for license header in case that the language has\nsingle line comment style. If it is set as `true` but the language doesn't have single line comment style,\nmulti line comment will be applied.\n\n### licenser.customTermsAndConditions\n\n```\n\"licenser.customTermsAndConditions\": \"Copyright @YEAR@ @AUTHOR@\\n\\nThese are my terms and conditions...\"\n```\n\nThis setting defines the text used to create the `LICENSE` file when the \"Custom\" license type is selected.\n\nThe following placeholders can be used:\n\n* `@AUTHOR@`: Replaced with `licenser.author`\n* `@FILE@`: Replaced with the current file name (only useful for custom header).\n* `@PROJECT@`: Replaced with `licenser.projectName`\n* `@YEAR@`: Replaced with the current year\n\n**Note:** Newlines are not allowed in settings strings, so you must use `\\n` instead.\nOther characters, such as double-quotes, may need to be escaped as well.\nConsider using a regex replace to convert an existing multi-line file to a single line.\n\n### licenser.customTermsAndConditionsFile\n\n```\n\"licenser.customTermsAndConditionsFile\": \"path/to/terms.txt\"\n```\n\nThis setting defines the path to a file that contains the text for the custom terms and conditions.\nThis will override `licenser.customTermsAndConditions` if present.\n\nPlaceholders are the same as `licenser.customTermsAndConditions`.\n\n### licenser.customHeader\n\n```\n\"licenser.customHeader\": \"@FILE@ - @PROJECT@\\n\\nCopyright @YEAR@ @AUTHOR@\\n\\nThis is my license...\"\n```\n\nThis setting defines the text used to create the license header file when the \"Custom\" license type is selected.\n\nPlaceholders and escaping requirements are the same as `licenser.customTermsAndConditions`.\n\n### licenser.customHeaderFile\n\n```\n\"licenser.customHeaderFile\": \"path/to/header.txt\"\n```\n\nThis setting defines the path to a file that contains the text for the custom header.\nThis will override `licenser.customHeader` if present.\n\nPlaceholders are the same as `licenser.customTermsAndConditions`.\n\n### licenser.disableAutoHeaderInsertion\n\n```\n\"licenser.disableAutoHeaderInsertion\": false\n```\n\nThis setting defines the behavior of header auto-insertion.\nIf this setting is set as `true`, licenser will disable auto-insertion of license header on creation of new file.\n\n### licenser.excludeFileExtensions\n\n```\n\"licenser.excludeFileExtensions\": [\"txt\", \"c\"]\n```\n\nThis setting will exclude files with a matching extension in their name from having a license header auto inserted. There is no limit in the amount of entries this array can have. This setting is case insensitive.\n\n## Call to action\n\n### Report issues\n\nFinally the author bought Windows 10 machine, and he can test the app by himself!\nFor bug reporting, please create a ticket on [GitHub repository](https://github.com/ymotongpoo/vsc-licenser/issues).\n\n### Pull requests\n\nThis repository is mainly developed under 'develop' branch, so please make pull requests there, not to 'master' branch.\n\n## Changelogs\n\nSee all changes in [CHANGELOG](https://github.com/ymotongpoo/vsc-licenser/blob/master/CHANGELOG.md).\n\n## Contributors\n\nSee `CONTRIBUTORS` file for all contributors so far. Thank you for your contributions!\n\n## Reference\n\n* [All CC 3.0 Legal Codes](https://creativecommons.org/2011/04/15/plaintext-versions-of-creative-commons-licenses-and-cc0/)\n* [All CC 4.0 Legal Codes](https://creativecommons.org/2014/01/07/plaintext-versions-of-creative-commons-4-0-licenses/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fymotongpoo%2Fvsc-licenser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fymotongpoo%2Fvsc-licenser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fymotongpoo%2Fvsc-licenser/lists"}