Skip to content

feat!: remove default build dir overrides #1310

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

Merged
merged 1 commit into from
May 28, 2023
Merged

feat!: remove default build dir overrides #1310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 25 additions & 12 deletions lib/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ module.exports.run = function (buildOpts) {
events.emit('log', `\tPlatform: ${buildOpts.device ? 'device' : 'emulator'}`);
events.emit('log', `\tTarget: ${emulatorTarget}`);

const buildOutputDir = path.join(projectPath, 'build', (buildOpts.device ? 'device' : 'emulator'));
const buildOutputDir = path.join(projectPath, 'build', `${configuration}-${(buildOpts.device ? 'iphoneos' : 'iphonesimulator')}`);

// remove the build/device folder before building
// remove the build output folder before building
fs.removeSync(buildOutputDir);

const xcodebuildArgs = getXcodeBuildArgs(projectName, projectPath, configuration, emulatorTarget, buildOpts);
Expand Down Expand Up @@ -264,7 +264,8 @@ module.exports.run = function (buildOpts) {
const exportOptionsPlist = plist.build(exportOptions);
const exportOptionsPath = path.join(projectPath, 'exportOptions.plist');

const buildOutputDir = path.join(projectPath, 'build', 'device');
const configuration = buildOpts.release ? 'Release' : 'Debug';
const buildOutputDir = path.join(projectPath, 'build', `${configuration}-iphoneos`);

function checkSystemRuby () {
const ruby_cmd = which.sync('ruby', { nothrow: true });
Expand Down Expand Up @@ -346,10 +347,16 @@ function getXcodeBuildArgs (projectName, projectPath, configuration, emulatorTar
'-archivePath', customArgs.archivePath || `${projectName}.xcarchive`
];
buildActions = ['archive'];
settings = [
customArgs.configuration_build_dir || `CONFIGURATION_BUILD_DIR=${path.join(projectPath, 'build', 'device')}`,
customArgs.shared_precomps_dir || `SHARED_PRECOMPS_DIR=${path.join(projectPath, 'build', 'sharedpch')}`
];
settings = [];

if (customArgs.configuration_build_dir) {
settings.push(customArgs.configuration_build_dir);
}

if (customArgs.shared_precomps_dir) {
settings.push(customArgs.shared_precomps_dir);
}

// Add other matched flags to otherFlags to let xcodebuild present an appropriate error.
// This is preferable to just ignoring the flags that the user has passed in.
if (customArgs.sdk) {
Expand All @@ -370,17 +377,23 @@ function getXcodeBuildArgs (projectName, projectPath, configuration, emulatorTar
}
} else { // emulator
options = [
'-workspace', customArgs.project || `${projectName}.xcworkspace`,
'-workspace', customArgs.workspace || `${projectName}.xcworkspace`,
'-scheme', customArgs.scheme || projectName,
'-configuration', customArgs.configuration || configuration,
'-sdk', customArgs.sdk || 'iphonesimulator',
'-destination', customArgs.destination || `platform=iOS Simulator,name=${emulatorTarget}`
];
buildActions = ['build'];
settings = [
customArgs.configuration_build_dir || `CONFIGURATION_BUILD_DIR=${path.join(projectPath, 'build', 'emulator')}`,
customArgs.shared_precomps_dir || `SHARED_PRECOMPS_DIR=${path.join(projectPath, 'build', 'sharedpch')}`
];
settings = [`SYMROOT=${path.join(projectPath, 'build')}`];

if (customArgs.configuration_build_dir) {
settings.push(customArgs.configuration_build_dir);
}

if (customArgs.shared_precomps_dir) {
settings.push(customArgs.shared_precomps_dir);
}

// Add other matched flags to otherFlags to let xcodebuild present an appropriate error.
// This is preferable to just ignoring the flags that the user has passed in.
if (customArgs.archivePath) {
Expand Down
7 changes: 4 additions & 3 deletions lib/run.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ module.exports.run = function (runOptions) {
}

let useDevice = !!runOptions.device;
const configuration = runOptions.release ? 'Release' : 'Debug';

return require('./listDevices').run()
.then(devices => {
Expand All @@ -60,8 +61,8 @@ module.exports.run = function (runOptions) {
}
}).then(() => build.findXCodeProjectIn(projectPath))
.then(projectName => {
let appPath = path.join(projectPath, 'build', 'emulator', `${projectName}.app`);
const buildOutputDir = path.join(projectPath, 'build', 'device');
let appPath = path.join(projectPath, 'build', `${configuration}-iphonesimulator`, `${projectName}.app`);
const buildOutputDir = path.join(projectPath, 'build', `${configuration}-iphoneos`);

// select command to run and arguments depending whether
// we're running on device/emulator
Expand Down Expand Up @@ -91,7 +92,7 @@ module.exports.run = function (runOptions) {
})
.then(
() => {
appPath = path.join(projectPath, 'build', 'device', `${projectName}.app`);
appPath = path.join(projectPath, 'build', `${configuration}-iphoneos`, `${projectName}.app`);
let extraArgs = [];
if (runOptions.argv) {
// argv.slice(2) removes node and run.js, filterSupportedArgs removes the run.js args
Expand Down
65 changes: 44 additions & 21 deletions tests/spec/unit/build.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,9 @@ describe('build', () => {
'generic/platform=iOS',
'-archivePath',
'TestProjectName.xcarchive',
'archive',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'device')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`
'archive'
]);
expect(args.length).toEqual(13);
expect(args.length).toEqual(11);
});

it('should generate appropriate args if buildFlags are passed in', () => {
Expand Down Expand Up @@ -93,11 +91,9 @@ describe('build', () => {
'generic/platform=iOS',
'-archivePath',
'TestProjectName.xcarchive',
'archive',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'device')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`
'archive'
]);
expect(args.length).toEqual(13);
expect(args.length).toEqual(11);
});

it('should generate appropriate args for simulator', () => {
Expand All @@ -114,10 +110,42 @@ describe('build', () => {
'-destination',
'platform=iOS Simulator,name=iPhone 5s',
'build',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'emulator')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`
`SYMROOT=${path.join(testProjectPath, 'build')}`
]);
expect(args.length).toEqual(13);
expect(args.length).toEqual(12);
});

it('should generate appropriate args for simulator if buildFlags are passed in', () => {
const buildFlags = [
'-workspace TestWorkspaceFlag',
'-scheme TestSchemeFlag',
'-configuration TestConfigurationFlag',
'-destination TestDestinationFlag',
'-archivePath TestArchivePathFlag',
'CONFIGURATION_BUILD_DIR=TestConfigBuildDirFlag',
'SHARED_PRECOMPS_DIR=TestSharedPrecompsDirFlag'
];

const args = getXcodeBuildArgs('TestProjectName', testProjectPath, 'TestConfiguration', 'iPhone 5s', { device: false, buildFlag: buildFlags });
expect(args).toEqual([
'-workspace',
'TestWorkspaceFlag',
'-scheme',
'TestSchemeFlag',
'-configuration',
'TestConfigurationFlag',
'-sdk',
'iphonesimulator',
'-destination',
'TestDestinationFlag',
'build',
`SYMROOT=${path.join(testProjectPath, 'build')}`,
'CONFIGURATION_BUILD_DIR=TestConfigBuildDirFlag',
'SHARED_PRECOMPS_DIR=TestSharedPrecompsDirFlag',
'-archivePath',
'TestArchivePathFlag'
]);
expect(args.length).toEqual(16);
});

it('should add matched flags that are not overriding for device', () => {
Expand All @@ -136,12 +164,10 @@ describe('build', () => {
'-archivePath',
'TestProjectName.xcarchive',
'archive',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'device')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`,
'-sdk',
'TestSdkFlag'
]);
expect(args.length).toEqual(15);
expect(args.length).toEqual(13);
});

it('should add matched flags that are not overriding for simulator', () => {
Expand All @@ -160,12 +186,11 @@ describe('build', () => {
'-destination',
'platform=iOS Simulator,name=iPhone 5s',
'build',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'emulator')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`,
`SYMROOT=${path.join(testProjectPath, 'build')}`,
'-archivePath',
'TestArchivePathFlag'
]);
expect(args.length).toEqual(15);
expect(args.length).toEqual(14);
});

it('should generate appropriate args for automatic provisioning', () => {
Expand Down Expand Up @@ -196,11 +221,9 @@ describe('build', () => {
'12345',
'-authenticationKeyIssuerID',
'00000000-0000-0000-0000-000000000000',
'archive',
`CONFIGURATION_BUILD_DIR=${path.join(testProjectPath, 'build', 'device')}`,
`SHARED_PRECOMPS_DIR=${path.join(testProjectPath, 'build', 'sharedpch')}`
'archive'
]);
expect(args.length).toEqual(20);
expect(args.length).toEqual(18);
});
});

Expand Down