{"id":23116165,"url":"https://github.com/web-alchemy/web-compressor","last_synced_at":"2026-05-02T19:33:06.708Z","repository":{"id":35946680,"uuid":"220415501","full_name":"web-alchemy/web-compressor","owner":"web-alchemy","description":"Utility for creating gzip, brotli and zstd pre-compressed files for a static web serving.","archived":false,"fork":false,"pushed_at":"2026-02-18T16:38:23.000Z","size":50,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-18T19:57:09.896Z","etag":null,"topics":["brotli","cli","compression","gzip","nodejs","optimization","zstandard","zstd"],"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/web-alchemy.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-08T07:54:24.000Z","updated_at":"2026-02-18T16:39:15.000Z","dependencies_parsed_at":"2024-02-25T21:27:51.443Z","dependency_job_id":"32db63ac-0be0-49c9-9a97-34bd8ef59d24","html_url":"https://github.com/web-alchemy/web-compressor","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/web-alchemy/web-compressor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web-alchemy%2Fweb-compressor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web-alchemy%2Fweb-compressor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web-alchemy%2Fweb-compressor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web-alchemy%2Fweb-compressor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/web-alchemy","download_url":"https://codeload.github.com/web-alchemy/web-compressor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web-alchemy%2Fweb-compressor/sbom","scorecard":{"id":154828,"data":{"date":"2025-07-07","repo":{"name":"github.com/web-alchemy/web-compressor","commit":"038dc7a3ab94a2baaaf15dec1fbb4f14d50f9206"},"scorecard":{"version":"v5.2.1-18-gbb9c347d","commit":"bb9c347dff6349d986baab6578a46d68a5524c62"},"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#code-review"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#token-permissions"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#maintained"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#dangerous-workflow"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#sast"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#binary-artifacts"}},{"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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/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/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T11:28:54.433Z","repository_id":35946680,"created_at":"2025-08-16T11:28:54.434Z","updated_at":"2025-08-16T11:28:54.434Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32547647,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-02T19:18:06.202Z","status":"ssl_error","status_checked_at":"2026-05-02T19:16:21.335Z","response_time":132,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["brotli","cli","compression","gzip","nodejs","optimization","zstandard","zstd"],"created_at":"2024-12-17T04:13:38.752Z","updated_at":"2026-05-02T19:33:06.703Z","avatar_url":"https://github.com/web-alchemy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web Compressor\n\nUtility for creating _gzip_, _brotli_ and _zstd_ pre-compressed files for a static web serving.\n\n## Using as a CLI\n\nBase example (run inside folder with static assets):\n```\nnpx @web-alchemy/web-compressor\n```\n\nExample with all parameters:\n```\nnpx @web-alchemy/web-compressor \\\n  --input=\u003cinput-folder\u003e \\\n  --output=\u003coutput-folder\u003e \\\n  --formats=gzip,brotli,zstd \\\n  --ext-white-list=.html,.css,.js,.json,.svg,.txt,.xml \\\n  --concurrency=4 \\\n  --file-size=4096\n```\n\n## Using as a module\n\n`npm install @web-alchemy/web-compressor`\n\n```javascript\nconst { compress, formats } = require('@web-alchemy/web-compressor');\n\ncompress({\n  input: '\u003cinput-folder\u003e',\n  output: '\u003coutput-folder\u003e',\n  formats: [formats.GZIP, formats.BROTLI, formats.ZSTD]\n  extWhiteList: ['.html', '.css', '.js', '.json', '.svg', '.txt', '.xml'],\n  concurrency: 4,\n  fileSize: 4096\n}).then(() =\u003e {\n  // operation end\n}).catch(() =\u003e {\n  // operation error\n});\n```\n\n## Params Description\n\n| CLI Param | Module Param | Description | default value |\n| --- | --- | --- | --- |\n| `--from` (alias `--input`) | `from` (alias `input`) | Input folder | `process.cwd()` |\n| `--to` (alias `--output`) | `to` (alias `output`) | Output folder | `from` param value |\n| `--formats` | `formats` | Formats of output files | `['gzip', 'brotli']`|\n| `--ext-white-list` | `extWhiteList` | A list of extensions that will be used to filter the necessary files | `['.html', '.css', '.js', '.json', '.svg', '.txt', '.xml']` |\n| `--concurrency` | `concurrency` | number of parallel handlers | `os.cpus().length` |\n| `--file-size` | `fileSize` | File size treshold in bytes. Files smaller than this size will be ignored | `0` |\n\n\n## Enabling precompressed files serving in web servers\n\n- Nginx. [gzip](https://nginx.org/en/docs/http/ngx_http_gzip_static_module.html), [brotli](https://github.com/google/ngx_brotli)\n- [Caddy](https://caddyserver.com/docs/caddyfile/directives/file_server)\n- [H2O](https://h2o.examp1e.net/configure/file_directives.html#file.send-compressed)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb-alchemy%2Fweb-compressor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweb-alchemy%2Fweb-compressor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb-alchemy%2Fweb-compressor/lists"}