Skip to content

Commit a428a90

Browse files
manruedasindresorhus
manrueda
authored and
sindresorhus
committed
Add mount device custom icon generation (#33)
1 parent 8a77dd1 commit a428a90

File tree

8 files changed

+172
-77
lines changed

8 files changed

+172
-77
lines changed

‎cli.js

Lines changed: 87 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const appdmg = require('appdmg');
77
const plist = require('plist');
88
const Ora = require('ora');
99
const execa = require('execa');
10+
const composeIcon = require('./compose-icon');
1011

1112
if (process.platform !== 'darwin') {
1213
console.error('macOS only');
@@ -56,94 +57,106 @@ try {
5657

5758
const appInfo = plist.parse(infoPlist);
5859
const appName = appInfo.CFBundleDisplayName || appInfo.CFBundleName;
59-
// `const appIconName = appInfo.CFBundleIconFile.replace(/\.icns/, '');
60+
const appIconName = appInfo.CFBundleIconFile.replace(/\.icns/, '');
6061
const dmgPath = path.join(destPath, `${appName} ${appInfo.CFBundleShortVersionString}.dmg`);
6162

6263
const ora = new Ora('Creating DMG');
6364
ora.start();
6465

65-
if (cli.flags.overwrite) {
66-
try {
67-
fs.unlinkSync(dmgPath);
68-
} catch (_) {}
69-
}
70-
71-
const ee = appdmg({
72-
target: dmgPath,
73-
basepath: process.cwd(),
74-
specification: {
75-
title: appName,
76-
// Disabled because of #16
77-
// icon: path.join(appPath, 'Contents/Resources', `${appIconName}.icns`),
78-
//
79-
// Use transparent background and `background-color` option when this is fixed:
80-
// https://github.com/LinusU/node-appdmg/issues/135
81-
background: path.join(__dirname, 'assets/dmg-background.png'),
82-
'icon-size': 160,
83-
format: 'ULFO',
84-
window: {
85-
size: {
86-
width: 660,
87-
height: 400
88-
}
89-
},
90-
contents: [
91-
{
92-
x: 180,
93-
y: 170,
94-
type: 'file',
95-
path: appPath
96-
},
97-
{
98-
x: 480,
99-
y: 170,
100-
type: 'link',
101-
path: '/Applications'
102-
}
103-
]
66+
async function init() {
67+
if (cli.flags.overwrite) {
68+
try {
69+
fs.unlinkSync(dmgPath);
70+
} catch (_) {}
10471
}
105-
});
10672

107-
ee.on('progress', info => {
108-
if (info.type === 'step-begin') {
109-
ora.text = info.title;
110-
}
111-
});
73+
ora.text = 'Creating icon';
74+
const composedIconPath = await composeIcon(path.join(appPath, 'Contents/Resources', `${appIconName}.icns`));
75+
76+
const ee = appdmg({
77+
target: dmgPath,
78+
basepath: process.cwd(),
79+
specification: {
80+
title: appName,
81+
icon: composedIconPath,
82+
//
83+
// Use transparent background and `background-color` option when this is fixed:
84+
// https://github.com/LinusU/node-appdmg/issues/135
85+
background: path.join(__dirname, 'assets/dmg-background.png'),
86+
'icon-size': 160,
87+
format: 'ULFO',
88+
window: {
89+
size: {
90+
width: 660,
91+
height: 400
92+
}
93+
},
94+
contents: [
95+
{
96+
x: 180,
97+
y: 170,
98+
type: 'file',
99+
path: appPath
100+
},
101+
{
102+
x: 480,
103+
y: 170,
104+
type: 'link',
105+
path: '/Applications'
106+
}
107+
]
108+
}
109+
});
112110

113-
ee.on('finish', async () => {
114-
ora.text = 'Code signing DMG';
115-
116-
try {
117-
let identity;
118-
const {stdout} = await execa('security', ['find-identity', '-v', '-p', 'codesigning']);
119-
if (stdout.includes('Developer ID Application:')) {
120-
identity = 'Developer ID Application';
121-
} else if (stdout.includes('Mac Developer:')) {
122-
identity = 'Mac Developer';
123-
} else {
124-
const err = new Error();
125-
err.stderr = 'No usable identity found';
126-
throw err;
111+
ee.on('progress', info => {
112+
if (info.type === 'step-begin') {
113+
ora.text = info.title;
127114
}
115+
});
116+
117+
ee.on('finish', async () => {
118+
try {
119+
ora.text = 'Replacing DMG icon';
120+
// Seticon is a native tool to change files icons (Source: https://github.com/sveinbjornt/osxiconutils)
121+
await execa(path.join(__dirname, 'seticon'), [composedIconPath, dmgPath]);
122+
123+
ora.text = 'Code signing DMG';
124+
let identity;
125+
const {stdout} = await execa('security', ['find-identity', '-v', '-p', 'codesigning']);
126+
if (stdout.includes('Developer ID Application:')) {
127+
identity = 'Developer ID Application';
128+
} else if (stdout.includes('Mac Developer:')) {
129+
identity = 'Mac Developer';
130+
} else {
131+
const err = new Error();
132+
err.stderr = 'No usable identity found';
133+
throw err;
134+
}
128135

129-
await execa('codesign', ['--sign', identity, dmgPath]);
130-
const {stderr} = await execa('codesign', [dmgPath, '--display', '--verbose=2']);
136+
await execa('codesign', ['--sign', identity, dmgPath]);
137+
const {stderr} = await execa('codesign', [dmgPath, '--display', '--verbose=2']);
138+
139+
const match = /^Authority=(.*)$/m.exec(stderr);
140+
if (!match) {
141+
ora.fail('Not code signed');
142+
process.exit(1);
143+
}
131144

132-
const match = /^Authority=(.*)$/m.exec(stderr);
133-
if (!match) {
134-
ora.fail('Not code signed');
135-
process.exit(1);
145+
ora.info(`Code signing identity: ${match[1]}`).start();
146+
ora.succeed('DMG created');
147+
} catch (error) {
148+
ora.fail(`Code signing failed. The DMG is fine, just not code signed.\n${error.stderr.trim()}`);
149+
process.exit(2);
136150
}
151+
});
137152

138-
ora.info(`Code signing identity: ${match[1]}`).start();
139-
ora.succeed('DMG created');
140-
} catch (error) {
141-
ora.fail(`Code signing failed. The DMG is fine, just not code signed.\n${error.stderr.trim()}`);
142-
process.exit(2);
143-
}
144-
});
153+
ee.on('error', error => {
154+
ora.fail(error);
155+
process.exit(1);
156+
});
157+
}
145158

146-
ee.on('error', error => {
159+
init().catch(error => {
147160
ora.fail(error);
148161
process.exit(1);
149162
});

‎compose-icon.js

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
const fs = require('fs');
2+
const {promisify} = require('util');
3+
const execa = require('execa');
4+
const tempy = require('tempy');
5+
const gm = require('gm').subClass({imageMagick: true});
6+
const icns = require('icns-lib');
7+
8+
const readFile = promisify(fs.readFile);
9+
const writeFile = promisify(fs.writeFile);
10+
11+
const filterMap = (map, filterFn) => Object.entries(map).filter(filterFn).reduce((out, [key, item]) => ({...out, [key]: item}), {});
12+
// Drive icon from /System/Library/Extensions/IOStorageFamily.kext/Contents/Resources/Removable.icns
13+
const baseDiskIconPath = `${__dirname}/disk-icon.icns`;
14+
15+
async function composeIcon(type, appIcon, mountIcon, composedIcon) {
16+
mountIcon = gm(mountIcon);
17+
appIcon = gm(appIcon);
18+
const appIconSize = await promisify(appIcon.size.bind(appIcon))();
19+
const mountIconSize = appIconSize;
20+
21+
// Change the perspective of the app icon to match the mount drive icon
22+
appIcon = appIcon.out('-matte').out('-virtual-pixel', 'transparent').out('-distort', 'Perspective', `1,1 ${appIconSize.width * 0.08},1 ${appIconSize.width},1 ${appIconSize.width * 0.92},1 1,${appIconSize.height} 1,${appIconSize.height} ${appIconSize.width},${appIconSize.height} ${appIconSize.width},${appIconSize.height}`);
23+
// Resize the app icon to fit it inside the mount icon, aspect ration should not be kept to create the perspective illution
24+
appIcon = appIcon.resize(appIconSize.width / 1.7, appIconSize.height / 1.78, '!');
25+
26+
const tempAppIconPath = tempy.file({extension: 'png'});
27+
await promisify(appIcon.write.bind(appIcon))(tempAppIconPath);
28+
// Compose the two icons
29+
const iconGravityFactor = mountIconSize.height * 0.155;
30+
mountIcon = mountIcon.composite(tempAppIconPath).gravity('Center').geometry(`+0-${iconGravityFactor}`);
31+
32+
composedIcon[type] = await promisify(mountIcon.toBuffer.bind(mountIcon))();
33+
}
34+
35+
const hasGm = async () => {
36+
try {
37+
await execa('gm', ['-version']);
38+
return true;
39+
} catch (error) {
40+
if (error.code === 'ENOENT') {
41+
return false;
42+
}
43+
throw error;
44+
}
45+
};
46+
47+
module.exports = async function (appIconPath) {
48+
if (!await hasGm()) {
49+
return baseDiskIconPath;
50+
}
51+
const baseDiskIcons = filterMap(icns.parse(await readFile(baseDiskIconPath)), ([key]) => icns.isImageType(key));
52+
const appIcon = filterMap(icns.parse(await readFile(appIconPath)), ([key]) => icns.isImageType(key));
53+
54+
const composedIcon = {};
55+
await Promise.all(Object.entries(appIcon).map(async ([type, icon]) => {
56+
if (baseDiskIcons[type]) {
57+
return composeIcon(type, icon, baseDiskIcons[type], composedIcon);
58+
}
59+
console.warn('There is no base image for this type', type);
60+
}));
61+
const tempComposedIcon = tempy.file({extension: 'icns'});
62+
await writeFile(tempComposedIcon, icns.format(composedIcon));
63+
return tempComposedIcon;
64+
};

‎disk-icon.icns

1.09 MB
Binary file not shown.

‎icon-example-app.png

75.8 KB
Loading

‎icon-example.png

67.2 KB
Loading

‎package.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
},
2121
"files": [
2222
"cli.js",
23-
"assets"
23+
"assets",
24+
"disk-icon.icns",
25+
"seticon"
2426
],
2527
"keywords": [
2628
"cli-app",
@@ -38,13 +40,15 @@
3840
"dependencies": {
3941
"appdmg": "^0.5.2",
4042
"execa": "^1.0.0",
43+
"gm": "^1.23.1",
44+
"icns-lib": "^1.0.1",
4145
"meow": "^5.0.0",
4246
"ora": "^3.0.0",
43-
"plist": "^3.0.1"
47+
"plist": "^3.0.1",
48+
"tempy": "^0.2.1"
4449
},
4550
"devDependencies": {
4651
"ava": "^0.25.0",
47-
"tempy": "^0.2.1",
4852
"xo": "^0.23.0"
4953
}
5054
}

‎readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ It will try to code sign the DMG, but the DMG is still created and fine even if
4747

4848
<img src="screenshot-dmg.png" width="772">
4949

50+
### DMG Icon
51+
52+
[GraphicsMagick](http://www.graphicsmagick.org/) is required to create the DMG icon based on the application icon and macOS mounted device icon.
53+
54+
### Steps using Brew
55+
```bash
56+
brew install imagemagick
57+
brew install graphicsmagick
58+
```
59+
60+
### Icon Example
61+
62+
<img src="icon-example-app.png" width="300">
63+
<img src="icon-example.png" width="300">
5064

5165
## License
5266

‎seticon

57.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)