@dazhicheng/common 1.0.4 → 1.0.5

package/.env

@@ -0,0 +1,20 @@
+# 【通用】环境变量
+
+#  版本号
+VITE_VERSION = 1.0.0
+
+
+# 应用部署基础路径（如部署在子目录 /admin，则设置为 /admin/）
+VITE_BASE_URL = /
+
+# 权限模式【 frontend 前端模式 / backend 后端模式 】
+VITE_ACCESS_MODE = backend
+
+# 跨域请求时是否携带 Cookie（开启前需确保后端支持）
+VITE_WITH_CREDENTIALS = false
+
+# 是否打开路由信息
+VITE_OPEN_ROUTE_INFO = false
+
+# 锁屏加密密钥
+VITE_LOCK_ENCRYPT_KEY = s3cur3k3y4adpro

package/.gitignore

@@ -1,4 +1,3 @@
-# base
 node_modules
 .DS_Store
 dist

package/.stylelintrc.cjs

@@ -1,76 +1,76 @@
-module.exports = {
-  extends: [
-    'stylelint-config-standard',
-    'stylelint-config-recommended-scss',
-    'stylelint-config-recommended-vue/scss',
-    'stylelint-config-html/vue',
-    'stylelint-config-recess-order',
-  ],
-  overrides: [
-    {
-      files: ['**/*.{vue,html}'],
-      customSyntax: 'postcss-html',
-    },
-    {
-      files: ['**/*.{css,scss}'],
-      customSyntax: 'postcss-scss',
-    },
-  ],
-  rules: {
-    'import-notation': 'string',
-    'selector-class-pattern': null,
-    'custom-property-pattern': null,
-    'keyframes-name-pattern': null,
-    'no-descending-specificity': null,
-    'no-empty-source': null,
-    'property-no-vendor-prefix': null,
-    'selector-pseudo-class-no-unknown': [
-      true,
-      {
-        ignorePseudoClasses: ['global', 'export', 'deep'],
-      },
-    ],
-    'property-no-unknown': [
-      true,
-      {
-        ignoreProperties: [],
-      },
-    ],
-    'at-rule-no-unknown': [
-      true,
-      {
-        ignoreAtRules: [
-          'apply',
-          'use',
-          'mixin',
-          'include',
-          'extend',
-          'each',
-          'if',
-          'else',
-          'for',
-          'while',
-          'reference',
-        ],
-      },
-    ],
-    'scss/at-rule-no-unknown': [
-      true,
-      {
-        ignoreAtRules: [
-          'apply',
-          'use',
-          'mixin',
-          'include',
-          'extend',
-          'each',
-          'if',
-          'else',
-          'for',
-          'while',
-          'reference',
-        ],
-      },
-    ],
-  },
-};
+module.exports = {
+  extends: [
+    'stylelint-config-standard',
+    'stylelint-config-recommended-scss',
+    'stylelint-config-recommended-vue/scss',
+    'stylelint-config-html/vue',
+    'stylelint-config-recess-order',
+  ],
+  overrides: [
+    {
+      files: ['**/*.{vue,html}'],
+      customSyntax: 'postcss-html',
+    },
+    {
+      files: ['**/*.{css,scss}'],
+      customSyntax: 'postcss-scss',
+    },
+  ],
+  rules: {
+    'import-notation': 'string',
+    'selector-class-pattern': null,
+    'custom-property-pattern': null,
+    'keyframes-name-pattern': null,
+    'no-descending-specificity': null,
+    'no-empty-source': null,
+    'property-no-vendor-prefix': null,
+    'selector-pseudo-class-no-unknown': [
+      true,
+      {
+        ignorePseudoClasses: ['global', 'export', 'deep'],
+      },
+    ],
+    'property-no-unknown': [
+      true,
+      {
+        ignoreProperties: [],
+      },
+    ],
+    'at-rule-no-unknown': [
+      true,
+      {
+        ignoreAtRules: [
+          'apply',
+          'use',
+          'mixin',
+          'include',
+          'extend',
+          'each',
+          'if',
+          'else',
+          'for',
+          'while',
+          'reference',
+        ],
+      },
+    ],
+    'scss/at-rule-no-unknown': [
+      true,
+      {
+        ignoreAtRules: [
+          'apply',
+          'use',
+          'mixin',
+          'include',
+          'extend',
+          'each',
+          'if',
+          'else',
+          'for',
+          'while',
+          'reference',
+        ],
+      },
+    ],
+  },
+};

package/nginx_dev.conf

@@ -0,0 +1,26 @@
+# HTTP 服务器 - 保持原有配置
+  server_name localhost;
+  charset utf-8;
+
+  root /usr/share/nginx/html;
+  index index.html;
+
+  location / {
+    try_files $uri $uri/ /index.html;
+    # CORS 配置
+    add_header 'Access-Control-Allow-Origin' '*' always;
+    add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS' always;
+    add_header 'Access-Control-Allow-Headers' 'Content-Type, Authorization' always;
+  }
+  
+  location /dev-api/ {
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-Ip $remote_addr;
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_pass http://116.6.49.180:11000/;
+  }
+  
+  error_page   500 502 503 504  /50x.html;
+  location = /50x.html {
+    root   html;
+  }

package/nginx_test.conf

@@ -0,0 +1,26 @@
+# HTTP 服务器 - 保持原有配置
+  server_name localhost;
+  charset utf-8;
+
+  root /usr/share/nginx/html;
+  index index.html;
+
+  location / {
+    try_files $uri $uri/ /index.html;
+    # CORS 配置
+    add_header 'Access-Control-Allow-Origin' '*' always;
+    add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS' always;
+    add_header 'Access-Control-Allow-Headers' 'Content-Type, Authorization' always;
+  }
+
+  location /test-api/ {
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-Ip $remote_addr;
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_pass http://116.6.49.180:11001/;
+  }
+
+  error_page   500 502 503 504  /50x.html;
+  location = /50x.html {
+    root   html;
+  }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@dazhicheng/common",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "共享配置文件",
   "type": "module",
+  "types": "./src/types/index.d.ts",
   "files": [
     "commitlint.config.cjs",
     ".husky",
@@ -11,20 +12,17 @@
     ".stylelintignore",
     ".gitignore",
     ".gitattributes",
+    ".env",
     "eslint.config.mjs",
     "tsconfig.json",
-    "tsconfig.web.json",
-    "Dockerfile"
+    "Dockerfile",
+    "nginx_dev.conf",
+    "nginx_test.conf",
+    "sync-common.mjs",
+    "src/types/index.d.ts"
   ],
   "exports": {
-    "./commitlint.config.cjs": "./commitlint.config.cjs",
-    "./.prettierrc": "./.prettierrc",
-    "./.stylelintrc.cjs": "./.stylelintrc.cjs",
-    "./.stylelintignore": "./.stylelintignore",
-    "./.gitignore": "./.gitignore",
-    "./.gitattributes": "./.gitattributes",
-    "./eslint.config.mjs": "./eslint.config.mjs",
-    "./tsconfig.json": "./tsconfig.json"
+    "./sync-common.mjs": "./sync-common.mjs"
   },
   "publishConfig": {
     "access": "public"

package/src/types/index.d.ts

@@ -0,0 +1 @@
+export {};

package/sync-common.mjs

@@ -0,0 +1,277 @@
+import fs from 'fs';
+import path from 'path';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const require = createRequire(import.meta.url);
+const commonDir = __dirname;
+
+const markerPattern = /^<<<(before|common|after)>>>$/gm;
+const textLikeFiles = new Set([
+  '.gitignore',
+  '.stylelintignore',
+  '.gitattributes',
+  '.prettierrc',
+  '.env',
+]);
+const directLikeFiles = new Set([
+  'Dockerfile',
+  'nginx_dev.conf',
+  'nginx_test.conf',
+  'commit-msg',
+  'pre-commit',
+  '.stylelintrc.cjs',
+  'commitlint.config.cjs',
+  'eslint.config.mjs',
+  'tsconfig.json',
+]);
+const defaultManagedFiles = [
+  '.gitignore',
+  '.stylelintignore',
+  '.gitattributes',
+  '.prettierrc',
+  '.env',
+  '.stylelintrc.cjs',
+  'commitlint.config.cjs',
+  'Dockerfile',
+  'eslint.config.mjs',
+  'tsconfig.json',
+  { name: 'nginx_dev.conf' },
+  { name: 'nginx_test.conf' },
+  { name: 'commit-msg', dir: '.husky' },
+  { name: 'pre-commit', dir: '.husky' },
+];
+
+const getFileRelativePath = (file) => (file.dir ? path.join(file.dir, file.name) : file.name);
+const getFileKey = (file) => `${file.dir ?? ''}::${file.name}`;
+
+const ensureCommonFile = (file) => {
+  const filePath = path.join(commonDir, getFileRelativePath(file));
+  if (!fs.existsSync(filePath)) {
+    throw new Error(`Missing common file: ${filePath}`);
+  }
+  return filePath;
+};
+
+const parseLocalSections = (filePath) => {
+  if (!filePath || !fs.existsSync(filePath)) {
+    return { before: '', after: '', hasMarkers: false };
+  }
+
+  const rawContent = fs.readFileSync(filePath, 'utf8').trim();
+  if (!rawContent) {
+    return { before: '', after: '', hasMarkers: false };
+  }
+
+  const markers = [...rawContent.matchAll(markerPattern)];
+  if (markers.length === 0) {
+    return { before: '', after: rawContent, hasMarkers: false };
+  }
+
+  const sections = {
+    before: '',
+    common: '',
+    after: '',
+  };
+
+  for (let index = 0; index < markers.length; index += 1) {
+    const current = markers[index];
+    const next = markers[index + 1];
+    const sectionName = current[1];
+    const start = current.index + current[0].length;
+    const end = next ? next.index : rawContent.length;
+    sections[sectionName] = rawContent.slice(start, end).trim();
+  }
+
+  return {
+    before: sections.before,
+    after: sections.after,
+    hasMarkers: true,
+  };
+};
+
+const getDefaultHeader = (fileName) => {
+  if (!textLikeFiles.has(fileName)) {
+    return '';
+  }
+
+  return `# base\n# 由 scripts/sync-common.mjs 根据 @dazhicheng/common/${fileName} 自动生成，请勿直接修改\n\n`;
+};
+
+const getDefaultLocalFiles = (file) => ({
+  merged: path.join('local', getFileRelativePath(file)),
+});
+
+const getDefaultBlockHeaders = (fileName) => {
+  if (textLikeFiles.has(fileName)) {
+    return {
+      before: '# project specific\n',
+      common: '',
+      after: '\n\n# project specific\n',
+    };
+  }
+
+  if (directLikeFiles.has(fileName)) {
+    return {
+      before: '# 这里是增量\n\n',
+      common: '# 这里是 common 的内容\n\n',
+      after: '\n\n# 这里还是增量\n\n',
+    };
+  }
+
+  return {
+    before: '',
+    common: '',
+    after: '',
+  };
+};
+
+const getDefaultFileConfig = (file) => ({
+  name: file.name,
+  dir: file.dir,
+  header: getDefaultHeader(file.name),
+  localFiles: getDefaultLocalFiles(file),
+  blockHeaders: getDefaultBlockHeaders(file.name),
+});
+
+const mergeFileConfig = (defaultFile, projectFile = {}) => ({
+  ...defaultFile,
+  ...projectFile,
+  localFiles: {
+    ...(defaultFile.localFiles ?? {}),
+    ...(projectFile.localFiles ?? {}),
+  },
+  blockHeaders: {
+    ...(defaultFile.blockHeaders ?? {}),
+    ...(projectFile.blockHeaders ?? {}),
+  },
+});
+
+const normalizeFileEntry = (file) => {
+  if (typeof file === 'string') {
+    return { name: file };
+  }
+
+  return file;
+};
+
+const normalizeFiles = (config = {}) => {
+  if (Array.isArray(config)) {
+    return config.map(normalizeFileEntry);
+  }
+
+  if (Array.isArray(config.files)) {
+    return config.files.map(normalizeFileEntry);
+  }
+
+  return [
+    ...(config.textFiles ?? []).map((file) => ({ type: 'textFiles', ...normalizeFileEntry(file) })),
+    ...(config.directFiles ?? []).map((file) => ({
+      type: 'directFiles',
+      ...normalizeFileEntry(file),
+    })),
+  ];
+};
+
+const mergeManagedFiles = (projectConfig = {}, runtimeConfig = {}) => {
+  const defaultFiles = normalizeFiles(defaultManagedFiles).map((file) =>
+    mergeFileConfig(getDefaultFileConfig(file), file),
+  );
+  const projectFiles = normalizeFiles(projectConfig);
+  const runtimeFiles = normalizeFiles(runtimeConfig);
+  const mergedMap = new Map(defaultFiles.map((file) => [getFileKey(file), { ...file }]));
+
+  for (const projectFile of projectFiles) {
+    const key = getFileKey(projectFile);
+    const current = mergedMap.get(key) ?? getDefaultFileConfig(projectFile);
+    mergedMap.set(key, mergeFileConfig(current, projectFile));
+  }
+
+  for (const runtimeFile of runtimeFiles) {
+    const key = getFileKey(runtimeFile);
+    const current = mergedMap.get(key) ?? getDefaultFileConfig(runtimeFile);
+    mergedMap.set(key, mergeFileConfig(current, runtimeFile));
+  }
+
+  return [...mergedMap.values()].filter((file) => file.enabled !== false);
+};
+
+const logGenerated = ({ rootDir, targetPath, commonPath, localPaths, usedLocalPaths }) => {
+  const targetName = path.relative(rootDir, targetPath).replaceAll('\\', '/');
+  const commonName = `@dazhicheng/common/${path.relative(commonDir, commonPath).replaceAll('\\', '/')}`;
+  const sourceText = [commonName, ...usedLocalPaths].join(' + ');
+
+  console.log(`[sync:common] generated ${targetName} <- ${sourceText}`);
+  if (localPaths.length > 0) {
+    console.log(`[sync:common] 如需项目增量，请修改 ${localPaths.join(' / ')}`);
+    console.log(
+      '[sync:common] 单个 local 文件可使用 <<<before>>> / <<<common>>> / <<<after>>> 标记',
+    );
+  }
+};
+
+const renderFile = ({ file, commonContent, localSections, usedLocalPaths }) => {
+  let output = file.header ?? '';
+
+  if (localSections.before) {
+    usedLocalPaths.push(file.localFiles.merged);
+    output += `${file.blockHeaders.before ?? ''}${localSections.before}\n\n`;
+  }
+
+  output += `${file.blockHeaders.common ?? ''}${commonContent}`;
+
+  if (localSections.after) {
+    if (!usedLocalPaths.includes(file.localFiles.merged)) {
+      usedLocalPaths.push(file.localFiles.merged);
+    }
+    output += `${file.blockHeaders.after ?? ''}${localSections.after}\n`;
+  } else {
+    output += '\n';
+  }
+
+  return output;
+};
+
+const syncFiles = ({ files, rootDir }) => {
+  for (const file of files) {
+    const commonPath = ensureCommonFile(file);
+    const targetPath = path.join(rootDir, getFileRelativePath(file));
+    const targetDir = path.dirname(targetPath);
+    if (!fs.existsSync(targetDir)) {
+      fs.mkdirSync(targetDir, { recursive: true });
+    }
+    const mergedPath = file.localFiles?.merged ? path.join(rootDir, file.localFiles.merged) : '';
+    const localSections = parseLocalSections(mergedPath);
+    const commonContent = fs.readFileSync(commonPath, 'utf8').trimEnd();
+    const usedLocalPaths = [];
+    const output = renderFile({ file, commonContent, localSections, usedLocalPaths });
+
+    fs.writeFileSync(targetPath, output);
+    logGenerated({
+      rootDir,
+      targetPath,
+      commonPath,
+      localPaths: Object.values(file.localFiles ?? {}).filter(Boolean),
+      usedLocalPaths,
+    });
+  }
+};
+
+export const runSyncCommon = async ({ rootDir, files = [], config = {} }) => {
+  const runtimeConfig = {
+    ...(config ?? {}),
+    files: [...normalizeFiles(config ?? {}), ...normalizeFiles(files)],
+  };
+  const managedFiles = mergeManagedFiles({}, runtimeConfig);
+
+  syncFiles({ files: managedFiles, rootDir });
+};
+
+const isDirectRun = process.argv[1] && path.resolve(process.argv[1]) === __filename;
+
+if (isDirectRun) {
+  const cwd = process.cwd();
+  await runSyncCommon({ rootDir: cwd });
+}