{"id":15254650,"url":"https://github.com/trim21/userscript-metadata-generator","last_synced_at":"2025-10-23T17:29:13.014Z","repository":{"id":61832771,"uuid":"555549707","full_name":"trim21/userscript-metadata-generator","owner":"trim21","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-02T17:15:01.000Z","size":8428,"stargazers_count":8,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T18:26:25.028Z","etag":null,"topics":["metadata","userscript"],"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/trim21.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-21T20:06:44.000Z","updated_at":"2025-04-02T17:15:03.000Z","dependencies_parsed_at":"2023-02-10T22:00:39.359Z","dependency_job_id":"0da24016-bc0a-4859-a2ae-866c44d3c7e3","html_url":"https://github.com/trim21/userscript-metadata-generator","commit_stats":{"total_commits":47,"total_committers":2,"mean_commits":23.5,"dds":"0.21276595744680848","last_synced_commit":"d32ef34c116980f3c64f9986eea5f436205f677a"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trim21%2Fuserscript-metadata-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trim21%2Fuserscript-metadata-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trim21%2Fuserscript-metadata-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trim21%2Fuserscript-metadata-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trim21","download_url":"https://codeload.github.com/trim21/userscript-metadata-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487694,"owners_count":21112190,"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":["metadata","userscript"],"created_at":"2024-09-29T23:05:25.186Z","updated_at":"2025-10-23T17:29:12.930Z","avatar_url":"https://github.com/trim21.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# userscript-metadata-generator\n\n`userscript-metadata-generator` is a package to generate UserScript metadata comments string.\n\nrequire:\n\n- nodejs \u003e= 16\n\n## install\n\n```bash\nnpm i userscript-metadata-generator -D\n```\n\n## Usage\n\n```typescript\n// or you can use import, esm is also suppotted\nimport { userscriptMetadataGenerator, Metadata } from 'userscript-metadata-generator';\n// or\n// const { userscriptMetadataGenerator } = require('userscript-metadata-generator');\n\nconst metadata: Metadata = {\n  name: {\n    $: 'A test',\n    de: 'Ein Test',\n  },\n  noframes: '',\n  version: '0.1.2',\n  author: {\n    name: 'trim21',\n    email: 'trim21.me@gmail.com',\n  },\n  'run-at': 'document-end',\n  resource: {\n    icon1: 'https://www.tampermonkey.net/favicon.ico',\n    icon2: '/images/icon.png',\n    html: 'https://www.tampermonkey.net/index.html',\n    xml: 'https://www.tampermonkey.net/crx/tampermonkey.xml',\n    SRIsecured1: 'https://www.tampermonkey.net/favicon.ico#md5=123434...',\n    SRIsecured2: 'https://www.tampermonkey.net/favicon.ico#md5=123434...;sha256=234234...',\n  },\n  include: ['https://www.tampermonkey.net/*', 'https://*', 'https://*', '/^https://www.tampermonkey.net/.*$/'],\n};\n\nconsole.log(userscriptMetadataGenerator(metadata));\n```\n\nand you will get output like this:\n\n```js\n// ==UserScript==\n// @name       A test\n// @name:de    Ein Test\n// @noframes\n// @version    0.1.2\n// @author     trim21 \u003ctrim21.me@gmail.com\u003e\n// @run-at     document-end\n// @resource   icon1       https://www.tampermonkey.net/favicon.ico\n// @resource   icon2       /images/icon.png\n// @resource   html        https://www.tampermonkey.net/index.html\n// @resource   xml         https://www.tampermonkey.net/crx/tampermonkey.xml\n// @resource   SRIsecured1 https://www.tampermonkey.net/favicon.ico#md5=123434...\n// @resource   SRIsecured2 https://www.tampermonkey.net/favicon.ico#md5=123434...;sha256=234234...\n// @include    https://www.tampermonkey.net/*\n// @include    https://*\n// @include    https://*\n// @include    /^https://www.tampermonkey.net/.*$/\n// ==/UserScript==\n```\n\n## With bundle\n\n### webpack\n\nhttps://github.com/trim21/userscript-metadata-webpack-plugin\n\n### esbuild\n\n[example/esbuild.cjs](https://github.com/trim21/userscript-metadata-generator/blob/master/example/esbuild.cjs)\n\n## rollup\n\n[example/rollup.config.js](https://github.com/trim21/userscript-metadata-generator/blob/master/example/rollup.config.js)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrim21%2Fuserscript-metadata-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrim21%2Fuserscript-metadata-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrim21%2Fuserscript-metadata-generator/lists"}