feat: add dts plugin

.changeset/eighty-bobcats-switch.md

@@ -0,0 +1,5 @@
+---
+'@farmfe/js-plugin-dts': patch
+---
+
+feat: add dts plugins with farm

cspell.json

@@ -33,6 +33,7 @@
     "egui",
     "elems",
     "esbuild",
+    "importee",
     "execa",
     "farmfe",
     "Fock",
@@ -41,6 +42,7 @@
     "hasher",
     "idents",
     "jridgewell",
+    "kolorist",
     "libfarmfe",
     "libloading",
     "loglevel",

examples/generate-dts/farm.config.mjs

@@ -0,0 +1,39 @@
+import farmDtsPlugin from '@farmfe/js-plugin-dts';
+import { builtinModules } from 'module';
+
+/**
+ * @type {import('@farmfe/core').UserConfig}
+ */
+export default {
+  compilation: {
+    input: {
+      index: 'src/index.ts'
+    },
+    output: {
+      path: 'dist',
+      targetEnv: 'node'
+    },
+    external: [
+      ...builtinModules.map((m) => `^${m}$`),
+      ...builtinModules.map((m) => `^node:${m}$`)
+    ],
+    partialBundling: {
+      moduleBuckets: [
+        {
+          name: 'node.bundle.js',
+          test: ['.+']
+        }
+      ]
+    },
+    minify: false,
+    sourcemap: false,
+    presetEnv: false,
+    treeShaking: true
+  },
+  server: {
+    hmr: false
+  },
+  plugins: [farmDtsPlugin({
+    outputDir: 'build'
+  })]
+};

examples/generate-dts/generate.ts

@@ -0,0 +1,14 @@
+interface IExample {
+  name: string;
+  age: number;
+  obj: any;
+}
+
+export const example: IExample = {
+  name: 'test',
+  age: 1,
+  obj: {
+    a: 1,
+    b: 2
+  }
+};

examples/generate-dts/index.ts

@@ -0,0 +1,14 @@
+import { example } from './generate';
+import type { myTuple } from './type';
+interface obj {
+  name: string;
+  age: number;
+}
+const res: myTuple = [1, 2, 3, '4'];
+export const obj: obj = {
+  name: 'erkelost',
+  age: 18
+};
+console.log(obj);
+console.log(example, obj, res);
+export type { User } from './types';

examples/generate-dts/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "ts",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "@farmfe/cli": "workspace:*",
+    "@farmfe/core": "workspace:*",
+    "@farmfe/js-plugin-dts": "workspace:*",
+    "ts-morph": "^18.0.0"
+  },
+  "scripts": {
+    "build": "farm build",
+    "build:ts": "tsc"
+  }
+}

examples/generate-dts/src/bbb.ts

@@ -0,0 +1 @@
+export const a: string = 'erkelost';

examples/generate-dts/src/index.ts

@@ -0,0 +1,7 @@
+import type { TestBase } from './test';
+import { a } from './bbb';
+console.log(a);
+
+export interface Test extends TestBase {
+  count: number;
+}

examples/generate-dts/src/test.ts

@@ -0,0 +1,22 @@
+export interface TestBase {
+  name: string;
+}
+
+export interface Component {
+  name: string;
+  type: string;
+}
+
+export const test: TestBase = {
+  name: 'test'
+};
+
+export const CONSTANT = ['one', 'two'] as const;
+
+export interface WithConstant {
+  constant: typeof CONSTANT[number];
+}
+
+export function method(arg: string) {
+  console.log(arg);
+}

examples/generate-dts/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  // "extends": "../../tsconfig.base.json",
+  "exclude": ["node_modules"],
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "noUnusedParameters": false,
+    "noUnusedLocals": false,
+    "outDir": "dist",
+    "lib": ["DOM", "ESNext"],
+    "noImplicitAny": true,
+    "sourceMap": true,
+    "target": "es2020",
+    "module": "node16",
+    "moduleResolution": "node16",
+    "declaration": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+  }
+}

examples/generate-dts/type.ts

@@ -0,0 +1,3 @@
+export type myTuple = [number, number, number?, string?];
+const s: [string, string, boolean] = ['a', 'b', true];
+export { s };

examples/generate-dts/types.ts

@@ -0,0 +1,4 @@
+export interface User {
+  id: string,
+  name: string
+}

examples/react/farm.config.ts

@@ -26,9 +26,9 @@ export default defineConfig({
       prefixer: {
         targets: ['last 2 versions', 'Firefox ESR', '> 1%', 'ie >= 11']
       }
-    }
+    },
     // treeShaking: true,
-    // minify: true,
+    minify: false,
   },
   server: {
     hmr: true,

examples/vue/src/Main.vue

@@ -4,8 +4,6 @@
 
 <script lang="ts" setup>
 import Welcome from './components/Welcome.vue';
-import axios from 'axios';
-console.log(axios.create);
 fetch('/api')
   .then((response) => response.json())
   .then((json) => console.log(json));

js-plugins/solid/farm.config.ts → js-plugins/dts/farm.config.ts

@@ -5,15 +5,13 @@ import { builtinModules } from 'module';
  */
 export default {
   compilation: {
-    minify: false,
-    presetEnv: false,
     input: {
       index: './src/index.ts'
     },
     output: {
-      entryFilename: '[entryName].cjs',
-      targetEnv: 'node',
-      format: 'cjs'
+      path: 'build',
+      filename: 'index.[ext]',
+      targetEnv: 'node'
     },
     external: [
       ...builtinModules.map((m) => `^${m}$`),
@@ -22,11 +20,15 @@ export default {
     partialBundling: {
       moduleBuckets: [
         {
-          name: 'index.js',
+          name: 'node.bundle.js',
           test: ['.+']
         }
       ]
-    }
+    },
+    minify: false,
+    sourcemap: false,
+    presetEnv: false,
+    treeShaking: false
   },
   server: {
     hmr: false

js-plugins/dts/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@farmfe/js-plugin-dts",
+  "version": "0.1.0",
+  "description": "",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p ./tsconfig.build.json",
+    "build:farm": "farm build",
+    "start": "pnpm run build -w",
+    "watch": "farm watch",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "fast-glob": "^3.2.12",
+    "fs-extra": "^11.1.1",
+    "kolorist": "^1.8.0",
+    "ts-morph": "^19.0.0"
+  },
+  "devDependencies": {
+    "@farmfe/cli": "workspace:*",
+    "@farmfe/core": "workspace:*",
+    "@types/fs-extra": "^11.0.1"
+  }
+}