feat: add license plugin

Author: anncwb

.github/semantic.yml

@@ -0,0 +1,13 @@
+titleAndCommits: true
+types:
+  - feat
+  - fix
+  - docs
+  - chore
+  - style
+  - refactor
+  - perf
+  - test
+  - build
+  - ci
+  - revert

internal/node-utils/package.json

@@ -31,6 +31,7 @@
     "@changesets/git": "^3.0.0",
     "@manypkg/get-packages": "^2.2.1",
     "consola": "^3.2.3",
+    "dayjs": "^1.11.11",
     "find-up": "^7.0.0",
     "nanoid": "^5.0.7",
     "pkg-types": "^1.1.1",

internal/node-utils/src/date.ts

@@ -0,0 +1,10 @@
+import dayjs from 'dayjs';
+import timezone from 'dayjs/plugin/timezone';
+import utc from 'dayjs/plugin/utc';
+
+dayjs.extend(utc);
+dayjs.extend(timezone);
+
+const dateUtil = dayjs().tz('Asia/Shanghai');
+
+export { dateUtil };

internal/node-utils/src/index.ts

@@ -1,13 +1,9 @@
-export { UNICODE } from './constants';
+export * from './constants';
+export * from './date';
 export * from './git';
 export { add as gitAdd, getStagedFiles } from './git';
 export { generatorContentHash } from './hash';
-export {
-  findMonorepoRoot,
-  getPackage,
-  getPackages,
-  getPackagesSync,
-} from './monorepo';
+export * from './monorepo';
 export { toPosixPath } from './path';
 export { prettierFormat } from './prettier';
 export type { Package } from '@manypkg/get-packages';

internal/vite-config/src/config/application.ts

@@ -25,6 +25,7 @@ function defineApplicationConfig(options: DefineApplicationOptions = {}) {
       i18n: true,
       injectAppLoading: true,
       isBuild,
+      license: true,
       mock: true,
       mode,
       pwa: true,

internal/vite-config/src/plugins/extra-app-config.ts

@@ -1,11 +1,11 @@
+import type { PluginOption } from 'vite';
+
 import {
   colors,
   generatorContentHash,
   readPackageJSON,
 } from '@vben/node-utils';
 
-import { type PluginOption } from 'vite';
-
 import { getEnvConfig } from '../utils/env';
 
 interface PluginOptions {

internal/vite-config/src/plugins/index.ts

@@ -27,6 +27,7 @@ import viteVueDevTools from 'vite-plugin-vue-devtools';
 import { viteExtraAppConfigPlugin } from './extra-app-config';
 import { viteImportMapPlugin } from './importmap';
 import { viteInjectAppLoadingPlugin } from './inject-app-loading';
+import { viteLicensePlugin } from './license';
 
 /**
  * 获取条件成立的 vite 插件
@@ -94,12 +95,12 @@ async function getApplicationConditionPlugins(
     compress,
     compressTypes,
     extraAppConfig,
-
     html,
     i18n,
     importmap,
     importmapOptions,
     injectAppLoading,
+    license,
     mock,
     pwa,
     pwaOptions,
@@ -130,6 +131,10 @@ async function getApplicationConditionPlugins(
       condition: injectAppLoading,
       plugins: async () => [await viteInjectAppLoadingPlugin(!!isBuild, env)],
     },
+    {
+      condition: license,
+      plugins: async () => [await viteLicensePlugin()],
+    },
     {
       condition: pwa,
       plugins: () =>

internal/vite-config/src/plugins/license.ts

@@ -0,0 +1,76 @@
+import type {
+  NormalizedOutputOptions,
+  OutputAsset,
+  OutputBundle,
+  OutputChunk,
+} from 'rollup';
+import type { PluginOption } from 'vite';
+
+import { EOL } from 'node:os';
+
+import { dateUtil, readPackageJSON } from '@vben/node-utils';
+
+/**
+ * 用于将配置文件抽离出来并注入到项目中
+ * @returns
+ */
+
+async function viteLicensePlugin(
+  root = process.cwd(),
+): Promise<PluginOption | undefined> {
+  const {
+    description = '',
+    homepage = '',
+    version = '',
+  } = await readPackageJSON(root);
+
+  return {
+    apply: 'build',
+    enforce: 'post',
+    generateBundle: {
+      handler: (_options: NormalizedOutputOptions, bundle: OutputBundle) => {
+        const date = dateUtil.format('YYYY-MM-DD ');
+
+        const copyrightText = `/*!
+  * Vben Admin Pro
+  * Version: ${version}
+  * Author: vben
+  * Copyright (C) 2024 Vben
+  * License: MIT License
+  * Description: ${description}
+  * Date Created: ${date}
+  * Homepage: ${homepage}
+  * Contact: ann.vben@gmail.com
+*/
+              `.trim();
+
+        for (const [, fileContent] of Object.entries(bundle)) {
+          if (
+            fileContent.type === 'asset' ||
+            (fileContent.type === 'chunk' && fileContent.isEntry)
+          ) {
+            const chunkContent = fileContent as OutputChunk;
+            const assetContent = fileContent as OutputAsset;
+            // 插入版权信息
+            const content =
+              typeof assetContent.source === 'string'
+                ? assetContent.source
+                : chunkContent.code;
+            const updatedContent = `${copyrightText}${EOL}${content}`;
+
+            // 更新bundle
+            if (assetContent.source === undefined) {
+              (fileContent as OutputChunk).code = updatedContent;
+            } else {
+              (fileContent as OutputAsset).source = updatedContent;
+            }
+          }
+        }
+      },
+      order: 'post',
+    },
+    name: 'vite:license',
+  };
+}
+
+export { viteLicensePlugin };

internal/vite-config/src/typing.ts

@@ -67,6 +67,8 @@ interface ApplicationPluginOptions extends CommonPluginOptions {
   importmapOptions?: ImportmapPluginOptions;
   /** 是否注入app loading */
   injectAppLoading?: boolean;
+  /** 是否注入版权信息 */
+  license?: boolean;
   /** mock 插件配置 */
   mock?: boolean;
   /** 是否开启pwa */

package.json

@@ -83,8 +83,9 @@
   "packageManager": "pnpm@9.4.0",
   "pnpm": {
     "overrides": {
-      "@ctrl/tinycolor": "4.1.0",
-      "clsx": "2.1.1",
+      "@ant-design/colors": "^7.0.2",
+      "@ctrl/tinycolor": "^4.1.0",
+      "clsx": "^2.1.1",
       "vue": "^3.4.30"
     },
     "neverBuiltDependencies": [