{"id":13823878,"url":"https://github.com/rakuten-frontend/grunt-appdmg","last_synced_at":"2025-07-08T18:31:17.147Z","repository":{"id":21601261,"uuid":"24921424","full_name":"rakuten-frontend/grunt-appdmg","owner":"rakuten-frontend","description":"Grunt plugin for generating Mac OS X DMG-images.","archived":true,"fork":false,"pushed_at":"2022-03-15T21:12:50.000Z","size":362,"stargazers_count":15,"open_issues_count":2,"forks_count":10,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-06-03T11:54:58.552Z","etag":null,"topics":["dmg","grunt","grunt-plugin","macos"],"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/rakuten-frontend.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":"2014-10-08T02:34:42.000Z","updated_at":"2024-11-28T03:17:11.000Z","dependencies_parsed_at":"2022-08-21T19:41:06.357Z","dependency_job_id":null,"html_url":"https://github.com/rakuten-frontend/grunt-appdmg","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/rakuten-frontend/grunt-appdmg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakuten-frontend%2Fgrunt-appdmg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakuten-frontend%2Fgrunt-appdmg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakuten-frontend%2Fgrunt-appdmg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakuten-frontend%2Fgrunt-appdmg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rakuten-frontend","download_url":"https://codeload.github.com/rakuten-frontend/grunt-appdmg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakuten-frontend%2Fgrunt-appdmg/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259732707,"owners_count":22903085,"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":["dmg","grunt","grunt-plugin","macos"],"created_at":"2024-08-04T09:00:47.997Z","updated_at":"2025-07-08T18:31:16.867Z","avatar_url":"https://github.com/rakuten-frontend.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# grunt-appdmg\n\u003e Grunt plugin for generating Mac OS X DMG-images.\n\n[![NPM Version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Dependency Status][deps-image]][deps-url]\n\n## Overview\n**[node-appdmg](https://github.com/LinusU/node-appdmg)** is an awesome command line tool that can generate beautiful disk images (.dmg) for your OS X applications.\nThis Grunt plugin executes it programmatically using Gruntfile.\n\nYou can use [Grunt template strings](http://gruntjs.com/api/grunt.template) in the appdmg config, like: `title: '\u003c%= pkg.name %\u003e'`.\n\n**Note:**  \nCurrently grunt-appdmg works on **Mac OS X only** due to the [node-appdmg limitation](https://github.com/LinusU/node-appdmg/issues/14).\n\n## Getting started\n\nThis plugin requires [Grunt](http://gruntjs.com/) `\u003e=0.4.0`.  \nIf you haven't used Grunt before, be sure to check out the [Getting started](http://gruntjs.com/getting-started) guide.\n\n### Install\n```sh\n$ npm install grunt-appdmg --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-appdmg');\n```\n\n**For cross platform projects:**  \nIf you want to include this plugin in a cross platform project, install grunt-appdmg with `--save-optional` flag instead of `--save-dev`.\nThis will prevent npm-install error on Windows/Linux.\n\n## The \"appdmg\" task\n\n### Options\nSee the **[appdmg specification](https://github.com/LinusU/node-appdmg#json-input)**.  \nAdditionally `basepath` option is available in this plugin.\n\n#### basepath\nType: `String`  \nDefault: `process.cwd()` - directory that contains Gruntfile.js\n\nOptional. Base path to look for asset files: `icon`, `background` and `contents.path`.\n\n### Example\nIn your project's Gruntfile, add a section named `appdmg` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  appdmg: {\n    options: {\n      basepath: 'path/to/assets',\n      title: 'Title of DMG',\n      icon: 'icon.icns',\n      background: 'background.png',\n      contents: [\n        {x: 448, y: 344, type: 'link', path: '/Applications'},\n        {x: 192, y: 344, type: 'file', path: 'your-app.app'},\n        {x: 512, y: 128, type: 'file', path: 'extra-file.txt'}\n      ]\n    },\n    target: {\n      dest: 'path/to/your-app.dmg'\n    }\n  }\n});\n```\n\n## License\nCopyright (c) 2014-2017 Rakuten, Inc.\nLicensed under the [MIT License](LICENSE).\n\n[npm-image]: https://img.shields.io/npm/v/grunt-appdmg.svg\n[npm-url]: https://www.npmjs.com/package/grunt-appdmg\n[travis-image]: https://travis-ci.org/rakuten-frontend/grunt-appdmg.svg?branch=master\n[travis-url]: https://travis-ci.org/rakuten-frontend/grunt-appdmg\n[deps-image]: https://david-dm.org/rakuten-frontend/grunt-appdmg.svg\n[deps-url]: https://david-dm.org/rakuten-frontend/grunt-appdmg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakuten-frontend%2Fgrunt-appdmg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frakuten-frontend%2Fgrunt-appdmg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakuten-frontend%2Fgrunt-appdmg/lists"}