{"id":19299184,"url":"https://github.com/bmatcuk/brunch-static","last_synced_at":"2026-03-17T18:37:14.241Z","repository":{"id":1367631,"uuid":"41944770","full_name":"bmatcuk/brunch-static","owner":"bmatcuk","description":"Transform static files using brunch.","archived":false,"fork":false,"pushed_at":"2022-12-10T16:36:54.000Z","size":258,"stargazers_count":10,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-02-11T02:11:35.204Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bmatcuk.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}},"created_at":"2015-09-05T01:35:04.000Z","updated_at":"2020-10-10T18:51:50.000Z","dependencies_parsed_at":"2023-01-11T16:03:42.564Z","dependency_job_id":null,"html_url":"https://github.com/bmatcuk/brunch-static","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/bmatcuk/brunch-static","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmatcuk%2Fbrunch-static","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmatcuk%2Fbrunch-static/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmatcuk%2Fbrunch-static/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmatcuk%2Fbrunch-static/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bmatcuk","download_url":"https://codeload.github.com/bmatcuk/brunch-static/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmatcuk%2Fbrunch-static/sbom","scorecard":{"id":245331,"data":{"date":"2025-08-11","repo":{"name":"github.com/bmatcuk/brunch-static","commit":"2553fa65acbeb8f0d5a2707177ff3fd30d9ab027"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"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":"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":"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":"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":"Code-Review","score":0,"reason":"Found 1/22 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":"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":"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":"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 1 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"}},{"name":"Vulnerabilities","score":0,"reason":"41 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-pc58-wgmc-hfjr","Warn: Project is vulnerable to: GHSA-vvv8-xw5f-3f88","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T07:30:31.735Z","repository_id":1367631,"created_at":"2025-08-17T07:30:31.735Z","updated_at":"2025-08-17T07:30:31.735Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30628425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T17:32:55.572Z","status":"ssl_error","status_checked_at":"2026-03-17T17:32:38.732Z","response_time":56,"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":[],"created_at":"2024-11-09T23:10:27.167Z","updated_at":"2026-03-17T18:37:14.223Z","avatar_url":"https://github.com/bmatcuk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Release](https://img.shields.io/npm/v/brunch-static.svg)\n\n# brunch-static\nTransform static files using brunch.\n\n[Brunch](http://brunch.io) is great for doing all sorts of transpiling, compiling, minifying, uglfying, combining, and other such activities on CSS and Javascript files. But what if you have a file that isn't CSS or Javascript (and doesn't transpile into those things), and you want to convert it into something else in your output? For example, maybe you don't want to write boring HTML when you could be using something more friendly (like [jade](http://jade-lang.com/)). Brunch isn't really designed for that.\n\n**Enter brunch-static.**\n\nbrunch-static is a plugin that makes it possible to write _other_ plugins (called \"processors\") that can operate on files, outputting a \"static\" file (or files) in your output directory. Several brunch plugins attempt to solve this problem on their own, but they all suffer from some drawback. It is the aim of brunch-static to solve these problems, while making it easy to write a static plugin.\n\nIf you want to dive into writing your own processor, [jump down](#writing-brunch-static-processors). Otherwise, keep reading.\n\n## Installation\nInstall the plugin via npm with `npm install --save-dev brunch-static`\n\nOr manually:\n\n* Add `\"brunch-static\": \"x.y.z\"` to `package.json` and run `npm install`\n* If you want to use the git version, add: `\"brunch-static\": \"git+ssh://git@github.com:bmatcuk/brunch-static.git\"`\n\n## Configuration\nbrunch-static's only config is a list of processors you want. In your `brunch-config.coffee`, you can add your static processors:\n\n```coffee\nexports.config =\n  ...\n  plugins:\n    static:\n      pathTransform: ((filename) -\u003e ...)\n      processors: [\n        ...\n      ]\n```\n\n* **pathTransform** _(default: `(f) -\u003e f`)_\n  \u003e _pathTransform_ converts the input path into the output path. The input to this function will be the file's path, relative to one of Brunch's `paths.watched` directories. For example, if you've configured Brunch to watch the `app` directory and you have a file named `app/pages/index.static.hbs`, then `pages/index.static.hbs` will be passed into _pathTransform_. The value returned from this function will be joined with Brunch's `paths.public` to form the final output path. So, in the earlier example, if you wanted files under the `pages` subdirectory to appear in the root of the output, you might write a _pathTransform_ such as: `(f) -\u003e path.relative 'pages', f`. This would cause `app/pages/index.static.hbs` to output to `public/index.html`.\n\n## Available Processors\nBelow is a list of available processors. If you'd like your processor to be included in this list, [create an issue](https://github.com/bmatcuk/brunch-static/issues/new) with your project's URL and a description.\n\n* [html-brunch-static](https://github.com/bmatcuk/html-brunch-static)\n\n  Build static websites using brunch and your favorite templating language. Supports layouts and partial views and currently supports the following templating languages:\n\n  * [markdown](https://github.com/bmatcuk/marked-brunch-static)\n  * [nunjucks](https://github.com/bmatcuk/njk-brunch-static)\n  * [pug](https://github.com/bmatcuk/pug-brunch-static)\n  * [jade](https://github.com/bmatcuk/jade-brunch-static)\n  * handlebars is built-in\n\n## Writing brunch-static Processors\n### What Does brunch-static Do?\nOk, so, first, what do you get with brunch-static?\n\n1. brunch-static will write your output file(s), taking care to create subdirectories as necessary.\n2. brunch-static will not add any output to the brunch output files.\n\n### Processors\nProcessors are kind of similar to Brunch plugins theselves: an object that has certain members and methods. It's recommended that your project follows the naming scheme: `whatever-brunch-static` to make it easy to find in npm.\n\n```javascript\nvar MyStaticProcessor = function(config) { ... };\n\nMyStaticProcessor.prototype = {\n  handles: ...,\n  compile: function(data, filename, callback) { ... }\n};\n\n// export a simple function to make it easier to include in brunch-config.coffee\nmodule.exports = function(config) { return new MyStaticProcessor(config); };\n```\n\n* **handles**\n  \u003e _handles_ is an [anymatch](https://github.com/es128/anymatch) that will be used to determine if your processor can handle a given file. This means it can either be a string (using globs), a regex, or a function that takes a single parameter (the filename) and returns true if your processor can handle it, or false otherwise.\n\n* **compile**\n  \u003e _compile_ is a function that will receive the contents of the file, the file's name, and a callback function. After you have finished processing the file's data, you will need to call the callback function with the following:\n  \u003e\n  \u003e * `callback(err, files, dependencies)`\n  \u003e   * **err** informs brunch-static when something goes wrong. If there were no issues, pass null.\n  \u003e   * **files** an array of objects in the form: `[ {filename: \"...\", content: \"...\"}, {...}, ... ]`\n  \u003e     * **filename** is the relative path of the output file. For example, if the input path was `app/path/to/file.jade`, **filename** might be something like `app/path/to/file.html`. brunch-static will automatically remove any of the \"watched\" paths from **filename** (like `app` in this example) and place it in the output directory. In this example, the final path might be `public/path/to/file.html`.\n  \u003e     * **content** is the result of your processor.\n  \u003e   * **dependencies** is an array of relative paths to any dependencies. For example, you might have dependencies on: `[ 'app/path/to/layout.jade', 'app/path/to/partial.jade' ]`.\n  \u003e\n  \u003e If **files** is null or undefined, nothing will be written. If **dependencies** is null or undefined, no dependencies will be tracked.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmatcuk%2Fbrunch-static","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbmatcuk%2Fbrunch-static","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmatcuk%2Fbrunch-static/lists"}