Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
acoates-ms wants to merge 2 commits into from
Closed

Allow out of tree platforms to provide customized saveAssets experiences #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74231ec
feat: Add saveAssetsPlugin for custom platform saveAsset behavior
acoates-ms Jul 5, 2023
205f2c5
update schema
acoates-ms Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/cli-config/src/schema.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
t.string(),
t.object({
npmPackageName: t.string().optional(),
saveAssetsPlugin: t.string().optional(),
dependencyConfig: t.func(),
projectConfig: t.func(),
linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
t.string(),
t.object({
npmPackageName: t.string().optional(),
saveAssetsPlugin: t.string().optional(),
dependencyConfig: t.func(),
projectConfig: t.func(),
linkConfig: t.func(),
Expand Down
14 changes: 7 additions & 7 deletions packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
it('removes everything but 2x and 3x for iOS', () => {
expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
1,
2,
3,
]);
expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
});

it('keeps closest largest one if nothing matches', () => {
expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
expect(filterPlatformAssetScales('ios', [])).toEqual([]);
expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
});

it('keeps all scales for unknown platform', () => {
expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
1,
1.5,
2,
Expand Down
12 changes: 6 additions & 6 deletions packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
* @emails oncall+javascript_foundation
*/

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
httpServerLocation: '/assets/test',
};

expect(getAssetDestPathIOS(asset, 1)).toBe(
expect(getAssetDestPath(asset, 1)).toBe(
path.normalize('assets/test/icon.png'),
);
});
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
httpServerLocation: '/assets/test',
};

expect(getAssetDestPathIOS(asset, 2)).toBe(
expect(getAssetDestPath(asset, 2)).toBe(
path.normalize('assets/test/icon@2x.png'),
);
expect(getAssetDestPathIOS(asset, 3)).toBe(
expect(getAssetDestPath(asset, 3)).toBe(
path.normalize('assets/test/icon@3x.png'),
);
});
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
httpServerLocation: '/assets/../../test',
};

expect(getAssetDestPathIOS(asset, 1)).toBe(
expect(getAssetDestPath(asset, 1)).toBe(
path.normalize('assets/__test/icon.png'),
);
});
Expand Down
38 changes: 37 additions & 1 deletion packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
config: args.config,
});

return buildBundleWithConfig(args, config, output);
let saveAssetsPlugin =
ctx.platforms[args.platform] &&
ctx.platforms[args.platform].saveAssetsPlugin
? require(require.resolve(
ctx.platforms[args.platform].saveAssetsPlugin!,
{
paths: [ctx.root],
},
))
: undefined;

return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
args: CommandLineArgs,
config: ConfigT,
output: typeof outputBundle = outputBundle,
saveAssetsPlugin: (
assets: ReadonlyArray<AssetData>,
platform: string,
assetsDest: string | undefined,
assetCatalogDest: string | undefined,
addAssetToCopy: (
asset: AssetData,
allowedScales: number[] | undefined,
getAssetDestPath: (asset: AssetData, scale: number) => string,
) => void,
) => void,
) {
if (config.resolver.platforms.indexOf(args.platform) === -1) {
logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
bundleType: 'todo',
});

if (!saveAssetsPlugin) {
saveAssetsPlugin =
args.platform === 'ios'
? saveAssetsIOS
: args.platform === 'android'
? saveAssetsAndroid
: saveAssetsDefault;
}

// When we're done saving bundle output and the assets, we're done.
return await saveAssets(
outputAssets,
args.platform,
args.assetsDest,
args.assetCatalogDest,
saveAssetsPlugin,
);
} finally {
server.end();
Expand Down
7 changes: 1 addition & 6 deletions packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
*
*/

const ALLOWED_SCALES: {[key: string]: number[]} = {
ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
const whitelist: number[] = ALLOWED_SCALES[platform];
if (!whitelist) {
return scales;
}
Expand Down
4 changes: 2 additions & 2 deletions ...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
const suffix = scale === 1 ? '' : `@${scale}x`;
const fileName = `${asset.name + suffix}.${asset.type}`;
return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
);
}

export default getAssetDestPathIOS;
export default getAssetDestPath;
69 changes: 25 additions & 44 deletions packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
cleanAssetCatalog,
getImageSet,
isCatalogAsset,
writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
[src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
platform: string,
assetsDest: string | undefined,
assetCatalogDest: string | undefined,
saveAssetsPlugin: (
assets: ReadonlyArray<AssetData>,
platform: string,
assetsDest: string | undefined,
assetCatalogDest: string | undefined,
addAssetToCopy: (
asset: AssetData,
allowedScales: number[] | undefined,
getAssetDestPath: (asset: AssetData, scale: number) => string,
) => void,
) => void,
) {
if (!assetsDest) {
logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

const getAssetDestPath =
platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

const addAssetToCopy = (asset: AssetData) => {
const addAssetToCopy = (
asset: AssetData,
allowedScales: number[] | undefined,
getAssetDestPath: (asset: AssetData, scale: number) => string,
) => {
const validScales = new Set(
filterPlatformAssetScales(platform, asset.scales),
filterPlatformAssetScales(allowedScales, asset.scales),
);

asset.scales.forEach((scale, idx) => {
asset.scales.forEach((scale: number, idx: number) => {
if (!validScales.has(scale)) {
return;
}
Expand All@@ -55,36 +59,13 @@ function saveAssets(
});
};

if (platform === 'ios' && assetCatalogDest != null) {
// Use iOS Asset Catalog for images. This will allow Apple app thinning to
// remove unused scales from the optimized bundle.
const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
if (!fs.existsSync(catalogDir)) {
logger.error(
`Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
);
return;
}

logger.info('Adding images to asset catalog', catalogDir);
cleanAssetCatalog(catalogDir);
for (const asset of assets) {
if (isCatalogAsset(asset)) {
const imageSet = getImageSet(
catalogDir,
asset,
filterPlatformAssetScales(platform, asset.scales),
);
writeImageSet(imageSet);
} else {
addAssetToCopy(asset);
}
}
logger.info('Done adding images to asset catalog');
} else {
assets.forEach(addAssetToCopy);
}

saveAssetsPlugin(
assets,
platform,
assetsDest,
assetCatalogDest,
addAssetToCopy,
);
return copyAll(filesToCopy);
}

Expand Down
28 changes: 28 additions & 0 deletions packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
assets: ReadonlyArray<AssetData>,
_platform: string,
_assetsDest: string | undefined,
_assetCatalogDest: string | undefined,
addAssetToCopy: (
asset: AssetData,
allowedScales: number[] | undefined,
getAssetDestPath: (asset: AssetData, scale: number) => string,
) => void,
) {
assets.forEach((asset) =>
addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
);
}

export default saveAssetsAndroid;
26 changes: 26 additions & 0 deletions packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
assets: ReadonlyArray<AssetData>,
_platform: string,
_assetsDest: string | undefined,
_assetCatalogDest: string | undefined,
addAssetToCopy: (
asset: AssetData,
allowedScales: number[] | undefined,
getAssetDestPath: (asset: AssetData, scale: number) => string,
) => void,
) {
assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Allow out of tree platforms to provide customized saveAssets experiences#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

acoates-ms
wants to merge
2
commits into

from

 Closed


Allow out of tree platforms to provide customized saveAssets experiences
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74231ec

feat: Add saveAssetsPlugin for custom platform saveAsset behavior


acoates-ms Jul 5, 2023
205f2c5

update schema


acoates-ms Jul 5, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
packages/cli-config/src/schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ export const dependencyConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand DownExpand Up@@ -180,6 +181,7 @@ export const projectConfig = t
 t.string(),
 t.object({
 npmPackageName: t.string().optional(),
 saveAssetsPlugin: t.string().optional(),
 dependencyConfig: t.func(),
 projectConfig: t.func(),
 linkConfig: t.func(),
Expand Down

14 changes: 7 additions & 7 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/filterPlatformAssetScales-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,23 +14,23 @@ jest.dontMock('../filterPlatformAssetScales').dontMock('../assetPathUtils');

describe('filterPlatformAssetScales', () => {
 it('removes everything but 2x and 3x for iOS', () => {
 expect(filterPlatformAssetScales('ios', [1, 1.5, 2, 3, 4])).toEqual([
 expect(filterPlatformAssetScales([1, 2, 3], [1, 1.5, 2, 3, 4])).toEqual([
 1,
 2,
 3,
 ]);
 expect(filterPlatformAssetScales('ios', [3, 4])).toEqual([3]);
 expect(filterPlatformAssetScales([1, 2, 3], [3, 4])).toEqual([3]);
 });

 it('keeps closest largest one if nothing matches', () => {
 expect(filterPlatformAssetScales('ios', [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales('ios', [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales('ios', [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales('ios', [])).toEqual([]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 4, 100])).toEqual([4]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5, 100])).toEqual([100]);
 expect(filterPlatformAssetScales([1, 2, 3], [0.5])).toEqual([0.5]);
 expect(filterPlatformAssetScales([1, 2, 3], [])).toEqual([]);
 });

 it('keeps all scales for unknown platform', () => {
 expect(filterPlatformAssetScales('freebsd', [1, 1.5, 2, 3.7])).toEqual([
 expect(filterPlatformAssetScales(undefined, [1, 1.5, 2, 3.7])).toEqual([
 1,
 1.5,
 2,
Expand Down

12 changes: 6 additions & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/__tests__/getAssetDestPathIOS-test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 * @emails oncall+javascript_foundation
 */

import getAssetDestPathIOS from '../getAssetDestPathIOS';
import getAssetDestPath from '../getAssetDestPath';

jest.dontMock('../getAssetDestPathIOS');
jest.dontMock('../getAssetDestPath');

const path = require('path');

Expand All@@ -22,7 +22,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/test/icon.png'),
 );
 });
Expand All@@ -34,10 +34,10 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/test',
 };

 expect(getAssetDestPathIOS(asset, 2)).toBe(
 expect(getAssetDestPath(asset, 2)).toBe(
 path.normalize('assets/test/icon@2x.png'),
 );
 expect(getAssetDestPathIOS(asset, 3)).toBe(
 expect(getAssetDestPath(asset, 3)).toBe(
 path.normalize('assets/test/icon@3x.png'),
 );
 });
Expand All@@ -49,7 +49,7 @@ describe('getAssetDestPathIOS', () => {
 httpServerLocation: '/assets/../../test',
 };

 expect(getAssetDestPathIOS(asset, 1)).toBe(
 expect(getAssetDestPath(asset, 1)).toBe(
 path.normalize('assets/__test/icon.png'),
 );
 });
Expand Down

38 changes: 37 additions & 1 deletion
packages/cli-plugin-metro/src/commands/bundle/buildBundle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,10 @@ import type {Config} from '@react-native-community/cli-types';
import saveAssets from './saveAssets';
import {default as loadMetroConfig} from '../../tools/loadMetroConfig';
import {logger} from '@react-native-community/cli-tools';
import type {AssetData} from 'metro';
import saveAssetsAndroid from './saveAssetsAndroid';
import saveAssetsDefault from './saveAssetsDefault';
import saveAssetsIOS from './saveAssetsIOS';

interface RequestOptions {
 entryFile: string;
Expand All@@ -38,7 +42,18 @@ async function buildBundle(
 config: args.config,
 });

 return buildBundleWithConfig(args, config, output);
 let saveAssetsPlugin =
 ctx.platforms[args.platform] &&
 ctx.platforms[args.platform].saveAssetsPlugin
 ? require(require.resolve(
 ctx.platforms[args.platform].saveAssetsPlugin!,
 {
 paths: [ctx.root],
 },
 ))
 : undefined;

 return buildBundleWithConfig(args, config, output, saveAssetsPlugin);
}

/**
Expand All@@ -50,6 +65,17 @@ export async function buildBundleWithConfig(
 args: CommandLineArgs,
 config: ConfigT,
 output: typeof outputBundle = outputBundle,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (config.resolver.platforms.indexOf(args.platform) === -1) {
 logger.error(
Expand DownExpand Up@@ -100,12 +126,22 @@ export async function buildBundleWithConfig(
 bundleType: 'todo',
 });

 if (!saveAssetsPlugin) {
 saveAssetsPlugin =
 args.platform === 'ios'
 ? saveAssetsIOS
 : args.platform === 'android'
 ? saveAssetsAndroid
 : saveAssetsDefault;
 }

 // When we're done saving bundle output and the assets, we're done.
 return await saveAssets(
 outputAssets,
 args.platform,
 args.assetsDest,
 args.assetCatalogDest,
 saveAssetsPlugin,
 );
 } finally {
 server.end();
Expand Down

7 changes: 1 addition & 6 deletions
packages/cli-plugin-metro/src/commands/bundle/filterPlatformAssetScales.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,10 @@
 *
 */

const ALLOWED_SCALES: {[key: string]: number[]} = {
 ios: [1, 2, 3],
};

function filterPlatformAssetScales(
platform: string,
whitelist: ReadonlyArray<number> | undefined,
 scales: ReadonlyArray<number>,
): ReadonlyArray<number> {
 const whitelist: number[] = ALLOWED_SCALES[platform];
 if (!whitelist) {
 return scales;
 }
Expand Down

4 changes: 2 additions & 2 deletions
...rc/commands/bundle/getAssetDestPathIOS.ts → ...o/src/commands/bundle/getAssetDestPath.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
import path from 'path';
import {PackagerAsset} from './assetPathUtils';

function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
function getAssetDestPath(asset: PackagerAsset, scale: number): string {
 const suffix = scale === 1 ? '' : `@${scale}x`;
 const fileName = `${asset.name + suffix}.${asset.type}`;
 return path.join(
Expand All@@ -21,4 +21,4 @@ function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
 );
}

export default getAssetDestPathIOS;
export default getAssetDestPath;

69 changes: 25 additions & 44 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssets.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,7 @@ import {logger} from '@react-native-community/cli-tools';
import fs from 'fs';
import type {AssetData} from 'metro';
import path from 'path';
import {
 cleanAssetCatalog,
 getImageSet,
 isCatalogAsset,
 writeImageSet,
} from './assetCatalogIOS';
import filterPlatformAssetScales from './filterPlatformAssetScales';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';
import getAssetDestPathIOS from './getAssetDestPathIOS';

interface CopiedFiles {
 [src: string]: string;
Expand All@@ -29,6 +21,17 @@ function saveAssets(
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 saveAssetsPlugin: (
 assets: ReadonlyArray<AssetData>,
 platform: string,
 assetsDest: string | undefined,
 assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
 ) => void,
) {
 if (!assetsDest) {
 logger.warn('Assets destination folder is not set, skipping...');
Expand All@@ -37,15 +40,16 @@ function saveAssets(

 const filesToCopy: CopiedFiles = Object.create(null); // Map src -> dest

 const getAssetDestPath =
 platform === 'android' ? getAssetDestPathAndroid : getAssetDestPathIOS;

 const addAssetToCopy = (asset: AssetData) => {
 const addAssetToCopy = (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => {
 const validScales = new Set(
 filterPlatformAssetScales(platform, asset.scales),
 filterPlatformAssetScales(allowedScales, asset.scales),
 );

 asset.scales.forEach((scale, idx) => {
 asset.scales.forEach((scale: number, idx: number) => {
 if (!validScales.has(scale)) {
 return;
 }
Expand All@@ -55,36 +59,13 @@ function saveAssets(
 });
 };

 if (platform === 'ios' && assetCatalogDest != null) {
 // Use iOS Asset Catalog for images. This will allow Apple app thinning to
 // remove unused scales from the optimized bundle.
 const catalogDir = path.join(assetCatalogDest, 'RNAssets.xcassets');
 if (!fs.existsSync(catalogDir)) {
 logger.error(
 `Could not find asset catalog 'RNAssets.xcassets' in ${assetCatalogDest}. Make sure to create it if it does not exist.`,
 );
 return;
 }

 logger.info('Adding images to asset catalog', catalogDir);
 cleanAssetCatalog(catalogDir);
 for (const asset of assets) {
 if (isCatalogAsset(asset)) {
 const imageSet = getImageSet(
 catalogDir,
 asset,
 filterPlatformAssetScales(platform, asset.scales),
 );
 writeImageSet(imageSet);
 } else {
 addAssetToCopy(asset);
 }
 }
 logger.info('Done adding images to asset catalog');
 } else {
 assets.forEach(addAssetToCopy);
 }

 saveAssetsPlugin(
 assets,
 platform,
 assetsDest,
 assetCatalogDest,
 addAssetToCopy,
 );
 return copyAll(filesToCopy);
}

Expand Down

28 changes: 28 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsAndroid.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPathAndroid from './getAssetDestPathAndroid';

function saveAssetsAndroid(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) =>
 addAssetToCopy(asset, undefined, getAssetDestPathAndroid),
 );
}

export default saveAssetsAndroid;

26 changes: 26 additions & 0 deletions
packages/cli-plugin-metro/src/commands/bundle/saveAssetsDefault.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

import type {AssetData} from 'metro';
import getAssetDestPath from './getAssetDestPath';

function saveAssetsDefault(
 assets: ReadonlyArray<AssetData>,
 _platform: string,
 _assetsDest: string | undefined,
 _assetCatalogDest: string | undefined,
 addAssetToCopy: (
 asset: AssetData,
 allowedScales: number[] | undefined,
 getAssetDestPath: (asset: AssetData, scale: number) => string,
 ) => void,
) {
 assets.forEach((asset) => addAssetToCopy(asset, undefined, getAssetDestPath));
}

export default saveAssetsDefault;
Loading