{"id":49583482,"url":"https://github.com/fratercula/pavane","last_synced_at":"2026-05-03T21:35:40.184Z","repository":{"id":57320927,"uuid":"141809632","full_name":"fratercula/pavane","owner":"fratercula","description":"LiveReload Server","archived":false,"fork":false,"pushed_at":"2019-04-03T13:52:05.000Z","size":117,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-03T21:35:26.880Z","etag":null,"topics":["cli","livereload","server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fratercula.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":"2018-07-21T12:23:12.000Z","updated_at":"2019-04-25T07:23:04.000Z","dependencies_parsed_at":"2022-08-25T21:00:50.551Z","dependency_job_id":null,"html_url":"https://github.com/fratercula/pavane","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fratercula/pavane","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fratercula%2Fpavane","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fratercula%2Fpavane/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fratercula%2Fpavane/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fratercula%2Fpavane/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fratercula","download_url":"https://codeload.github.com/fratercula/pavane/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fratercula%2Fpavane/sbom","scorecard":{"id":409984,"data":{"date":"2025-08-11","repo":{"name":"github.com/fratercula/pavane","commit":"e43c801416315783f17ac7f67210664361e7520c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/15 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 16 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T22:26:02.993Z","repository_id":57320927,"created_at":"2025-08-18T22:26:02.993Z","updated_at":"2025-08-18T22:26:02.993Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32586187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cli","livereload","server"],"created_at":"2026-05-03T21:35:39.051Z","updated_at":"2026-05-03T21:35:40.177Z","avatar_url":"https://github.com/fratercula.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pavane\n\n[![Build Status](https://travis-ci.org/fratercula/pavane.svg?branch=master)](https://travis-ci.org/fratercula/pavane)\n[![codecov](https://codecov.io/gh/fratercula/pavane/branch/master/graph/badge.svg)](https://codecov.io/gh/fratercula/pavane)\n\nLiveReload Server\n\n[中文文档](README.zh-CN.md)\n\n## Install\n\n```bash\n$ npm i pavane -D\n\n# CLI\n$ npm i pavane -g\n```\n\n## Usage\n\nserver\n\n```js\nconst { join, extname } = require('path')\nconst Pavane = require('pavane')\n\n/*\n  watch path\n  file, dir, glob, or array\n  default: process.cwd()\n*/\nconst watches = join(process.cwd(), 'src')\n\n/*\n  server static files path\n  default: process.cwd()\n*/\nconst publics = __dirname\n\nconst server = new Pavane(watches, publics)\n\n// add subscribe\nserver.subscribe = (args) =\u003e {\n  const {\n    event,        // watch files change event\n    path,         // changed file path\n    port,         // server port\n    clients,      // current clients number\n    status,       // server status, `stop`, `start`, `running`\n    trigger,      // trigger clients reload `css` or `page`\n  } = args\n  const { log } = global.console\n\n  if (status === 'start') {\n    log(`Server running: http://127.0.0.1:${port}\\n  CTRL + C to shutdown`)\n    return\n  }\n\n  if (status === 'running') {\n    log('Server is already running...')\n    return\n  }\n\n  if (event) {\n    if (...) {\n      trigger('custom message') // custom\n      return\n    }\n\n    if (extname(path) === '.css') {\n      trigger('css') // reload style\n    } else {\n      trigger('page') // reload page\n    }\n    log(`${event}: ${path}`)\n    return\n  }\n\n  log(`clients: ${clients}`) // current clients number\n}\n\nserver.start(2222) // default 2333\n\nserver.close() // close server\n```\n\nclient\n\n```js\n// by default, browser subscribes for server socket messafes and automatically refreshes `style` or `page`\n// but you can custom subscribes\n// set scripts after `\u003chead\u003e\u003c/head\u003e` tag\n\nwindow.__PAVANE__.subscribe = (data) =\u003e {\n  console.log(data) // server socket message\n  // do other things\n}\n```\n\n## CLI\n\n**default**\n\n```bash\n$ pavane\n\n# or\n$ pv\n```\n\n**server port**\n\n```bash\n$ pavane -p 2000\n\n# or\n$ pv -p 2222\n```\n\n**custom path**\n\n```bash\n# watch `src`, and set `dist` server path\n$ pavane -w src -s dist\n\n# or\n$ pv -w src -s dist\n```\n\n**use config**\n\nsetup `pavane.config.js`\n\n```js\nconst { extname } = require('path')\n\nmodule.exports = {\n  watches: ['*.js', '*.css', '*.html', '**/*.html'],\n  publics: __dirname,\n  port: 2222, // server port\n  subscribe(args) {\n    // ...\n  },\n}\n```\n\nstart width config\n\n```bash\n# start width config\n$ pavane -c\n\n# or\n$ pv -c\n```\n\n## Use on other server\n\nif your web application run on other server (python server, php server ...), add this `script` in main template\n\n```html\n\u003c!-- if the server port is 2333 --\u003e\n\u003cscript src=\"http://127.0.0.1:2333/_.js\"\u003e\u003c/script\u003e\n```\n\n## Development\n\n```bash\n# server\n$ npm start\n\n# lint\n$ npm run test:lint\n\n# unit test\n$ npm run test:unit\n\n# coverage test\n$ npm run test:unit\n\n# cli\n# port\n$ cd test \u0026\u0026 node ../bin/index.js -p 2000\n\n# config\n$ cd test \u0026\u0026 node ../bin/index.js -c\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffratercula%2Fpavane","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffratercula%2Fpavane","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffratercula%2Fpavane/lists"}