feat: filter package json field

Author: yjl9903

README.md

@@ -317,6 +317,24 @@ It exports the information of the current `package.json`.
 import { name, version } from '~build/package';
 ```
 
+You can also **control which fields should be exported**.
+
+```ts
+// vite.config.ts
+
+import Info from 'unplugin-info/vite';
+
+export default defineConfig({
+  plugins: [
+    Info({
+      package: {
+        dependencies: true
+      }
+    })
+  ]
+});
+```
+
 ## TypeScript
 
 If you did not rename the virtual module, custom exported fields, or use `~build/meta`, you can just add `unplugin-info/client` to your `tsconfig.json` types, or add `/// <reference types="unplugin-info/client" />` to your `.d.ts` file.

examples/vite/env.d.ts

@@ -45,6 +45,30 @@ declare module '~build/git' {
   export const isClean: boolean;
 }
 
+declare module '~build/package' {
+  /** Package name */
+  export const name: string;
+
+  /** Package version */
+  export const version: string;
+
+  /** Package description */
+  export const description: string;
+
+  /** Package keywords */
+  export const keywords: string[];
+
+  /** Package license */
+  export const license: string;
+
+  /** Package author */
+  export const author: string;
+
+  export const dependencies: Record<string, string>;
+
+  export const devDependencies: Record<string, string>;
+}
+
 declare module '~build/meta' {
   export const message: string;
 }

examples/vite/main.ts

@@ -18,8 +18,8 @@ import {
   isClean
 } from '~build/git';
 import { message } from '~build/meta';
-import { name, version } from '~build/package';
 import { isCI, name as ciName } from '~build/ci';
+import { name, version, dependencies, devDependencies } from '~build/package';
 
 import { format } from 'date-fns';
 
@@ -66,6 +66,10 @@ append('Message: ', message);
 
 append('Package name: ', name);
 append('Package version: ', version);
+append(
+  'Dependencies: ',
+  [...Object.entries(dependencies), ...Object.entries(devDependencies)].map((d) => d[0]).join(' ,')
+);
 append('', '');
 
 append('You can also open console and play around with it.', '');

examples/vite/vite.config.ts

@@ -12,6 +12,10 @@ export default defineConfig({
           return status.isClean();
         }
       },
+      package: {
+        dependencies: true,
+        devDependencies: true
+      },
       meta: { message: 'This is set from vite.config.ts' }
     })
   ]

src/core/index.ts

@@ -103,6 +103,21 @@ export const UnpluginInfo = createUnplugin<Options | undefined>((option) => {
         return body.join('\n');
       } else if (id === ModuleName.BuildPackage) {
         const pkg = JSON.parse(fs.readFileSync(path.join(root, 'package.json'), 'utf-8'));
+        const defaults = ['name', 'version', 'description', 'keywords', 'license', 'author'];
+        const keys = new Set(
+          Array.isArray(option?.package)
+            ? [...defaults, ...option.package]
+            : typeof option?.package === 'object'
+              ? Object.entries(
+                  Object.fromEntries([
+                    ...defaults.map((d) => [d, true] as const),
+                    ...Object.entries(option.package)
+                  ])
+                )
+                  .filter(([k, v]) => !!v)
+                  .map(([k, v]) => k)
+              : defaults
+        );
         const entries = Object.entries({
           name: '',
           version: '0.0.0',
@@ -111,9 +126,7 @@ export const UnpluginInfo = createUnplugin<Options | undefined>((option) => {
           license: '',
           author: '',
           ...pkg
-        }).filter(([key]) =>
-          ['name', 'version', 'description', 'keywords', 'license', 'author'].includes(key)
-        );
+        }).filter(([key]) => keys.has(key));
         return entries
           .map(([key, value]) => `export const ${key} = ${JSON.stringify(value, null, 2)};`)
           .join('\n');

src/core/types.ts

@@ -17,16 +17,21 @@ export interface Options {
   git?: Record<string, (git: SimpleGit) => Promise<any> | any>;
 
   /**
-   * Custom virtual module prefix
-   *
-   * @default '~build'
+   * Filter exported fields of package.json
    */
-  prefix?: string;
+  package?: string[] | Record<string, boolean | null | undefined>;
 
   /**
    * Pass some meta data to Vite app
    *
    * Notice: meta data will be serialized to JSON format
    */
   meta?: Record<string | number | symbol, any>;
+
+  /**
+   * Custom virtual module prefix
+   *
+   * @default '~build'
+   */
+  prefix?: string;
 }