feat: add declaration (#624)

* feat: add declaration * chore: lint * chore: change pos * chore: changeset --------- Co-authored-by: luhc228 <[email protected]>
ice-lab · Feb 2, 2024 · e099923 · e099923
1 parent af38e3c
commit e099923
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 18 deletions.
diff --git a/.changeset/fluffy-penguins-buy.md b/.changeset/fluffy-penguins-buy.md
@@ -0,0 +1,5 @@
+---
+'@ice/pkg': patch
+---
+
+feat: add declaration user config
diff --git a/packages/pkg/src/config/userConfig.ts b/packages/pkg/src/config/userConfig.ts
@@ -74,6 +74,11 @@ function getUserConfig() {
       validation: 'boolean',
       default: false,
     },
+    {
+      name: 'declaration',
+      validation: 'boolean',
+      default: true,
+    },
     // TODO: validate values recursively
     {
       name: 'transform',

diff --git a/packages/pkg/src/helpers/getRollupOptions.ts b/packages/pkg/src/helpers/getRollupOptions.ts
@@ -72,15 +72,17 @@ export function getRollupOptions(
   );
 
   if (taskConfig.type === 'transform') {
-    rollupOptions.plugins.unshift(
-      dtsPlugin({
-        rootDir,
-        entry: taskConfig.entry as Record<string, string>,
-        generateTypesForJs: userConfig.generateTypesForJs,
-        alias: taskConfig.alias,
-        outputDir: taskConfig.outputDir,
-      }),
-    );
+    if (userConfig.declaration) {
+      rollupOptions.plugins.unshift(
+        dtsPlugin({
+          rootDir,
+          entry: taskConfig.entry as Record<string, string>,
+          generateTypesForJs: userConfig.generateTypesForJs,
+          alias: taskConfig.alias,
+          outputDir: taskConfig.outputDir,
+        }),
+      );
+    }
     rollupOptions.plugins.push(transformAliasPlugin(rootDir, taskConfig.alias));
   } else if (taskConfig.type === 'bundle') {
     const [external, globals] = getExternalsAndGlobals(taskConfig, pkg as PkgJson);

diff --git a/packages/pkg/src/types.ts b/packages/pkg/src/types.ts
@@ -100,9 +100,9 @@ export interface BundleUserConfig {
 
 export interface UserConfig {
   /**
-  * Entry for a task
-  * @default  `./src/index`
-  */
+   * Entry for a task
+   * @default  `./src/index`
+   */
   entry?: RollupOptions['input'];
   /**
    * Alias to file system paths
@@ -114,17 +114,23 @@ export interface UserConfig {
    */
   define?: PlainObject;
   /**
-  * - true to generate a sourcemap for the code and include it in the result object.
-  * - "inline" to generate a sourcemap and append it as a data URL to the end of the code,
-  * but not include it in the result object.
+   * - true to generate a sourcemap for the code and include it in the result object.
+   * - "inline" to generate a sourcemap and append it as a data URL to the end of the code,
+   * but not include it in the result object.
    */
   sourceMaps?: boolean | 'inline';
   /**
-  * Whether or not to generate declaration files for Ecmascript
-  * @default false
-  */
+   * Whether or not to generate declaration files for Ecmascript
+   * @default false
+   */
   generateTypesForJs?: boolean;
 
+  /**
+   * Generate .d.ts files from TypeScript files in your project.
+   * @default true
+   */
+  declaration?: boolean;
+
   /**
    * Configure JSX transform type.
    * @default 'automatic'