{"id":18552430,"url":"https://github.com/andrejewski/reem-coffee","last_synced_at":"2025-06-14T06:34:25.442Z","repository":{"id":18082990,"uuid":"21146864","full_name":"andrejewski/reem-coffee","owner":"andrejewski","description":"Compile CoffeeScript files to JavaScript files with Reem","archived":false,"fork":false,"pushed_at":"2014-06-24T00:30:25.000Z","size":144,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-15T11:13:00.443Z","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":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrejewski.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":"2014-06-24T00:24:01.000Z","updated_at":"2019-03-28T16:39:21.000Z","dependencies_parsed_at":"2022-09-26T21:40:57.450Z","dependency_job_id":null,"html_url":"https://github.com/andrejewski/reem-coffee","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andrejewski/reem-coffee","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Freem-coffee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Freem-coffee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Freem-coffee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Freem-coffee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrejewski","download_url":"https://codeload.github.com/andrejewski/reem-coffee/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Freem-coffee/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259774598,"owners_count":22909164,"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":[],"created_at":"2024-11-06T21:14:12.556Z","updated_at":"2025-06-14T06:34:25.423Z","avatar_url":"https://github.com/andrejewski.png","language":"JavaScript","readme":"reem-coffee\n===\n\nCompile CoffeeScript files to JavaScript files with Reem\n\n## Installation\n\n```bash\nnpm install reem-coffee # --save for projects\n```\n\n## Usage\n\n```javascript\nvar coffee = require('reem-coffee');\nreem.File.use(coffee([options]));\n```\n\n## About\n\n`reem-coffee` is a plugin for [Reem](https://github.com/andrejewski/reem) that integrates CoffeeScript files into builds. The plugin is slightly based on [metalsmith-coffee](https://github.com/joaoafrmartins/metalsmith-coffee), but offers more functionality.\n\n## Features\n\nNot only does this plugin compile CoffeeScript files to JavaScript, it also has support for source maps and in place transformation. The source maps will just work if you set the option `sourceMap` to true. The in-place transformation will overwrite the CoffeeScript file's contents with the new JavaScript; this is by default, but to make seperate CoffeeScript files just set the option `preserveSources` to true.\n\nIt is important to note that this plugin does not write to any file directory. It merely adds to and manipulates the source tree, adding JavaScript and source map files and altering the source CoffeeScript if provisioned to do so. This allows later plugins to do minification and all the other file optimizations if you desire to include them. There are also porperties set on all invloved files that link to each other to allow for easier debugging and checks. The `coffeeCompiled` boolean is set to true on the orginal CoffeeScript file after compilation, for instance.\n\n## Options\n\nTo configure this plugin, you may pass your `coffee-script` compile options object. And `reem-coffee` includes its own options as well.\n\n`filter Function(file Reem.Item) Boolean`\nThe filter function takes a Reem Item (list, post, file, page) and returns a Boolean telling this plugin to compile the item if true.\n\n`filter Array[String]`\nProvide an array of extensions and the plugin will only compile items with the same extension. The default extensions are `[\".coffee\", \".litcoffee\", \".coffee.md\"]`.\n\n`rename Function(file Reem.Item) String`\nThe rename function takes a Reem Item (list, post, file, page) and returns a String which will be used as the basename for the compiled JavaScript file and source map. The default function returns the basename of the given file.\n\n`preserveSources Boolean`\nIf set to true, the plugin will make a seperate JavaScript file within the same list of the source CoffeeScript file. Otherwise, the CoffeeScript file is overridden with a new filename/filepath and compiled JavaScript content.\n\n`sourceMap Boolean`\nThis option is a part of the `coffee-script` compile options. However, if set to true, this plugin will create the V3 source map in the same list as the orginal CoffeeScript file.\n\n## Contributing\n\nIf you have an issue or find a bug open an issue and I will see what we can do. If you can fix the bug yourself, by all means send a pull request for consideration.\n\nUntil `reem` and `reem-coffee` hit v1, I would like to keep backwards compatibility with the v0.0.1, treating it like v1. When the conditions are met for v1, we can cut away the cruft of v0.\n\n```bash\n# running tests\nnpm run test\nnpm run test-spec\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejewski%2Freem-coffee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrejewski%2Freem-coffee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejewski%2Freem-coffee/lists"}