Commit 72b6eb8c authored by Jonathan's avatar Jonathan Committed by Dan Abramov
Browse files

Cleaning up printHostingInstructions a bit (#3036)

* Replacing literal 'build' with `buildFolder` variable

* Cleaning up the printHostingInstructions a bit

* Fixing undefined variable
parent c162920e
3 merge requests!12191Lim.Pisey.168:/Identified - We are currently investigating reports of missing build logs. The issue has been identified and a resolution is in progress. We will provide a further update when available.Mar 21, 09:02 UTC,!12853brikk,!5717Automatically extract project file structure from build bundle file
Showing with 73 additions and 86 deletions
+73 -86
...@@ -19,60 +19,32 @@ function printHostingInstructions( ...@@ -19,60 +19,32 @@ function printHostingInstructions(
buildFolder, buildFolder,
useYarn useYarn
) { ) {
const publicPathname = url.parse(publicPath).pathname; if (publicUrl && publicUrl.includes('.github.io/')) {
if (publicUrl && publicUrl.indexOf('.github.io/') !== -1) {
// "homepage": "http://user.github.io/project" // "homepage": "http://user.github.io/project"
console.log( const publicPathname = url.parse(publicPath).pathname;
`The project was built assuming it is hosted at ${chalk.green( const hasDeployScript = typeof appPackage.scripts.deploy !== 'undefined';
publicPathname printBaseMessage(buildFolder, publicPathname);
)}.`
); printDeployInstructions(publicUrl, hasDeployScript, useYarn);
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();
} else if (publicPath !== '/') { } else if (publicPath !== '/') {
// "homepage": "http://mywebsite.com/project" // "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( console.log(
`The project was built assuming it is hosted at ${chalk.green( `The project was built assuming it is hosted at ${chalk.green(
publicPath hostingLocation || 'the server root'
)}.` )}.`
); );
console.log( console.log(
...@@ -80,57 +52,72 @@ function printHostingInstructions( ...@@ -80,57 +52,72 @@ function printHostingInstructions(
'homepage' 'homepage'
)} field in your ${chalk.cyan('package.json')}.` )} field in your ${chalk.cyan('package.json')}.`
); );
console.log();
console.log(`The ${chalk.cyan('build')} folder is ready to be deployed.`); if (!hostingLocation) {
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')}.`
);
console.log('For example, add this to build it for GitHub Pages:'); console.log('For example, add this to build it for GitHub Pages:');
console.log(); console.log();
console.log( console.log(
` ${chalk.green('"homepage"')} ${chalk.cyan(':')} ${chalk.green( ` ${chalk.green('"homepage"')} ${chalk.cyan(':')} ${chalk.green(
'"http://myname.github.io/myapp"' '"http://myname.github.io/myapp"'
)}${chalk.cyan(',')}` )}${chalk.cyan(',')}`
); );
console.log();
} }
console.log();
console.log( console.log(
`The ${chalk.cyan(buildFolder)} folder is ready to be deployed.` `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`)) { function printDeployInstructions(publicUrl, hasDeployScript, useYarn) {
if (useYarn) { console.log(`To publish it at ${chalk.green(publicUrl)}, run:`);
console.log(` ${chalk.cyan('yarn')} global add serve`); console.log();
} else {
console.log(` ${chalk.cyan('npm')} install -g serve`); // 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();
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; module.exports = printHostingInstructions;
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment