Skip to content
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

Jump to bottom

Cleaning up printHostingInstructions a bit #3036

Merged
merged 3 commits into from
Jan 9, 2018
Merged

Cleaning up printHostingInstructions a bit #3036

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51aaf3a
Replacing literal 'build' with `buildFolder` variable
Aug 31, 2017
9b208a6
Cleaning up the printHostingInstructions a bit
Aug 31, 2017
c67617b
Fixing undefined variable
Aug 31, 2017
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
159 changes: 73 additions & 86 deletions packages/react-dev-utils/printHostingInstructions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,118 +21,105 @@ function printHostingInstructions(
buildFolder,
useYarn
) {
const publicPathname = url.parse(publicPath).pathname;
if (publicUrl && publicUrl.indexOf('.github.io/') !== -1) {
if (publicUrl && publicUrl.includes('.github.io/')) {
// "homepage": "http://user.github.io/project"
console.log(
`The project was built assuming it is hosted at ${chalk.green(
publicPathname
)}.`
);
console.log(
`You can control this with the ${chalk.green(
'homepage'
)} field in your ${chalk.cyan('package.json')}.`
);
console.log();
console.log(`The ${chalk.cyan('build')} folder is ready to be deployed.`);
console.log(`To publish it at ${chalk.green(publicUrl)}, run:`);
// If script deploy has been added to package.json, skip the instructions
if (typeof appPackage.scripts.deploy === 'undefined') {
console.log();
if (useYarn) {
console.log(` ${chalk.cyan('yarn')} add --dev gh-pages`);
} else {
console.log(` ${chalk.cyan('npm')} install --save-dev gh-pages`);
}
console.log();
console.log(
`Add the following script in your ${chalk.cyan('package.json')}.`
);
console.log();
console.log(` ${chalk.dim('// ...')}`);
console.log(` ${chalk.yellow('"scripts"')}: {`);
console.log(` ${chalk.dim('// ...')}`);
console.log(
` ${chalk.yellow('"predeploy"')}: ${chalk.yellow(
'"npm run build",'
)}`
);
console.log(
` ${chalk.yellow('"deploy"')}: ${chalk.yellow(
'"gh-pages -d build"'
)}`
);
console.log(' }');
console.log();
console.log('Then run:');
}
console.log();
console.log(` ${chalk.cyan(useYarn ? 'yarn' : 'npm')} run deploy`);
console.log();
const publicPathname = url.parse(publicPath).pathname;
const hasDeployScript = typeof appPackage.scripts.deploy !== 'undefined';
printBaseMessage(buildFolder, publicPathname);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whitespace can be removed (and below too)

printDeployInstructions(publicUrl, hasDeployScript, useYarn);

} else if (publicPath !== '/') {
// "homepage": "http://mywebsite.com/project"
printBaseMessage(buildFolder, publicPath);

} else {
// "homepage": "http://mywebsite.com"
// or no homepage
printBaseMessage(buildFolder, publicUrl);

printStaticServerInstructions(buildFolder, useYarn);
}
console.log();
}

function printBaseMessage(buildFolder, hostingLocation) {
console.log(
`The project was built assuming it is hosted at ${chalk.green(
publicPath
hostingLocation || 'the server root'
)}.`
);
console.log(
`You can control this with the ${chalk.green(
'homepage'
)} field in your ${chalk.cyan('package.json')}.`
);
console.log();
console.log(`The ${chalk.cyan('build')} folder is ready to be deployed.`);
console.log();
} else {
if (publicUrl) {
// "homepage": "http://mywebsite.com"
console.log(
`The project was built assuming it is hosted at ${chalk.green(
publicUrl
)}.`
);
console.log(
`You can control this with the ${chalk.green(
'homepage'
)} field in your ${chalk.cyan('package.json')}.`
);
console.log();
} else {
// no homepage
console.log(
'The project was built assuming it is hosted at the server root.'
);
console.log(
`To override this, specify the ${chalk.green(
'homepage'
)} in your ${chalk.cyan('package.json')}.`
);

if (!hostingLocation) {
console.log('For example, add this to build it for GitHub Pages:');
console.log();

console.log(
` ${chalk.green('"homepage"')} ${chalk.cyan(':')} ${chalk.green(
'"http://myname.github.io/myapp"'
)}${chalk.cyan(',')}`
);
console.log();
}
console.log();

console.log(
`The ${chalk.cyan(buildFolder)} folder is ready to be deployed.`
);
console.log('You may serve it with a static server:');
console.log();
if (!fs.existsSync(`${globalModules}/serve`)) {
if (useYarn) {
console.log(` ${chalk.cyan('yarn')} global add serve`);
} else {
console.log(` ${chalk.cyan('npm')} install -g serve`);
}
}

function printDeployInstructions(publicUrl, hasDeployScript, useYarn) {
console.log(`To publish it at ${chalk.green(publicUrl)}, run:`);
console.log();

// If script deploy has been added to package.json, skip the instructions
if (!hasDeployScript) {
if (useYarn) {
console.log(` ${chalk.cyan('yarn')} add --dev gh-pages`);
} else {
console.log(` ${chalk.cyan('npm')} install --save-dev gh-pages`);
}
console.log(` ${chalk.cyan('serve')} -s ${buildFolder}`);
console.log();

console.log(`Add the following script in your ${chalk.cyan(
'package.json'
)}.`);
console.log();

console.log(` ${chalk.dim('// ...')}`);
console.log(` ${chalk.yellow('"scripts"')}: {`);
console.log(` ${chalk.dim('// ...')}`);
console.log(` ${chalk.yellow('"predeploy"')}: ${chalk.yellow(
'"npm run build",'
)}`);
console.log(` ${chalk.yellow('"deploy"')}: ${chalk.yellow(
'"gh-pages -d build"'
)}`);
console.log(' }');
console.log();

console.log('Then run:');
console.log();
}
console.log(` ${chalk.cyan(useYarn ? 'yarn' : 'npm')} run deploy`);
}

function printStaticServerInstructions(buildFolder, useYarn) {
console.log('You may serve it with a static server:');
console.log();

if (!fs.existsSync(`${globalModules}/serve`)) {
if (useYarn) {
console.log(` ${chalk.cyan('yarn')} global add serve`);
} else {
console.log(` ${chalk.cyan('npm')} install -g serve`);
}
}
console.log(` ${chalk.cyan('serve')} -s ${buildFolder}`);
}

module.exports = printHostingInstructions;