fix: deprecate --first-release and --release-count at shipjs prepare (#…

…447)

GUIDE.md

@@ -77,9 +77,10 @@ You can get an access token from [here](https://github.com/settings/tokens).
 Or you can simply run `hub api user`, follow the instruction and it will generate the token and write the config file for you.
 
 ### Before running Shipjs
+
 Shipjs compares previous version.
 
-Before running the `shipjs` commands, you need release first version by yourself.  
+Before running the `shipjs` commands, you need release first version by yourself.
 
 Let's release first version with [yarn version](https://yarnpkg.com/en/docs/cli/version) commands.
 
@@ -417,7 +418,7 @@ NAME
         shipjs prepare - Prepare a release.
 
 USAGE
-        shipjs prepare [--help] [--dir PATH] [--yes] [--first-release] [--release-count COUNT] [--dry-run]
+        shipjs prepare [--help] [--dir PATH] [--yes] [--dry-run]
 
 OPTIONS
         -h, --help
@@ -429,12 +430,6 @@ OPTIONS
         -y, --yes
           Skip all the interactive prompts and use the default values.
 
-        -f, --first-release
-          Generate the CHANGELOG for the first time
-
-        -r, --release-count COUNT
-          How many releases to be generated from the latest
-
         -D, --dry-run
           Displays the steps without actually doing them.
 ```

packages/shipjs/src/flow/prepare.js

@@ -20,6 +20,9 @@ import createPullRequest from '../step/prepare/createPullRequest';
 import notifyPrepared from '../step/prepare/notifyPrepared';
 import finished from '../step/finished';
 
+import { print } from '../util';
+import { warning } from '../color';
+
 async function prepare({
   help = false,
   dir = '.',
@@ -36,6 +39,7 @@ async function prepare({
   if (dryRun) {
     printDryRunBanner();
   }
+  printDeprecated({ firstRelease, releaseCount });
   checkHub();
   const config = loadConfig(dir);
   const { currentVersion, baseBranch } = validate({ config, dir });
@@ -97,6 +101,15 @@ const arg = {
   '-N': '--no-browse',
 };
 
+function printDeprecated({ firstRelease, releaseCount }) {
+  if (firstRelease) {
+    print(warning(`DEPRECATED: --first-release, -f`));
+  }
+  if (releaseCount) {
+    print(warning(`DEPRECATED: --release-count, -r`));
+  }
+}
+
 export default {
   arg,
   fn: prepare,

packages/shipjs/src/step/prepare/__tests__/printHelp.spec.js

@@ -13,7 +13,7 @@ describe('printHelp', () => {
       	shipjs prepare - Prepare a release.
 
       USAGE
-      	shipjs prepare [--help] [--dir PATH] [--yes] [--first-release] [--release-count COUNT] [--dry-run] [--no-browse]
+      	shipjs prepare [--help] [--dir PATH] [--yes] [--dry-run] [--no-browse]
 
       OPTIONS
       	-h, --help
@@ -25,12 +25,6 @@ describe('printHelp', () => {
       	-y, --yes
       	  Skip all the interactive prompts and use the default values.
 
-      	-f, --first-release
-      	  Generate the CHANGELOG for the first time
-
-      	-r, --release-count COUNT
-      	  How many releases to be generated from the latest
-
       	-D, --dry-run
       	  Displays the steps without actually doing them.
 

packages/shipjs/src/step/prepare/printHelp.js

@@ -9,13 +9,9 @@ export default () =>
     const help = `--help`;
     const dir = `--dir ${underline('PATH')}`;
     const yes = `--yes`;
-    const firstRelease = `--first-release`;
-    const releaseCount = `--release-count ${underline('COUNT')}`;
     const dryRun = `--dry-run`;
     const noBrowse = `--no-browse`;
-    const all = [help, dir, yes, firstRelease, releaseCount, dryRun, noBrowse]
-      .map(x => `[${x}]`)
-      .join(' ');
+    const all = [help, dir, yes, dryRun, noBrowse].map(x => `[${x}]`).join(' ');
 
     const messages = [
       bold('NAME'),
@@ -38,12 +34,6 @@ export default () =>
       indent(`-y, ${yes}`),
       indent('  Skip all the interactive prompts and use the default values.'),
       '',
-      indent(`-f, ${firstRelease}`),
-      indent('  Generate the CHANGELOG for the first time'),
-      '',
-      indent(`-r, ${releaseCount}`),
-      indent('  How many releases to be generated from the latest'),
-      '',
       indent(`-D, ${dryRun}`),
       indent('  Displays the steps without actually doing them.'),
       '',