fix: dropping unused notice keys

voxpelli · Mar 10, 2024 · 28f68dc · 28f68dc
1 parent 149eabd
commit 28f68dc
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ const { installedCheck } = await import('installed-check-core');
 ## Syntax
 
 ```javascript
-const { errors, warnings, notices } = await installedCheck({
+const { errors, warnings } = await installedCheck({
   path: 'path/to/module',
   engineCheck: true,
   engineIgnores: ['foo'],
@@ -58,7 +58,6 @@ A Promise resolving to:
 
 ```javascript
 {
-  notices: ['123'],
   warnings: ['Abc'],
   errors: ['Xyz']
 };

diff --git a/index.js b/index.js
@@ -9,7 +9,6 @@ import { checkEngineVersions } from './lib/check-engine-versions.js';
  * @typedef InstalledCheckResult
  * @property {string[]} errors
  * @property {string[]} warnings
- * @property {string[]} notices
  */
 
 /**
@@ -85,5 +84,5 @@ export async function installedCheck (options) {
     warnings = [...warnings, ...engineResult.warnings];
   }
 
-  return { errors, warnings, notices: [] };
+  return { errors, warnings };
 }
diff --git a/lib/check-engine-versions.js b/lib/check-engine-versions.js
@@ -4,7 +4,7 @@ import { checkVersionRanges } from './check-version-ranges.js.js';
  * @param {import('read-pkg').NormalizedPackageJson} mainPackage
  * @param {Map<string, import('list-installed').NormalizedPackageJson>} installedDependencies
  * @param {Omit<import('./check-version-ranges.js.js').VersionRangesOptions, 'expectedInDependencies'>} options
- * @returns {{ errors: string[], warnings: string[], notices: string[] }}
+ * @returns {{ errors: string[], warnings: string[] }}
  */
 export function checkEngineVersions (mainPackage, installedDependencies, options) {
   /** @type {string[]} */
@@ -50,6 +50,5 @@ export function checkEngineVersions (mainPackage, installedDependencies, options
   return {
     errors: [...new Set(errors), ...summaries],
     warnings: [...new Set(warnings)],
-    notices: [],
   };
 }
diff --git a/test/main.spec.js b/test/main.spec.js
@@ -54,7 +54,6 @@ describe('installedCheck()', () => {
       })
         .should.eventually.deep.equal({
           errors: [],
-          notices: [],
           warnings: [],
         });
     });
@@ -67,7 +66,6 @@ describe('installedCheck()', () => {
       })
         .should.eventually.deep.equal({
           errors: [],
-          notices: [],
           warnings: [],
         });
     });
@@ -89,7 +87,6 @@ describe('installedCheck()', () => {
             'Combined "engines.node" needs to be narrower: >=10.0.0',
             'Combined "engines.abc" needs to be narrower: >=1.0.0',
           ],
-          notices: [],
           warnings: [
             "invalid-alias-syntax: Invalid npm alias. Can't match against dependency version",
             "invalid-dependency-definition: Target version is empty. Can't match against dependency version",
@@ -118,7 +115,6 @@ describe('installedCheck()', () => {
             'foo: Narrower "engines.node" is needed: >=8.0.0',
             'Combined "engines.node" needs to be narrower: >=8.0.0',
           ],
-          notices: [],
           warnings: [
             'Missing "engines.node" in main package',
           ],
@@ -136,7 +132,6 @@ describe('installedCheck()', () => {
             'foo: Incompatible "engines.node" requirement: <6.0.0',
             'Incompatible combined "engines.node" requirements.',
           ],
-          notices: [],
           warnings: [],
         });
     });