npm-check-updates 18.2.0 → 18.3.0

package/README.md

@@ -219,7 +219,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
   </tr>
   <tr>
     <td>--deprecated</td>
-    <td>Include deprecated packages. Use <code>--no-deprecated</code> to exclude deprecated packages (uses more bandwidth). (default: true)</td>
+    <td>Include deprecated packages. Use <code>--no-deprecated</code> to exclude deprecated packages (20–25% slower). (default: true)</td>
   </tr>
   <tr>
     <td><a href="#doctor">-d, --doctor</a></td>
@@ -888,12 +888,24 @@ Some options offer more advanced configuration using a function definition. Thes
 For example, `.ncurc.js`:
 
 ```js
+/** @type {import('npm-check-updates').RcOptions } */
 module.exports = {
   upgrade: true,
   filter: name => name.startsWith('@myorg/'),
 }
 ```
 
+Alternatively, you can use the defineConfig helper which should provide intellisense without the need for jsdoc annotations:
+
+```js
+const { defineConfig } = require('npm-check-updates')
+
+module.exports = defineConfig({
+  upgrade: true,
+  filter: name => name.startsWith('@myorg/'),
+})
+```
+
 ### JSON Schema
 
 If you write `.ncurc` config files using json or yaml, you can add the JSON Schema to your IDE settings for completions.

package/build/index.d.ts

@@ -1,5 +1,11 @@
 import { SemVer } from 'semver-utils';
 
+/**
+ * TypeScript helper for .npmrc config file. Similar to vite and eslint's
+ * defineConfig helper
+ */
+export declare function defineConfig(config: RcOptions): RcOptions;
+
 /** Supported function for the --filter and --reject options. */
 declare type FilterFunction = (packageName: string, versionRange: SemVer[]) => boolean;
 
@@ -20,6 +26,9 @@ declare type NestedVersionSpecs = {
     [name: string]: VersionSpec | NestedVersionSpecs;
 };
 
+/** Options that would make no sense in a .ncurc file */
+declare type Nonsensical = 'configFileName' | 'configFilePath' | 'cwd' | 'packageData' | 'stdin';
+
 /** The relevant bits of a parsed package.json file. */
 declare interface PackageFile {
     dependencies?: Index<VersionSpec>;
@@ -45,6 +54,12 @@ declare interface PackageFileRepository {
     directory?: string;
 }
 
+/** Expected options that might be found in an .ncurc file. Since the config is external, this cannot be guaranteed */
+export declare type RcOptions = Omit<RunOptions, Nonsensical> & {
+    $schema?: string;
+    format?: string | string[];
+};
+
 /** Main entry point.
  *
  * @returns Promise<
@@ -97,7 +112,7 @@ export declare interface RunOptions {
      * @default ["prod","dev","optional","packageManager"]
      */
     dep?: string | readonly string[];
-    /** Include deprecated packages. Use `--no-deprecated` to exclude deprecated packages (uses more bandwidth).
+    /** Include deprecated packages. Use `--no-deprecated` to exclude deprecated packages (20–25% slower).
      *
      * @default true
      */