fix(publish): deprecate publish --require-scripts (#463)

lerna-lite · Jan 27, 2023 · e8ef54e · e8ef54e
1 parent 5cc0920
commit e8ef54e
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 2 deletions.
diff --git a/packages/cli/schemas/lerna-schema.json b/packages/cli/schemas/lerna-schema.json
@@ -1368,7 +1368,7 @@
         },
         "requireScripts": {
           "type": "boolean",
-          "description": "During `lerna publish`, when true, execute ./scripts/prepublish.js and ./scripts/postpublish.js, relative to package root."
+          "description": "@deprecated During `lerna publish`, when true, execute ./scripts/prepublish.js and ./scripts/postpublish.js, relative to package root."
         },
         "noGitReset": {
           "type": "boolean",

diff --git a/packages/cli/src/cli-commands/cli-publish-commands.ts b/packages/cli/src/cli-commands/cli-publish-commands.ts
@@ -189,6 +189,10 @@ export default {
           delete argv['npm-tag'];
           log.warn('deprecated', '--npm-tag has been renamed --dist-tag');
         }
+
+        if (argv.requireScripts) {
+          log.warn('deprecated', '--require-scripts has been deprecated and will be removed in next major');
+        }
         /* eslint-enable no-param-reassign */
 
         return argv;

diff --git a/packages/core/src/models/command-options.ts b/packages/core/src/models/command-options.ts
@@ -152,7 +152,7 @@ export interface PublishCommandOption extends VersionCommandOption {
   /** Remove fields from each package.json before publishing them to the registry, removing fields from a complex object is also supported via the dot notation (ie "scripts.build") */
   removePackageFields?: string[];
 
-  /** Execute ./scripts/prepublish.js and ./scripts/postpublish.js, relative to package root. */
+  /** @deprecated Execute ./scripts/prepublish.js and ./scripts/postpublish.js, relative to package root. */
   requireScripts?: boolean;
 
   /** Do not reset changes to working tree after publishing is complete. */

diff --git a/packages/publish/src/__tests__/publish-lifecycle-scripts.spec.ts b/packages/publish/src/__tests__/publish-lifecycle-scripts.spec.ts
@@ -196,6 +196,7 @@ describe('lifecycle scripts', () => {
   });
 });
 
+// @deprecated, execScript should be removed since requireScripts is deprecated
 describe('execScript', () => {
   it('execute --require-scripts but fails since scripts folder does not exist and log error with script not found message is shown', async () => {
     const cwd = await initFixture('lifecycle');

diff --git a/packages/publish/src/publish-command.ts b/packages/publish/src/publish-command.ts
@@ -156,6 +156,7 @@ export class PublishCommand extends Command<PublishCommandOption> {
       this.logger.info('canary', 'enabled');
     }
 
+    // @deprecated, to be removed in next major
     if (this.options.requireScripts) {
       this.logger.info('require-scripts', 'enabled');
     }
@@ -725,6 +726,7 @@ export class PublishCommand extends Command<PublishCommandOption> {
     });
   }
 
+  // @deprecated, see Lerna PR https://github.com/lerna/lerna/pull/1862/files
   execScript(pkg: Package, script: string) {
     const scriptLocation = path.join(pkg.location, 'scripts', script);