feat: add defineConfig helper (#1551)

Co-authored-by: Raine Revere <[email protected]>

Author: danielpza

README.md

@@ -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.

src/index.ts

@@ -23,6 +23,9 @@ import { PackageInfo } from './types/PackageInfo'
 import { RunOptions } from './types/RunOptions'
 import { VersionSpec } from './types/VersionSpec'
 
+export { default as defineConfig } from './lib/defineConfig'
+export type { RcOptions } from './types/RcOptions'
+
 // allow prompt injection from environment variable for testing purposes
 if (process.env.INJECT_PROMPTS) {
   prompts.inject(JSON.parse(process.env.INJECT_PROMPTS))

src/lib/defineConfig.ts

@@ -0,0 +1,11 @@
+import type { RcOptions } from '../types/RcOptions'
+
+/**
+ * TypeScript helper for .npmrc config file. Similar to vite and eslint's
+ * defineConfig helper
+ */
+function defineConfig(config: RcOptions) {
+  return config
+}
+
+export default defineConfig