Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

[config-plugins] create package #2956

Merged
merged 11 commits into from
Nov 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions packages/config-plugins/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2015-present 650 Industries, Inc. (aka Expo)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Advanced configuration
# Expo Config Plugins

@expo/config is a powerful tool for generating native app code from a unified JavaScript interface. Most basic functionality can be controlled by using the the [static Expo config](https://docs.expo.io/versions/latest/config/app/), but some features require manipulation of the native project files. To support complex behavior we've created config plugins, and mods (short for modifiers).
The Expo config is a powerful tool for generating native app code from a unified JavaScript interface. Most basic functionality can be controlled by using the the [static Expo config](https://docs.expo.io/versions/latest/config/app/), but some features require manipulation of the native project files. To support complex behavior we've created config plugins, and mods (short for modifiers).

> Here is a [colorful chart](https://whimsical.com/UjytoYXT2RN43LywvWExfK) for visual learners.

Expand Down
2 changes: 2 additions & 0 deletions packages/config-plugins/__mocks__/fs.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import { fs } from 'memfs';
module.exports = fs;
20 changes: 20 additions & 0 deletions packages/config-plugins/__mocks__/resolve-from.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = require(require.resolve('resolve-from'));

module.exports.silent = (fromDirectory, request) => {
const fs = require('fs');
const path = require('path');
try {
fromDirectory = fs.realpathSync(fromDirectory);
} catch (error) {
if (error.code === 'ENOENT') {
fromDirectory = path.resolve(fromDirectory);
} else {
return;
}
}

const outputPath = path.join(fromDirectory, 'node_modules', request);
if (fs.existsSync(outputPath)) {
return outputPath;
}
};
8 changes: 8 additions & 0 deletions packages/config-plugins/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
const path = require('path');

module.exports = {
preset: '../../jest/unit-test-config',
rootDir: path.resolve(__dirname),
displayName: require('./package').name,
roots: ['__mocks__', 'src'],
};
56 changes: 56 additions & 0 deletions packages/config-plugins/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"name": "@expo/config-plugins",
"version": "1.0.0",
"description": "A library for Expo config plugins",
"main": "build/index.js",
"scripts": {
"watch": "tsc --watch",
"build": "tsc",
"prepare": "yarn run clean && yarn build",
"clean": "rimraf build ./tsconfig.tsbuildinfo",
"lint": "eslint .",
"test": "jest"
},
"repository": {
"type": "git",
"url": "https://github.com/expo/expo-cli.git",
"directory": "packages/config-plugins"
},
"keywords": [
"json",
"expo",
"react-native",
"react"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/expo/expo-cli/issues"
},
"homepage": "https://github.com/expo/expo-cli/tree/master/packages/config-plugins#readme",
"files": [
"build",
"paths"
],
"dependencies": {
"@expo/config-types": "^40.0.0-beta.1",
"@expo/configure-splash-screen": "0.2.1",
"@expo/image-utils": "0.3.7",
"@expo/json-file": "8.2.24",
"@expo/plist": "0.0.10",
"fs-extra": "9.0.0",
"glob": "7.1.6",
"slash": "^3.0.0",
"slugify": "^1.3.4",
"xcode": "^2.1.0",
"xml2js": "^0.4.23"
},
"devDependencies": {
"@types/fs-extra": "^9.0.1",
"@types/xml2js": "^0.4.5",
"memfs": "^2.15.5",
"rimraf": "^3.0.2"
},
"publishConfig": {
"access": "public"
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin } from '../plugins/android-plugins';
import { AndroidManifest, getMainApplication, StringBoolean } from './Manifest';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin } from '../plugins/android-plugins';
import {
addMetaDataItemToMainApplication,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { ExpoConfig } from '../Config.types';
import { assert } from '../Errors';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin, createStringsXmlPlugin } from '../plugins/android-plugins';
import { assert } from '../utils/errors';
import {
addMetaDataItemToMainApplication,
AndroidManifest,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin } from '../plugins/android-plugins';
import {
addMetaDataItemToMainApplication,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin } from '../plugins/android-plugins';
import {
addMetaDataItemToMainApplication,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
import { ExpoConfig } from '@expo/config-types';
import fs from 'fs-extra';
import { resolve } from 'path';

import { ExpoConfig } from '../Config.types';
import { ConfigPlugin } from '../Plugin.types';
import { addWarningAndroid } from '../WarningAggregator';
import {
withAppBuildGradle,
withDangerousAndroidMod,
withProjectBuildGradle,
} from '../plugins/android-plugins';
import { withAppBuildGradle, withProjectBuildGradle } from '../plugins/android-plugins';
import { withDangerousMod } from '../plugins/core-plugins';
import * as WarningAggregator from '../utils/warnings';

const DEFAULT_TARGET_PATH = './android/app/google-services.json';

Expand All @@ -23,7 +20,7 @@ export const withClassPath: ConfigPlugin = config => {
if (config.modResults.language === 'groovy') {
config.modResults.contents = setClassPath(config, config.modResults.contents);
} else {
addWarningAndroid(
WarningAggregator.addWarningAndroid(
'android-google-services',
`Cannot automatically configure project build.gradle if it's not groovy`
);
Expand All @@ -37,7 +34,7 @@ export const withApplyPlugin: ConfigPlugin = config => {
if (config.modResults.language === 'groovy') {
config.modResults.contents = applyPlugin(config, config.modResults.contents);
} else {
addWarningAndroid(
WarningAggregator.addWarningAndroid(
'android-google-services',
`Cannot automatically configure app build.gradle if it's not groovy`
);
Expand All @@ -50,10 +47,13 @@ export const withApplyPlugin: ConfigPlugin = config => {
* Add `google-services.json` to project
*/
export const withGoogleServicesFile: ConfigPlugin = config => {
return withDangerousAndroidMod(config, async config => {
await setGoogleServicesFile(config, config.modRequest.projectRoot);
return config;
});
return withDangerousMod(config, [
'android',
async config => {
await setGoogleServicesFile(config, config.modRequest.projectRoot);
return config;
},
]);
};

export function getGoogleServicesFilePath(config: Pick<ExpoConfig, 'android'>) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { ExpoConfig } from '@expo/config-types';
import { compositeImagesAsync, generateImageAsync } from '@expo/image-utils';
import fs from 'fs-extra';
import path from 'path';

import { ExpoConfig } from '../Config.types';
import { ConfigPlugin } from '../Plugin.types';
import { withDangerousAndroidMod } from '../plugins/android-plugins';
import { withDangerousMod } from '../plugins/core-plugins';
import * as Colors from './Colors';
import { buildResourceItem, readResourcesXMLAsync } from './Resources';
import { writeXMLAsync } from './XML';
Expand All @@ -31,10 +31,13 @@ const IC_LAUNCHER_XML = 'ic_launcher.xml';
const IC_LAUNCHER_ROUND_XML = 'ic_launcher_round.xml';

export const withIcons: ConfigPlugin = config => {
return withDangerousAndroidMod(config, async config => {
await setIconAsync(config, config.modRequest.projectRoot);
return config;
});
return withDangerousMod(config, [
'android',
async config => {
await setIconAsync(config, config.modRequest.projectRoot);
return config;
},
]);
};

export function getIcon(config: ExpoConfig) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import fs from 'fs-extra';
import path from 'path';

import { assert } from '../Errors';
import { assert } from '../utils/errors';
import * as XML from './XML';

export type StringBoolean = 'true' | 'false';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { ExpoConfig } from '../Config.types';
import { assert } from '../Errors';
import { ExpoConfig } from '@expo/config-types';

import { ConfigPlugin } from '../Plugin.types';
import { addWarningAndroid } from '../WarningAggregator';
import { createStringsXmlPlugin, withSettingsGradle } from '../plugins/android-plugins';
import { assert } from '../utils/errors';
import { addWarningAndroid } from '../utils/warnings';
import { buildResourceItem, readResourcesXMLAsync, ResourceXML } from './Resources';
import { getProjectStringsXMLPathAsync, removeStringItem, setStringItem } from './Strings';
import { writeXMLAsync } from './XML';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { ConfigPlugin } from '../Plugin.types';
import { addWarningAndroid } from '../WarningAggregator';
import { withDangerousAndroidMod } from '../plugins/android-plugins';
import { withDangerousMod } from '../plugins/core-plugins';
import * as WarningAggregator from '../utils/warnings';
import { getProjectColorsXMLPathAsync, setColorItem } from './Colors';
import { buildResourceItem, readResourcesXMLAsync } from './Resources';
import { getProjectStylesXMLPathAsync, setStylesItem } from './Styles';
Expand All @@ -11,10 +12,13 @@ const NAVIGATION_BAR_COLOR = 'navigationBarColor';
const WINDOW_LIGHT_NAVIGATION_BAR = 'android:windowLightNavigationBar';

export const withNavigationBar: ConfigPlugin = config => {
return withDangerousAndroidMod(config, async config => {
await setNavigationBarConfig(config, config.modRequest.projectRoot);
return config;
});
return withDangerousMod(config, [
'android',
async config => {
await setNavigationBarConfig(config, config.modRequest.projectRoot);
return config;
},
]);
};

export function getNavigationBarImmersiveMode(config: Pick<ExpoConfig, 'androidNavigationBar'>) {
Expand Down Expand Up @@ -45,7 +49,7 @@ export async function setNavigationBarConfig(

if (immersiveMode) {
// Immersive mode needs to be set programatically
addWarningAndroid(
WarningAggregator.addWarningAndroid(
'androidNavigationBar.visible',
'Hiding the navigation bar must be done programmatically. Refer to the Android documentation - https://developer.android.com/training/system-ui/immersive - for instructions.'
);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { createAndroidManifestPlugin } from '../plugins/android-plugins';
import { AndroidManifest, getMainActivityOrThrow } from './Manifest';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
import { ExpoConfig } from '@expo/config-types';
import fs from 'fs-extra';
import { sync as globSync } from 'glob';
import path from 'path';

import { ExpoConfig } from '../Config.types';
import { ConfigPlugin } from '../Plugin.types';
import { addWarningAndroid } from '../WarningAggregator';
import {
createAndroidManifestPlugin,
withAppBuildGradle,
withDangerousAndroidMod,
} from '../plugins/android-plugins';
import { createAndroidManifestPlugin, withAppBuildGradle } from '../plugins/android-plugins';
import { withDangerousMod } from '../plugins/core-plugins';
import * as WarningAggregator from '../utils/warnings';
import { AndroidManifest } from './Manifest';
import { getMainApplicationAsync } from './Paths';

Expand All @@ -23,7 +20,7 @@ export const withPackageGradle: ConfigPlugin = config => {
if (config.modResults.language === 'groovy') {
config.modResults.contents = setPackageInBuildGradle(config, config.modResults.contents);
} else {
addWarningAndroid(
WarningAggregator.addWarningAndroid(
'android-package',
`Cannot automatically configure app build.gradle if it's not groovy`
);
Expand All @@ -33,10 +30,13 @@ export const withPackageGradle: ConfigPlugin = config => {
};

export const withPackageRefactor: ConfigPlugin = config => {
return withDangerousAndroidMod(config, async config => {
await renamePackageOnDisk(config, config.modRequest.projectRoot);
return config;
});
return withDangerousMod(config, [
'android',
async config => {
await renamePackageOnDisk(config, config.modRequest.projectRoot);
return config;
},
]);
};

export function getPackage(config: Pick<ExpoConfig, 'android'>) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import fs from 'fs-extra';
import { sync as globSync } from 'glob';
import * as path from 'path';

import { assert } from '../Errors';
import { directoryExistsAsync } from '../Modules';
import { assert } from '../utils/errors';
import { directoryExistsAsync } from '../utils/modules';
import { ResourceKind } from './Resources';

export interface ProjectFile<L extends string = string> {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ExpoConfig } from '../Config.types';
import { ExpoConfig } from '@expo/config-types';

import { ConfigPlugin } from '../Plugin.types';
import { withAndroidManifest } from '../plugins/android-plugins';
import { AndroidManifest, ManifestUsesPermission } from './Manifest';
Expand Down
Loading