Deprecated: Output an informational message for deprecation when no v…

…ersion provided When there is no `options.version` param provided `deprecated` method outputs an informational message to the Web Console rather than warns as previously.
WordPress · Jul 26, 2019 · 2d304fc · 2d304fc
1 parent c402014
commit 2d304fc
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/packages/deprecated/CHANGELOG.md b/packages/deprecated/CHANGELOG.md
@@ -1,3 +1,9 @@
+## Master
+
+### Breaking Change
+
+- When there is no `options.version` param provided `deprecated` method outputs an informational message to the Web Console rather than warns as previously.
+
 ## 2.0.4 (2019-01-03)
 
 ## 2.0.0 (2018-09-05)

diff --git a/packages/deprecated/src/index.js b/packages/deprecated/src/index.js
@@ -46,11 +46,11 @@ export default function deprecated( feature, options = {} ) {
 	} = options;
 
 	const pluginMessage = plugin ? ` from ${ plugin }` : '';
-	const versionMessage = version ? `${ pluginMessage } in ${ version }` : '';
+	const versionMessage = version ? ` and will be removed${ pluginMessage } in ${ version }` : '';
 	const useInsteadMessage = alternative ? ` Please use ${ alternative } instead.` : '';
 	const linkMessage = link ? ` See: ${ link }` : '';
 	const hintMessage = hint ? ` Note: ${ hint }` : '';
-	const message = `${ feature } is deprecated and will be removed${ versionMessage }.${ useInsteadMessage }${ linkMessage }${ hintMessage }`;
+	const message = `${ feature } is deprecated${ versionMessage }.${ useInsteadMessage }${ linkMessage }${ hintMessage }`;
 
 	// Skip if already logged.
 	if ( message in logged ) {
@@ -71,8 +71,13 @@ export default function deprecated( feature, options = {} ) {
 	 */
 	doAction( 'deprecated', feature, options, message );
 
-	// eslint-disable-next-line no-console
-	console.warn( message );
+	if ( version ) {
+		// eslint-disable-next-line no-console
+		console.warn( message );
+	} else {
+		// eslint-disable-next-line no-console
+		console.info( message );
+	}
 
 	logged[ message ] = true;
 }
diff --git a/packages/deprecated/src/test/index.js b/packages/deprecated/src/test/index.js
@@ -18,8 +18,8 @@ describe( 'deprecated', () => {
 	it( 'should show a deprecation warning', () => {
 		deprecated( 'Eating meat' );
 
-		expect( console ).toHaveWarnedWith(
-			'Eating meat is deprecated and will be removed.'
+		expect( console ).toHaveInformedWith(
+			'Eating meat is deprecated.'
 		);
 	} );
 
@@ -81,15 +81,15 @@ describe( 'deprecated', () => {
 		deprecated( 'Eating meat' );
 		deprecated( 'Eating meat' );
 
-		expect( console ).toHaveWarned();
+		expect( console ).toHaveInformed();
 		// eslint-disable-next-line no-console
-		expect( console.warn ).toHaveBeenCalledTimes( 1 );
+		expect( console.info ).toHaveBeenCalledTimes( 1 );
 	} );
 
 	it( 'should do an action', () => {
 		deprecated( 'turkey', { alternative: 'tofurky' } );
 
-		expect( console ).toHaveWarned();
+		expect( console ).toHaveInformed();
 		expect( didAction( 'deprecated' ) ).toBeTruthy();
 	} );
 } );