181 |
196 |
197 |
198 |
199 |
--------------------------------------------------------------------------------
/bin/frameit_chrome.dart:
--------------------------------------------------------------------------------
1 | import 'dart:convert';
2 | import 'dart:io';
3 |
4 | import 'package:args/args.dart';
5 | import 'package:frameit_chrome/src/config.dart';
6 | import 'package:frameit_chrome/src/frame_process.dart';
7 | import 'package:frameit_chrome/src/frameit_frame.dart';
8 | import 'package:frameit_chrome/src/scene.dart';
9 | import 'package:logging/logging.dart';
10 | import 'package:logging_appenders/logging_appenders.dart';
11 | import 'package:path/path.dart' as path;
12 | import 'package:quiver/check.dart';
13 | import 'package:yaml/yaml.dart';
14 |
15 | final _logger = Logger('frame');
16 |
17 | const chromeBinaryMac =
18 | '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome';
19 |
20 | const ARG_BASE_DIR = 'base-dir';
21 | const ARG_FRAMES_DIR = 'frames-dir';
22 | const ARG_CHROME_BINARY = 'chrome-binary';
23 | const ARG_PIXEL_RATIO = 'pixel-ratio';
24 |
25 | const FRAMES_REPO = 'https://github.com/fastlane/frameit-frames';
26 |
27 | Future
182 |
184 |
185 |
183 |
186 |
195 |
187 |
194 |
188 |
189 |
190 |
191 |
192 |
193 | Samsung App Store
Framed Screenshots
28 |
29 |
--------------------------------------------------------------------------------
/example/metadata/framed/en-US/samsung-galaxy-s10-plus-appbar_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/authpass/frameit-chrome/1350fcac7d53831a60ebf212c74f75647a85f9cb/example/metadata/framed/en-US/samsung-galaxy-s10-plus-appbar_menu.png
--------------------------------------------------------------------------------
/example/metadata/framed/en-US/samsungapps-samsung-galaxy-s10-plus-appbar_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/authpass/frameit-chrome/1350fcac7d53831a60ebf212c74f75647a85f9cb/example/metadata/framed/en-US/samsungapps-samsung-galaxy-s10-plus-appbar_menu.png
--------------------------------------------------------------------------------
/lib/src/config.dart:
--------------------------------------------------------------------------------
1 | import 'dart:io';
2 |
3 | import 'package:json_annotation/json_annotation.dart';
4 | import 'package:path/path.dart' as path;
5 | import 'package:yaml/yaml.dart';
6 |
7 | part 'config.g.dart';
8 |
9 | @JsonSerializable(anyMap: true)
10 | class FrameConfig {
11 | FrameConfig({
12 | @JsonKey(nullable: true) this.rewrite,
13 | @JsonKey(nullable: true) this.images,
14 | });
15 | factory FrameConfig.fromJson(Map json) => _$FrameConfigFromJson(json);
16 |
17 | static const FILE_NAME = 'frameit.yaml';
18 |
19 | Map toJson() => _$FrameConfigToJson(this);
20 |
21 | final List rewrite;
22 | final Map images;
23 |
24 | static Future load(String baseDir) async {
25 | final configFile = File(path.join(baseDir, FrameConfig.FILE_NAME));
26 | if (!configFile.existsSync()) {
27 | return null;
28 | }
29 | return FrameConfig.fromJson(
30 | loadYaml(await configFile.readAsString()) as Map);
31 | }
32 |
33 | FrameImage findImageConfig(String screenshotName) {
34 | return images.entries
35 | .firstWhere((element) => screenshotName.contains(element.key),
36 | orElse: () => null)
37 | ?.value;
38 | }
39 | }
40 |
41 | enum FileAction {
42 | duplicate,
43 | exclude,
44 | rename,
45 | include,
46 | }
47 |
48 | @JsonSerializable(nullable: false, anyMap: true)
49 | class FileNameMapping {
50 | FileNameMapping({
51 | this.pattern,
52 | this.replace,
53 | // @JsonKey(defaultValue: false) this.duplicate,
54 | // @JsonKey(defaultValue: false) this.exclude,
55 | @JsonKey(defaultValue: FileAction.rename) this.action,
56 | });
57 | factory FileNameMapping.fromJson(Map json) => _$FileNameMappingFromJson(json);
58 | Map toJson() => _$FileNameMappingToJson(this);
59 |
60 | final String pattern;
61 | final String replace;
62 | // final bool duplicate;
63 | // final bool exclude;
64 | final FileAction action;
65 |
66 | RegExp _patternRegExp;
67 | RegExp get patternRegExp => _patternRegExp ??= RegExp(pattern);
68 | }
69 |
70 | @JsonSerializable(nullable: true, anyMap: true)
71 | class FrameImage {
72 | FrameImage({
73 | this.cropWidth,
74 | this.cropHeight,
75 | this.device,
76 | this.previewLabel,
77 | this.css,
78 | });
79 | factory FrameImage.fromJson(Map json) =>
80 | _$FrameImageFromJson(json);
81 | Map toJson() => _$FrameImageToJson(this);
82 |
83 | /// Crop with of the final image. (null for using the original width)
84 | final int cropWidth;
85 |
86 | /// Crop height of the final image. (null for using the original width)
87 | final int cropHeight;
88 |
89 | /// device name used to look up correct frame.
90 | final String device;
91 |
92 | /// Optional label used only for the `_preview.html`
93 | final String previewLabel;
94 |
95 | /// Allows customizing the css.
96 | final String css;
97 | }
98 |
--------------------------------------------------------------------------------
/lib/src/config.g.dart:
--------------------------------------------------------------------------------
1 | // GENERATED CODE - DO NOT MODIFY BY HAND
2 |
3 | part of 'config.dart';
4 |
5 | // **************************************************************************
6 | // JsonSerializableGenerator
7 | // **************************************************************************
8 |
9 | FrameConfig _$FrameConfigFromJson(Map json) {
10 | return FrameConfig(
11 | rewrite: (json['rewrite'] as List)
12 | ?.map((e) => e == null ? null : FileNameMapping.fromJson(e as Map))
13 | ?.toList(),
14 | images: (json['images'] as Map)?.map(
15 | (k, e) => MapEntry(
16 | k as String,
17 | e == null
18 | ? null
19 | : FrameImage.fromJson((e as Map)?.map(
20 | (k, e) => MapEntry(k as String, e),
21 | ))),
22 | ),
23 | );
24 | }
25 |
26 | Map _$FrameConfigToJson(FrameConfig instance) =>
27 | {
28 | 'rewrite': instance.rewrite,
29 | 'images': instance.images,
30 | };
31 |
32 | FileNameMapping _$FileNameMappingFromJson(Map json) {
33 | return FileNameMapping(
34 | pattern: json['pattern'] as String,
35 | replace: json['replace'] as String,
36 | action: _$enumDecode(_$FileActionEnumMap, json['action']),
37 | );
38 | }
39 |
40 | Map _$FileNameMappingToJson(FileNameMapping instance) =>
41 | {
42 | 'pattern': instance.pattern,
43 | 'replace': instance.replace,
44 | 'action': _$FileActionEnumMap[instance.action],
45 | };
46 |
47 | T _$enumDecode(
48 | Map enumValues,
49 | dynamic source, {
50 | T unknownValue,
51 | }) {
52 | if (source == null) {
53 | throw ArgumentError('A value must be provided. Supported values: '
54 | '${enumValues.values.join(', ')}');
55 | }
56 |
57 | final value = enumValues.entries
58 | .singleWhere((e) => e.value == source, orElse: () => null)
59 | ?.key;
60 |
61 | if (value == null && unknownValue == null) {
62 | throw ArgumentError('`$source` is not one of the supported values: '
63 | '${enumValues.values.join(', ')}');
64 | }
65 | return value ?? unknownValue;
66 | }
67 |
68 | const _$FileActionEnumMap = {
69 | FileAction.duplicate: 'duplicate',
70 | FileAction.exclude: 'exclude',
71 | FileAction.rename: 'rename',
72 | FileAction.include: 'include',
73 | };
74 |
75 | FrameImage _$FrameImageFromJson(Map json) {
76 | return FrameImage(
77 | cropWidth: json['cropWidth'] as int,
78 | cropHeight: json['cropHeight'] as int,
79 | device: json['device'] as String,
80 | previewLabel: json['previewLabel'] as String,
81 | css: json['css'] as String,
82 | );
83 | }
84 |
85 | Map _$FrameImageToJson(FrameImage instance) =>
86 | {
87 | 'cropWidth': instance.cropWidth,
88 | 'cropHeight': instance.cropHeight,
89 | 'device': instance.device,
90 | 'previewLabel': instance.previewLabel,
91 | 'css': instance.css,
92 | };
93 |
94 | // **************************************************************************
95 | // StaticTextGenerator
96 | // **************************************************************************
97 |
98 | // ignore_for_file: implicit_dynamic_parameter,strong_mode_implicit_dynamic_parameter,strong_mode_implicit_dynamic_variable,non_constant_identifier_names,unused_element
99 |
--------------------------------------------------------------------------------
/lib/src/frame_colors.dart:
--------------------------------------------------------------------------------
1 | const FRAME_COLORS = {
2 | 'Matte Black',
3 | 'Space Gray',
4 | 'Rose Gold',
5 | 'Clearly White',
6 | 'Just Black',
7 | 'Not Pink',
8 | 'Silver Titanium',
9 | 'Arctic Silver',
10 | 'Coral Blue',
11 | 'Maple Gold',
12 | 'Midnight Black',
13 | 'Midnight Green',
14 | 'Orchid Gray',
15 | 'Burgundy Red',
16 | 'Lilac Purple',
17 | 'Sunrise Gold',
18 | 'Titanium Gray',
19 | 'Flamingo Pink',
20 | 'Prism Black',
21 | 'Prism Blue',
22 | 'Prism Green',
23 | 'Prism White',
24 | 'Ceramic White',
25 | 'Oh So Orange',
26 | 'Aura Black',
27 | 'Aura Glow',
28 | 'Aura Pink',
29 | 'Aura Red',
30 | 'Aura White',
31 | 'Aura Blue',
32 | 'Coral',
33 | 'Black',
34 | 'White',
35 | 'Gold',
36 | 'Silver',
37 | 'Blue',
38 | 'Red',
39 | 'Yellow',
40 | 'Green',
41 | 'Pink',
42 | 'Purple',
43 | };
44 |
--------------------------------------------------------------------------------
/lib/src/frame_process.dart:
--------------------------------------------------------------------------------
1 | import 'dart:io';
2 |
3 | import 'package:frameit_chrome/src/config.dart';
4 | import 'package:frameit_chrome/src/frameit_frame.dart';
5 | import 'package:image/image.dart';
6 | import 'package:logging/logging.dart';
7 | import 'package:meta/meta.dart';
8 | import 'package:path/path.dart' as path;
9 | import 'package:quiver/check.dart';
10 | import 'package:supercharged_dart/supercharged_dart.dart';
11 |
12 | final _logger = Logger('process_screenshots');
13 |
14 | class FrameProcess {
15 | FrameProcess({
16 | @required this.workingDir,
17 | this.config,
18 | @required this.chromeBinary,
19 | @required this.framesProvider,
20 | this.pixelRatio,
21 | });
22 |
23 | final Directory workingDir;
24 | final FrameConfig config;
25 | final String chromeBinary;
26 | final FramesProvider framesProvider;
27 | final double pixelRatio;
28 | bool validatedPixelRatio = false;
29 |
30 | List rewriteScreenshotName(String name) {
31 | if (name.contains('framed')) {
32 | return null;
33 | }
34 | final rewrite = config?.rewrite;
35 | if (rewrite == null) {
36 | return [name];
37 | }
38 |
39 | final ret = [];
40 | for (final r in rewrite) {
41 | final hasMatch = r.patternRegExp.hasMatch(name);
42 | if (!hasMatch) {
43 | if (r.action == FileAction.include) {
44 | return ret;
45 | }
46 | continue;
47 | }
48 | var newName = name;
49 | if (r.replace != null) {
50 | newName = name.replaceAll(r.patternRegExp, r.replace);
51 | }
52 | switch (r.action) {
53 | case FileAction.duplicate:
54 | ret.add(newName);
55 | break;
56 | case FileAction.rename:
57 | return ret..add(newName);
58 | case FileAction.exclude:
59 | return null;
60 | case FileAction.include:
61 | break;
62 | }
63 | }
64 | ret.add(name);
65 | // return name.replaceAll('samsung-galaxy-s10-plus', 'samsung-galaxy-s10');
66 | return ret;
67 | }
68 |
69 | Future processScreenshots(
70 | Directory dir,
71 | Directory outDir,
72 | Map titleStrings,
73 | Map keywordStrings,
74 | ) async {
75 | checkArgument(dir.existsSync(), message: 'Dir does not exist $dir');
76 | _logger.info('Processing images in $dir');
77 | final createdScreenshots = [];
78 | await for (final fileEntity in dir.list(recursive: true)) {
79 | if (fileEntity is! File) {
80 | continue;
81 | }
82 | final file = fileEntity as File;
83 |
84 | final name =
85 | rewriteScreenshotName(path.basenameWithoutExtension(file.path));
86 | if (name == null) {
87 | continue;
88 | }
89 |
90 | for (final variant in name) {
91 | final result = await _processScreenshot(
92 | dir,
93 | outDir,
94 | file,
95 | titleStrings,
96 | keywordStrings,
97 | variant,
98 | );
99 |
100 | if (result != null) {
101 | createdScreenshots.add(result);
102 | }
103 | }
104 | }
105 |
106 | final imageHtml = createdScreenshots
107 | .groupBy(
108 | (element) => element.config?.previewLabel)
109 | .entries
110 | .expand((e) {
111 | e.value.sort((a, b) => a.compareTo(b));
112 | return [
113 | '${e.key ?? 'Framed Screenshots'}',
114 | ...e.value.map((e) {
115 | final src = path.relative(e.path, from: outDir.path);
116 | return '''
''';
117 | })
118 | ];
119 | }).join('');
120 | // createdScreenshots.sort((a, b) => a.compareTo(b));
121 |
122 | // final imageHtml = createdScreenshots.map((e) {
123 | // final src = path.relative(e.path, from: outDir.path);
124 | // return '''''';
125 | // }).join('');
126 |
127 | await File(path.join(outDir.path, '_preview.html')).writeAsString('''
128 | present me
129 |
142 |
152 |
153 |
154 | $imageHtml
155 |
156 | ''');
157 |
158 | return createdScreenshots;
159 | }
160 |
161 | Future _processScreenshot(
162 | Directory srcDir,
163 | Directory outDir,
164 | File file,
165 | Map titleStrings,
166 | Map keywordStrings,
167 | String screenshotName) async {
168 | // final outFile = path.join(file.parent.path,
169 | // '{path.basenameWithoutExtension(file.path)}_framed.png');
170 |
171 | // find title and keyword
172 | final imageConfig = config?.findImageConfig(screenshotName);
173 | final title = _findString(titleStrings, screenshotName);
174 | final keyword = _findString(keywordStrings, screenshotName);
175 | if (title == null) {
176 | return null;
177 | }
178 |
179 | final replacedTargetName =
180 | path.join(file.parent.path, '$screenshotName.png');
181 | final outFilePath = path.join(
182 | outDir.path, path.relative(replacedTargetName, from: srcDir.path));
183 | await File(outFilePath).parent.create(recursive: true);
184 |
185 | final frame = framesProvider
186 | .frameForScreenshot(imageConfig?.device ?? screenshotName);
187 | _logger.fine(
188 | 'Rendering $screenshotName with title: $title ($keyword) and $frame');
189 |
190 | final image = decodeImage(await file.readAsBytes());
191 |
192 | final css = await _createCss(
193 | frame,
194 | image.width,
195 | image.height,
196 | screenshot: file,
197 | title: title,
198 | keyword: keyword,
199 | ) +
200 | '\n${imageConfig?.css ?? ''}\n';
201 | final indexHtml = File(path.join(workingDir.path, 'index.html'));
202 | final cssFile = File(path.join(workingDir.path, 'index_override.css'));
203 | final screenshotFile = File(path.join(workingDir.path, 'screenshot.png'));
204 | if (screenshotFile.existsSync()) {
205 | await screenshotFile.delete();
206 | }
207 | if (!indexHtml.existsSync()) {
208 | throw StateError('Expected index.html to be in the current directory.');
209 | }
210 | await cssFile.writeAsString(css);
211 | final runStopwatch = Stopwatch()..start();
212 |
213 | final width = imageConfig?.cropWidth ?? image.width;
214 | final height = imageConfig?.cropHeight ?? image.height;
215 |
216 | final result = await Process.run(
217 | chromeBinary,
218 | [
219 | '--headless',
220 | '--no-sandbox',
221 | '--screenshot',
222 | '--hide-scrollbars',
223 | '--window-size=${width ~/ pixelRatio},${height ~/ pixelRatio}',
224 | 'index.html',
225 | ],
226 | workingDirectory: workingDir.path);
227 | if (result.exitCode != 0) {
228 | throw StateError(
229 | 'Chrome headless did not succeed. ${result.exitCode}: $result');
230 | }
231 |
232 | if (!validatedPixelRatio) {
233 | final screenshot = decodeImage(await screenshotFile.readAsBytes());
234 | if (screenshot.width != width) {
235 | throw StateError(
236 | 'Generated image width did not match original image width. '
237 | 'Wrong device pixel ratio?'
238 | ' was: ${screenshot.width}'
239 | ' expected: $width'
240 | ' ratio: $pixelRatio');
241 | }
242 | validatedPixelRatio = true;
243 | }
244 | // final screenshotResized = copyResize(screenshot, width: image.width);
245 | // await File(outFilePath).writeAsBytes(encodePng(screenshotResized));
246 |
247 | await screenshotFile.copy(outFilePath);
248 |
249 | _logger.info('Created (${runStopwatch.elapsedMilliseconds}ms) '
250 | '$outFilePath');
251 | // if (srcDir.path.contains('de-DE') && outFilePath.contains('launchscreen')) {
252 | // print('DEBUG me.');
253 | // exit(0);
254 | // }
255 |
256 | return ProcessScreenshotResult(imageConfig, outFilePath);
257 | }
258 |
259 | static String cssEscape(String str) {
260 | str = str.replaceAllMapped(RegExp('[^A-Za-z _-]+'), (match) {
261 | // str.replaceAllMapped(RegExp('[\n\t\'\"]'), (match) {
262 | final str = match.group(0);
263 | return str.runes.map((e) {
264 | return '\\${e.toRadixString(16).padLeft(6, '0')} ';
265 | }).join('');
266 | });
267 | return '"$str"';
268 | }
269 |
270 | Future _createCss(
271 | Frame frame,
272 | int targetWidth,
273 | int targetHeight, {
274 | @required File screenshot,
275 | String title,
276 | String keyword,
277 | }) async {
278 | final ratio = pixelRatio;
279 | final image = decodeImage(await frame.image.readAsBytes());
280 | final w = image.width / ratio;
281 | final h = image.height / ratio;
282 | title ??= '';
283 | keyword ??= '';
284 | final separator = title.isNotEmpty && keyword.isNotEmpty ? ' ' : '';
285 | return '''
286 | :root {
287 | --frame-orig-width: $w;
288 | --frame-orig-height: $h;
289 |
290 | --frame-orig-offset-x: ${frame.offsetX / ratio};
291 | --frame-orig-offset-y: ${frame.offsetY / ratio};
292 |
293 | --target-width: ${targetWidth / ratio};
294 | --target-height: ${targetHeight / ratio};
295 | }
296 | .keyword:before {
297 | content: ${cssEscape(keyword)};
298 | }
299 | .keyword:after {
300 | content: '$separator';
301 | }
302 | .title:after {
303 | content: ${cssEscape(title)};
304 | }
305 | .screenshot-bg {
306 | background-image: url("${screenshot.absolute.path}");
307 | }
308 | .frame-bg {
309 | background-image: url("${frame.image.absolute.path}");
310 | }
311 | ''';
312 | }
313 |
314 | String _findString(Map strings, String filename) {
315 | for (final entry in strings.entries) {
316 | if (filename.contains(entry.key)) {
317 | return entry.value;
318 | }
319 | }
320 | return null;
321 | }
322 | }
323 |
324 | class ProcessScreenshotResult implements Comparable {
325 | ProcessScreenshotResult(this.config, this.path);
326 |
327 | final FrameImage config;
328 | final String path;
329 |
330 | @override
331 | int compareTo(ProcessScreenshotResult other) {
332 | if (config?.previewLabel != null) {
333 | if (other.config?.previewLabel != null) {
334 | return config.previewLabel.compareTo(other.config.previewLabel);
335 | }
336 | return 1;
337 | }
338 | return path.compareTo(other.path);
339 | }
340 | }
341 |
--------------------------------------------------------------------------------
/lib/src/frameit_frame.dart:
--------------------------------------------------------------------------------
1 | import 'dart:convert';
2 | import 'dart:io';
3 | import 'package:frameit_chrome/src/frame_colors.dart';
4 | import 'package:meta/meta.dart';
5 | import 'package:path/path.dart' as path;
6 |
7 | import 'package:logging/logging.dart';
8 |
9 | final _logger = Logger('frameit_frame');
10 |
11 | String _prepareString(String str) =>
12 | str.replaceAll(RegExp(r'[_-]'), ' ').toLowerCase();
13 |
14 | class FramesProvider {
15 | FramesProvider._(this._frames);
16 |
17 | static final offsetPattern = RegExp(r'^([+-]+\d+)([+-]+\d+)');
18 |
19 | final List _frames;
20 |
21 | static MapEntry _frameInfo(
22 | String deviceName, String fileBasename) {
23 | if (fileBasename.startsWith('Apple ') && !deviceName.startsWith('Apple ')) {
24 | fileBasename = fileBasename.replaceAll('Apple ', '');
25 | }
26 | if (fileBasename.startsWith(deviceName)) {
27 | if (fileBasename.length > deviceName.length) {
28 | final color = fileBasename.substring(deviceName.length + 1);
29 | if (FRAME_COLORS.contains(color)) {
30 | _logger.finest('Found for $deviceName: $fileBasename');
31 | return MapEntry(deviceName, color);
32 | }
33 | } else {
34 | return MapEntry(deviceName, null);
35 | }
36 | }
37 | return null;
38 | }
39 |
40 | static Future create(Directory baseDir) async {
41 | final frameImages = (await baseDir
42 | .list()
43 | .where((event) => event.path.endsWith('png'))
44 | .toList())
45 | .whereType()
46 | .toList();
47 |
48 | final offsetsFile = path.join(baseDir.path, 'offsets.json');
49 | final offsetJson = json.decode(await File(offsetsFile).readAsString())
50 | as Map;
51 | final offsets =
52 | (offsetJson['portrait'] as Map).entries.map((e) {
53 | final map = e.value as Map;
54 |
55 | final f = frameImages.firstWhere(
56 | (frame) =>
57 | _frameInfo(e.key, path.basenameWithoutExtension(frame.path)) !=
58 | null, orElse: () {
59 | _logger.warning('Cannot find ${e.key} image.');
60 | return null;
61 | });
62 | if (f == null) {
63 | return null;
64 | }
65 | if (!f.existsSync()) {
66 | _logger.warning('Unable to find frame image for ${e.key}');
67 | return null;
68 | }
69 | final offsetString = map['offset'] as String;
70 | final offsetMatch = offsetPattern.firstMatch(offsetString);
71 | if (offsetMatch == null) {
72 | throw StateError('Invalid offset: $offsetString');
73 | }
74 | // _logger.info('matches:$offsetMatch ${offsetMatch.groupCount}');
75 | final offsetX = int.parse(offsetMatch.group(1));
76 | final offsetY = int.parse(offsetMatch.group(2));
77 |
78 | return Frame(
79 | name: e.key,
80 | orientation: Orientation.portrait,
81 | offsetX: offsetX,
82 | offsetY: offsetY,
83 | width: int.parse(map['width'].toString()),
84 | image: f);
85 | });
86 | final frames = offsets.where((element) => element != null).toList();
87 | frames.sort((a, b) => -a.nameMatch.compareTo(b.nameMatch));
88 | return FramesProvider._(frames);
89 | }
90 |
91 | Frame frameForScreenshot(String screenshotName) {
92 | final match = _prepareString(screenshotName);
93 | return _frames.firstWhere((element) => match.contains(element.nameMatch),
94 | orElse: () {
95 | _logger.finest('unable to find frame for $match');
96 | return null;
97 | });
98 | }
99 |
100 | // void
101 | }
102 |
103 | enum Orientation {
104 | portrait,
105 | landscape,
106 | }
107 |
108 | class Frame {
109 | Frame({
110 | @required this.name,
111 | @required this.orientation,
112 | @required this.offsetX,
113 | @required this.offsetY,
114 | @required this.width,
115 | @required this.image,
116 | }) : nameMatch = _prepareString(name);
117 |
118 | final String name;
119 | final String nameMatch;
120 | final Orientation orientation;
121 | final int offsetX;
122 | final int offsetY;
123 | final int width;
124 | final File image;
125 |
126 | @override
127 | String toString() {
128 | return 'Frame{name: $name, orientation: $orientation, offsetX: $offsetX, offsetY: $offsetY, width: $width, image: $image}';
129 | }
130 | }
131 |
--------------------------------------------------------------------------------
/lib/src/scene.dart:
--------------------------------------------------------------------------------
1 | import 'dart:convert';
2 | import 'dart:io';
3 |
4 | import 'package:archive/archive.dart';
5 | import 'package:path/path.dart' as path;
6 |
7 | part 'scene.g.dart';
8 |
9 | class Assets {
10 | static Future extractTo(Directory baseDirectory) async {
11 | for (final asset in _Assets.all) {
12 | final f = File(path.join(baseDirectory.path, asset.fileName));
13 | await f.parent.create(recursive: true);
14 | await f
15 | .writeAsBytes(BZip2Decoder().decodeBytes(base64.decode(asset.bytes)));
16 | }
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/pubspec.lock:
--------------------------------------------------------------------------------
1 | # Generated by pub
2 | # See https://dart.dev/tools/pub/glossary#lockfile
3 | packages:
4 | _fe_analyzer_shared:
5 | dependency: transitive
6 | description:
7 | name: _fe_analyzer_shared
8 | url: "https://pub.dartlang.org"
9 | source: hosted
10 | version: "7.0.0"
11 | analyzer:
12 | dependency: transitive
13 | description:
14 | name: analyzer
15 | url: "https://pub.dartlang.org"
16 | source: hosted
17 | version: "0.39.17"
18 | archive:
19 | dependency: "direct main"
20 | description:
21 | name: archive
22 | url: "https://pub.dartlang.org"
23 | source: hosted
24 | version: "2.0.13"
25 | args:
26 | dependency: "direct main"
27 | description:
28 | name: args
29 | url: "https://pub.dartlang.org"
30 | source: hosted
31 | version: "1.6.0"
32 | async:
33 | dependency: transitive
34 | description:
35 | name: async
36 | url: "https://pub.dartlang.org"
37 | source: hosted
38 | version: "2.4.2"
39 | build:
40 | dependency: "direct dev"
41 | description:
42 | name: build
43 | url: "https://pub.dartlang.org"
44 | source: hosted
45 | version: "1.3.0"
46 | build_config:
47 | dependency: transitive
48 | description:
49 | name: build_config
50 | url: "https://pub.dartlang.org"
51 | source: hosted
52 | version: "0.4.2"
53 | build_daemon:
54 | dependency: transitive
55 | description:
56 | name: build_daemon
57 | url: "https://pub.dartlang.org"
58 | source: hosted
59 | version: "2.1.4"
60 | build_resolvers:
61 | dependency: transitive
62 | description:
63 | name: build_resolvers
64 | url: "https://pub.dartlang.org"
65 | source: hosted
66 | version: "1.3.11"
67 | build_runner:
68 | dependency: "direct dev"
69 | description:
70 | name: build_runner
71 | url: "https://pub.dartlang.org"
72 | source: hosted
73 | version: "1.10.2"
74 | build_runner_core:
75 | dependency: transitive
76 | description:
77 | name: build_runner_core
78 | url: "https://pub.dartlang.org"
79 | source: hosted
80 | version: "6.0.1"
81 | builder_static_text:
82 | dependency: "direct dev"
83 | description:
84 | name: builder_static_text
85 | url: "https://pub.dartlang.org"
86 | source: hosted
87 | version: "0.0.1+2"
88 | built_collection:
89 | dependency: transitive
90 | description:
91 | name: built_collection
92 | url: "https://pub.dartlang.org"
93 | source: hosted
94 | version: "4.3.2"
95 | built_value:
96 | dependency: transitive
97 | description:
98 | name: built_value
99 | url: "https://pub.dartlang.org"
100 | source: hosted
101 | version: "7.1.0"
102 | charcode:
103 | dependency: transitive
104 | description:
105 | name: charcode
106 | url: "https://pub.dartlang.org"
107 | source: hosted
108 | version: "1.1.3"
109 | checked_yaml:
110 | dependency: transitive
111 | description:
112 | name: checked_yaml
113 | url: "https://pub.dartlang.org"
114 | source: hosted
115 | version: "1.0.2"
116 | cli_util:
117 | dependency: transitive
118 | description:
119 | name: cli_util
120 | url: "https://pub.dartlang.org"
121 | source: hosted
122 | version: "0.2.0"
123 | clock:
124 | dependency: transitive
125 | description:
126 | name: clock
127 | url: "https://pub.dartlang.org"
128 | source: hosted
129 | version: "1.0.1"
130 | code_builder:
131 | dependency: transitive
132 | description:
133 | name: code_builder
134 | url: "https://pub.dartlang.org"
135 | source: hosted
136 | version: "3.4.1"
137 | collection:
138 | dependency: transitive
139 | description:
140 | name: collection
141 | url: "https://pub.dartlang.org"
142 | source: hosted
143 | version: "1.14.13"
144 | convert:
145 | dependency: transitive
146 | description:
147 | name: convert
148 | url: "https://pub.dartlang.org"
149 | source: hosted
150 | version: "2.1.1"
151 | crypto:
152 | dependency: transitive
153 | description:
154 | name: crypto
155 | url: "https://pub.dartlang.org"
156 | source: hosted
157 | version: "2.1.5"
158 | csslib:
159 | dependency: transitive
160 | description:
161 | name: csslib
162 | url: "https://pub.dartlang.org"
163 | source: hosted
164 | version: "0.16.2"
165 | dart_style:
166 | dependency: transitive
167 | description:
168 | name: dart_style
169 | url: "https://pub.dartlang.org"
170 | source: hosted
171 | version: "1.3.6"
172 | dio:
173 | dependency: transitive
174 | description:
175 | name: dio
176 | url: "https://pub.dartlang.org"
177 | source: hosted
178 | version: "3.0.10"
179 | fixnum:
180 | dependency: transitive
181 | description:
182 | name: fixnum
183 | url: "https://pub.dartlang.org"
184 | source: hosted
185 | version: "0.10.11"
186 | glob:
187 | dependency: "direct dev"
188 | description:
189 | name: glob
190 | url: "https://pub.dartlang.org"
191 | source: hosted
192 | version: "1.2.0"
193 | graphs:
194 | dependency: transitive
195 | description:
196 | name: graphs
197 | url: "https://pub.dartlang.org"
198 | source: hosted
199 | version: "0.2.0"
200 | html:
201 | dependency: transitive
202 | description:
203 | name: html
204 | url: "https://pub.dartlang.org"
205 | source: hosted
206 | version: "0.14.0+3"
207 | http_multi_server:
208 | dependency: transitive
209 | description:
210 | name: http_multi_server
211 | url: "https://pub.dartlang.org"
212 | source: hosted
213 | version: "2.2.0"
214 | http_parser:
215 | dependency: transitive
216 | description:
217 | name: http_parser
218 | url: "https://pub.dartlang.org"
219 | source: hosted
220 | version: "3.1.4"
221 | image:
222 | dependency: "direct main"
223 | description:
224 | name: image
225 | url: "https://pub.dartlang.org"
226 | source: hosted
227 | version: "2.1.14"
228 | intl:
229 | dependency: transitive
230 | description:
231 | name: intl
232 | url: "https://pub.dartlang.org"
233 | source: hosted
234 | version: "0.16.1"
235 | io:
236 | dependency: transitive
237 | description:
238 | name: io
239 | url: "https://pub.dartlang.org"
240 | source: hosted
241 | version: "0.3.4"
242 | js:
243 | dependency: transitive
244 | description:
245 | name: js
246 | url: "https://pub.dartlang.org"
247 | source: hosted
248 | version: "0.6.2"
249 | json_annotation:
250 | dependency: "direct main"
251 | description:
252 | name: json_annotation
253 | url: "https://pub.dartlang.org"
254 | source: hosted
255 | version: "3.0.1"
256 | json_serializable:
257 | dependency: "direct dev"
258 | description:
259 | name: json_serializable
260 | url: "https://pub.dartlang.org"
261 | source: hosted
262 | version: "3.4.1"
263 | logging:
264 | dependency: "direct main"
265 | description:
266 | name: logging
267 | url: "https://pub.dartlang.org"
268 | source: hosted
269 | version: "0.11.4"
270 | logging_appenders:
271 | dependency: "direct main"
272 | description:
273 | name: logging_appenders
274 | url: "https://pub.dartlang.org"
275 | source: hosted
276 | version: "0.4.2+5"
277 | matcher:
278 | dependency: transitive
279 | description:
280 | name: matcher
281 | url: "https://pub.dartlang.org"
282 | source: hosted
283 | version: "0.12.9"
284 | meta:
285 | dependency: "direct main"
286 | description:
287 | name: meta
288 | url: "https://pub.dartlang.org"
289 | source: hosted
290 | version: "1.2.3"
291 | mime:
292 | dependency: transitive
293 | description:
294 | name: mime
295 | url: "https://pub.dartlang.org"
296 | source: hosted
297 | version: "0.9.7"
298 | node_interop:
299 | dependency: transitive
300 | description:
301 | name: node_interop
302 | url: "https://pub.dartlang.org"
303 | source: hosted
304 | version: "1.1.1"
305 | node_io:
306 | dependency: transitive
307 | description:
308 | name: node_io
309 | url: "https://pub.dartlang.org"
310 | source: hosted
311 | version: "1.1.1"
312 | package_config:
313 | dependency: transitive
314 | description:
315 | name: package_config
316 | url: "https://pub.dartlang.org"
317 | source: hosted
318 | version: "1.9.3"
319 | path:
320 | dependency: "direct main"
321 | description:
322 | name: path
323 | url: "https://pub.dartlang.org"
324 | source: hosted
325 | version: "1.7.0"
326 | pedantic:
327 | dependency: "direct dev"
328 | description:
329 | name: pedantic
330 | url: "https://pub.dartlang.org"
331 | source: hosted
332 | version: "1.9.2"
333 | petitparser:
334 | dependency: transitive
335 | description:
336 | name: petitparser
337 | url: "https://pub.dartlang.org"
338 | source: hosted
339 | version: "3.1.0"
340 | pool:
341 | dependency: transitive
342 | description:
343 | name: pool
344 | url: "https://pub.dartlang.org"
345 | source: hosted
346 | version: "1.4.0"
347 | pub_semver:
348 | dependency: transitive
349 | description:
350 | name: pub_semver
351 | url: "https://pub.dartlang.org"
352 | source: hosted
353 | version: "1.4.4"
354 | pubspec_parse:
355 | dependency: transitive
356 | description:
357 | name: pubspec_parse
358 | url: "https://pub.dartlang.org"
359 | source: hosted
360 | version: "0.1.5"
361 | quiver:
362 | dependency: "direct main"
363 | description:
364 | name: quiver
365 | url: "https://pub.dartlang.org"
366 | source: hosted
367 | version: "2.1.3"
368 | recase:
369 | dependency: "direct dev"
370 | description:
371 | name: recase
372 | url: "https://pub.dartlang.org"
373 | source: hosted
374 | version: "3.0.0"
375 | rxdart:
376 | dependency: transitive
377 | description:
378 | name: rxdart
379 | url: "https://pub.dartlang.org"
380 | source: hosted
381 | version: "0.24.1"
382 | shelf:
383 | dependency: transitive
384 | description:
385 | name: shelf
386 | url: "https://pub.dartlang.org"
387 | source: hosted
388 | version: "0.7.9"
389 | shelf_web_socket:
390 | dependency: transitive
391 | description:
392 | name: shelf_web_socket
393 | url: "https://pub.dartlang.org"
394 | source: hosted
395 | version: "0.2.3"
396 | source_gen:
397 | dependency: "direct dev"
398 | description:
399 | name: source_gen
400 | url: "https://pub.dartlang.org"
401 | source: hosted
402 | version: "0.9.6"
403 | source_span:
404 | dependency: transitive
405 | description:
406 | name: source_span
407 | url: "https://pub.dartlang.org"
408 | source: hosted
409 | version: "1.7.0"
410 | stack_trace:
411 | dependency: transitive
412 | description:
413 | name: stack_trace
414 | url: "https://pub.dartlang.org"
415 | source: hosted
416 | version: "1.9.5"
417 | stream_channel:
418 | dependency: transitive
419 | description:
420 | name: stream_channel
421 | url: "https://pub.dartlang.org"
422 | source: hosted
423 | version: "2.0.0"
424 | stream_transform:
425 | dependency: transitive
426 | description:
427 | name: stream_transform
428 | url: "https://pub.dartlang.org"
429 | source: hosted
430 | version: "1.2.0"
431 | string_scanner:
432 | dependency: transitive
433 | description:
434 | name: string_scanner
435 | url: "https://pub.dartlang.org"
436 | source: hosted
437 | version: "1.0.5"
438 | supercharged_dart:
439 | dependency: "direct main"
440 | description:
441 | name: supercharged_dart
442 | url: "https://pub.dartlang.org"
443 | source: hosted
444 | version: "1.2.0"
445 | term_glyph:
446 | dependency: transitive
447 | description:
448 | name: term_glyph
449 | url: "https://pub.dartlang.org"
450 | source: hosted
451 | version: "1.1.0"
452 | timing:
453 | dependency: transitive
454 | description:
455 | name: timing
456 | url: "https://pub.dartlang.org"
457 | source: hosted
458 | version: "0.1.1+2"
459 | typed_data:
460 | dependency: transitive
461 | description:
462 | name: typed_data
463 | url: "https://pub.dartlang.org"
464 | source: hosted
465 | version: "1.2.0"
466 | watcher:
467 | dependency: transitive
468 | description:
469 | name: watcher
470 | url: "https://pub.dartlang.org"
471 | source: hosted
472 | version: "0.9.7+15"
473 | web_socket_channel:
474 | dependency: transitive
475 | description:
476 | name: web_socket_channel
477 | url: "https://pub.dartlang.org"
478 | source: hosted
479 | version: "1.1.0"
480 | xml:
481 | dependency: transitive
482 | description:
483 | name: xml
484 | url: "https://pub.dartlang.org"
485 | source: hosted
486 | version: "4.5.0"
487 | yaml:
488 | dependency: "direct main"
489 | description:
490 | name: yaml
491 | url: "https://pub.dartlang.org"
492 | source: hosted
493 | version: "2.2.1"
494 | sdks:
495 | dart: ">=2.10.0-0.0 <3.0.0"
496 |
--------------------------------------------------------------------------------
/pubspec.yaml:
--------------------------------------------------------------------------------
1 | name: frameit_chrome
2 | version: 1.0.0
3 | description: >-
4 | Embed app store and play store screenshots in device frames.
5 | Drop in replacement for fastlane frameit.
6 | homepage: https://github.com/authpass/frameit-chrome
7 |
8 | executables:
9 | frameit_chrome: frameit_chrome
10 |
11 | environment:
12 | sdk: ">=2.8.0 <3.0.0"
13 |
14 | dependencies:
15 | meta: '>=1.0.0 <2.0.0'
16 | args: ^1.6.0
17 | yaml: ^2.2.1
18 | logging: '>=0.11.3+2 <1.0.0'
19 | logging_appenders: ^0.4.2+5
20 | image: ^2.1.14
21 | # (Small) utility packages
22 | quiver: ">=2.0.0 <3.0.0"
23 | path: ^1.7.0
24 | json_annotation: ^3.0.1
25 | archive: ^2.0.13
26 | supercharged_dart: ^1.2.0
27 |
28 | dev_dependencies:
29 | pedantic: ^1.9.2
30 | json_serializable: ^3.4.1
31 | build_runner: ^1.10.2
32 | builder_static_text: ^0.0.1+2
33 | source_gen: ^0.9.6
34 | build: ">=1.3.0 <2.0.0"
35 | glob: ^1.2.0
36 | recase: ^3.0.0
37 |
--------------------------------------------------------------------------------
/tool/builder.dart:
--------------------------------------------------------------------------------
1 | import 'package:build/build.dart';
2 | import 'package:source_gen/source_gen.dart';
3 |
4 | import 'src/asset_bundler.dart';
5 |
6 | extension on BuilderOptions {
7 | String requireConfig(String name) {
8 | final ret = config[name] as String;
9 | if (ret == null) {
10 | throw StateError(
11 | 'Please specify `filePattern` $config (tried to get $name)');
12 | }
13 | return ret;
14 | }
15 | }
16 |
17 | Builder assetBundler(BuilderOptions options) => SharedPartBuilder([
18 | AssetBundler(
19 | // dartFile: options.requireConfig('dartFile'),
20 | filePattern: options.requireConfig('filePattern'),
21 | ),
22 | ], 'assetBundler');
23 |
--------------------------------------------------------------------------------
/tool/src/asset_bundler.dart:
--------------------------------------------------------------------------------
1 | import 'dart:async';
2 | import 'dart:convert';
3 |
4 | import 'package:archive/archive.dart';
5 | import 'package:build/build.dart';
6 | import 'package:glob/glob.dart';
7 | import 'package:meta/meta.dart';
8 | import 'package:recase/recase.dart';
9 | import 'package:source_gen/source_gen.dart';
10 |
11 | class AssetBundler extends Generator {
12 | AssetBundler({@required this.filePattern});
13 |
14 | // final String dartFile;
15 | final String filePattern;
16 |
17 | @override
18 | FutureOr generate(LibraryReader library, BuildStep buildStep) async {
19 | // print('bundle for ${buildStep.inputId.path} ?');
20 | // if (!buildStep.inputId.path.endsWith(dartFile)) {
21 | // return null;
22 | // }
23 | // print('looking for $filePattern');
24 | final ret = StringBuffer('''
25 | class _Asset {
26 | const _Asset(this.fileName, this.bytes);
27 | final String fileName;
28 | final String bytes;
29 | }
30 |
31 |
32 | class _Assets {
33 | ''');
34 |
35 | final assetList = [];
36 | await for (final asset in buildStep.findAssets(Glob(filePattern))) {
37 | // print('should bundle ${asset.path}');
38 | final name = asset.path.camelCase;
39 | final bytes = await buildStep.readAsBytes(asset);
40 | final compressed = BZip2Encoder().encode(bytes);
41 | final base64 = base64Encode(compressed);
42 | ret.writeln(
43 | '''static const $name = _Asset('${asset.path}', '$base64');''');
44 | assetList.add(name);
45 | }
46 |
47 | ret.writeln('static const all = [${assetList.join(',')}];');
48 |
49 | ret.writeln('}');
50 | return ret.toString();
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
28 |
29 |
--------------------------------------------------------------------------------
/example/metadata/framed/en-US/samsung-galaxy-s10-plus-appbar_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/authpass/frameit-chrome/1350fcac7d53831a60ebf212c74f75647a85f9cb/example/metadata/framed/en-US/samsung-galaxy-s10-plus-appbar_menu.png
--------------------------------------------------------------------------------
/example/metadata/framed/en-US/samsungapps-samsung-galaxy-s10-plus-appbar_menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/authpass/frameit-chrome/1350fcac7d53831a60ebf212c74f75647a85f9cb/example/metadata/framed/en-US/samsungapps-samsung-galaxy-s10-plus-appbar_menu.png
--------------------------------------------------------------------------------
/lib/src/config.dart:
--------------------------------------------------------------------------------
1 | import 'dart:io';
2 |
3 | import 'package:json_annotation/json_annotation.dart';
4 | import 'package:path/path.dart' as path;
5 | import 'package:yaml/yaml.dart';
6 |
7 | part 'config.g.dart';
8 |
9 | @JsonSerializable(anyMap: true)
10 | class FrameConfig {
11 | FrameConfig({
12 | @JsonKey(nullable: true) this.rewrite,
13 | @JsonKey(nullable: true) this.images,
14 | });
15 | factory FrameConfig.fromJson(Map json) => _$FrameConfigFromJson(json);
16 |
17 | static const FILE_NAME = 'frameit.yaml';
18 |
19 | Map