{"id":16295253,"url":"https://github.com/seia-soto/userscript-boilderplate","last_synced_at":"2026-05-09T15:05:41.268Z","repository":{"id":37038461,"uuid":"504817606","full_name":"seia-soto/userscript-boilderplate","owner":"seia-soto","description":"My own userscript boilerplate.","archived":false,"fork":false,"pushed_at":"2022-06-18T13:43:40.000Z","size":36,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T07:19:45.622Z","etag":null,"topics":["boilerplate","typescript","userscript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seia-soto.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}},"created_at":"2022-06-18T10:55:13.000Z","updated_at":"2024-06-14T02:31:04.000Z","dependencies_parsed_at":"2022-06-25T09:43:47.295Z","dependency_job_id":null,"html_url":"https://github.com/seia-soto/userscript-boilderplate","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seia-soto%2Fuserscript-boilderplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seia-soto%2Fuserscript-boilderplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seia-soto%2Fuserscript-boilderplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seia-soto%2Fuserscript-boilderplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seia-soto","download_url":"https://codeload.github.com/seia-soto/userscript-boilderplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045266,"owners_count":21038555,"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":["boilerplate","typescript","userscript"],"created_at":"2024-10-10T20:18:11.955Z","updated_at":"2026-05-09T15:05:36.225Z","avatar_url":"https://github.com/seia-soto.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# userscript-boilerplate\n\nHi, there!\nI'm happy to expose my userscript boilerplate to you who'll distribute this to worldwide.\n\n## table of contents\n\n- [install](#install)\n- [features](#features)\n- [development](#development)\n\n---\n\n# install\n\nTo install this userscript, please use the following link:\n\n```\nhttps://github.com/seia-soto/lorem-ipsum/raw/master/dist/bundle.user.js\n```\n\nIf you want to verify the script content, you can download the MD5 hash of the script from the following link:\n\n```\nhttps://github.com/seia-soto/lorem-ipsum/raw/master/dist/checksum\n```\n\n# features\n\n- dev\n  - watches file changes\n  - deploys via local http server\n  - generates local checksum\n- ci\n  - detects if development resources exists\n  - verifies sent checksum\n\n# development\n\nIf you're interested in, please setup Node.JS v16 or higher for development environment.\nThat's all!\n\n## recommended environment\n\n\u003e All things are optional!\n\u003e Only you need is Node.JS on your system.\n\nI suggest you a better environment to enhance your productivity:\n\n- pnpm, install via `npm i -g pnpm`\n\n## scripts\n\nI prepared some scripts to help your development.\n\n### `build`\n\nIf you want to build the script for production, you can use `pnpm build`\n\nThis'll\n  1) build files\n  2) generate checksum\n\n### `dev`\n\nIf you want to test out your script, you can use `pnpm dev`.\n\nThis'll\n  1) watch changes and build it automatically\n  2) create new http server on port `9090`\n  3) use alternative file paths\n\nIf you set `DEBUG=1` or use `dev` command, you'll get different paths for output files.\nRefer the `scripts/build.js`, or:\n\n\u003e Note that all ins are optional!\n\n- ins\n  - `dist/header.js` -\u003e `dist/header.dev.js`\n\n- outs\n  - `dist/bundle.js` -\u003e `dist/bundle.dev.js`\n  - `dist/bundle.user.js` -\u003e `dist/bundle.user.dev.js`\n  - `dist/checksum` -\u003e `dist/checksum.dev`\n\n### `test`\n\nIf you want to verify the generated checksum, you can use `pnpm test`.\nIn local environment, `CI=1` is *not* specified to avoid detecting development resources.\n\nIf you're going to use different ci instead of GitHub Actions (preset), please use `CI=1 npm run test` to include all tests ready for ci.\n\n## cycle\n\nHere's the development cycle for faster in-memory opt-in of your brain.\n\n1. run `pnpm i` to install deps.\n2. run `pnpm dev` to launch local http server on port `9090`.\n3. open browser and find for `bundle.dev.user.js` or `http://localhost:9090/bundle.dev.user.js` to install on your userscript manager.\n4. give some changes under `src` folder.\n5. run `pnpm build` before commit.\n\n### upgrading the version of script\n\nReady to publish a new version?\nHere's the list of files you'll need to change:\n\n- `package.json`, update `version`\n- `dist/header.js`, update `@version`\n\n### upgrading node version\n\nIf you interested in upgrading the Node.JS version, please make sure you're using LTS release first.\nHere's the list of files you'll need to change:\n\n- `.nvmrc`, update codename of new release\n- `package.json`, update `engines.node`\n- `.github/workflows`, update `jobs.post-check.steps[1].with.node-version`\n\nThat's all!\n\n### changing folder names\n\nIf you don't like `src` and `dist` for folder names, you can easily change it.\nHere's the list of files you'll need to change:\n\n- `scripts/build.js`, update `sourceRoot` and `sourceDist` variable\n- Move some files under `src` and `dist`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseia-soto%2Fuserscript-boilderplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseia-soto%2Fuserscript-boilderplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseia-soto%2Fuserscript-boilderplate/lists"}