@semi-kit/config 1.1.1 → 1.1.3

package/README.md

@@ -1,23 +1,23 @@
-# tsdown-starter
-
-A starter for creating a TypeScript package.
-
-## Development
-
-- Install dependencies:
-
-```bash
-npm install
-```
-
-- Run the unit tests:
-
-```bash
-npm run test
-```
-
-- Build the library:
-
-```bash
-npm run build
-```
+# tsdown-starter
+
+A starter for creating a TypeScript package.
+
+## Development
+
+- Install dependencies:
+
+```bash
+npm install
+```
+
+- Run the unit tests:
+
+```bash
+npm run test
+```
+
+- Build the library:
+
+```bash
+npm run build
+```

package/lib/commitlint.mjs

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) Semi-Tech(SEMI-TECH) Corporation. All rights reserved.
+ * It is against the law to copy the software except as specifically
+ * allowed in the authorization agreement.
+ * Semi-Tech Confidential Level 2
+ */
+
+const { execSync } = require('child_process');
+const scopes = execSync('git status --porcelain || true')
+  ?.toString()
+  ?.trim()
+  ?.split('\n')
+  ?.map(item => {
+    const result = item?.match(/([A-Za-z0-9-_]*)\.[^.]+$/)?.[1];
+    return item === 'Custom' ? result : result?.toLowerCase();
+  });
+
+module.exports = {
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'revert', 'chore']
+    ],
+    'body-leading-blank': [2, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [2, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'footer-max-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 200],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'scope-case': [2, 'always', 'kebab-case'],
+    'scope-max-length': [2, 'always', 30],
+    'scope-min-length': [2, 'always', 2],
+    'subject-max-length': [2, 'always', 100],
+    'subject-min-length': [2, 'always', 3],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.']
+  },
+  prompt: {
+    messages: {
+      type: '选择提交的类型 :',
+      scope: '选择修改范围 :',
+      customScope: '请输入自定义的提交范围 :',
+      subject: '填写简短精炼的变更描述 :\n',
+      footer: '列举关联issue (可选) 例如: #31, #101 :\n',
+      confirmCommit: '是否提交或修改 commit ?'
+    },
+    types: [
+      { value: 'feat', name: 'feat:     ✨  新增功能 | A new feature', emoji: ':sparkles:' },
+      { value: 'fix', name: 'fix:      🐛  修复缺陷 | A bug fix', emoji: ':bug:' },
+      {
+        value: 'docs',
+        name: 'docs:     📝  文档更新 | Documentation only changes',
+        emoji: ':memo:'
+      },
+      {
+        value: 'style',
+        name: 'style:    💄  代码格式 | Changes that do not affect the meaning of the code',
+        emoji: ':lipstick:'
+      },
+      {
+        value: 'refactor',
+        name: 'refactor: ♻️   代码重构 | A code change that neither fixes a bug nor adds a feature',
+        emoji: ':recycle:'
+      },
+      {
+        value: 'perf',
+        name: 'perf:     ⚡️  性能提升 | A code change that improves performance',
+        emoji: ':zap:'
+      },
+      {
+        value: 'test',
+        name: 'test:     ✅  测试相关 | Adding missing tests or correcting existing tests',
+        emoji: ':white_check_mark:'
+      },
+      {
+        value: 'build',
+        name: 'build:    📦️  构建相关 | Changes that affect the build system or external dependencies',
+        emoji: ':package:'
+      },
+      {
+        value: 'ci',
+        name: 'ci:       🎡  持续集成 | Changes to our CI configuration files and scripts',
+        emoji: ':ferris_wheel:'
+      },
+      { value: 'revert', name: 'revert:   ⏪️  代码回退 | Revert to a commit', emoji: ':hammer:' },
+      {
+        value: 'chore',
+        name: 'chore:    🔨  其他修改 | Other changes that do not modify src or test files',
+        emoji: ':rewind:'
+      }
+    ],
+    scopes,
+    customScopesAlias: '自定义',
+    allowBreakingChanges: ['feat', 'fix', 'refactor', 'chore', 'ci', 'perf', 'revert'],
+    skipQuestions: ['body', 'footerPrefix', 'breaking', 'customFooterPrefixs'],
+    maxHeaderLength: 200,
+    maxSubjectLength: 100,
+    minSubjectLength: 3,
+    formatMessageCB: ({ defaultHeader, footer }) => {
+      let res = defaultHeader;
+      if (footer) {
+        const reg = /#(\d+)/g;
+        const result = footer.replace(reg, `\nhttps://redmine.semi-tech.com/issues/$1`).replace(/^\n|\n$/g, '');
+        res += `${result}`;
+      }
+      return res;
+    }
+  }
+};

package/lib/prettier.mjs

@@ -1,22 +1,37 @@
-const config = {
-	plugins: ["@prettier/plugin-oxc"],
-	printWidth: 120,
-	tabWidth: 2,
-	tabs: true,
-	semi: true,
-	singleQuote: true,
-	quoteProps: "preserve",
-	bracketSpacing: true,
-	jsxBracketSameLine: false,
-	trailingComma: "none",
-	useTabs: false,
-	jsxSingleQuote: false,
-	arrowParens: "avoid",
-	rangeStart: 0,
-	proseWrap: "always",
-	endOfLine: "auto",
-	vueIndentScriptAndStyle: false
-};
-var prettier_default = config;
-
-export { prettier_default as default };
+const config = {
+  plugins: ['@prettier/plugin-oxc'],
+  // 单行输出（不折行）的（最大）长度
+  printWidth: 120,
+  // 每个缩进级别的空格数
+  tabWidth: 2,
+  // 使用制表符 Tab 缩进行而不是空格 Space。
+  tabs: true,
+  // 是否在语句末尾打印分号
+  semi: true,
+  // 是否使用单引号
+  singleQuote: true,
+  // 仅在需要时在对象属性周围添加引号
+  quoteProps: 'preserve',
+  // 是否在对象属性添加空格
+  bracketSpacing: true,
+  // 将 > 多行 JSX 元素放在最后一行的末尾，而不是单独放在下一行，不适用于自闭元素
+  jsxBracketSameLine: false,
+  // 去除对象最末尾元素跟随的逗号
+  trailingComma: 'none',
+  // 不使用缩进符，而使用空格
+  useTabs: false,
+  // Jsx 不使用单引号，而使用双引号
+  jsxSingleQuote: false,
+  // 箭头函数，只有一个参数的时候，也需要括号
+  arrowParens: 'avoid',
+  // 每个文件格式化的范围是文件的全部内容
+  rangeStart: 0,
+  // 当超出 Print Width 时就折行
+  proseWrap: 'always',
+  // 换行符
+  endOfLine: 'auto',
+  // Vue 文件脚本和样式标签缩进
+  vueIndentScriptAndStyle: false
+};
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semi-kit/config",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Shared development configuration toolkit",
   "type": "module",
   "license": "MIT",

package/lib/commitlint.cjs

@@ -1,181 +0,0 @@
-
-const { execSync } = require("child_process");
-const scopes = execSync("git status --porcelain || true")?.toString()?.trim()?.split("\n")?.map((item) => {
-	const result = item?.match(/([A-Za-z0-9-_]*)\.[^.]+$/)?.[1];
-	return item === "Custom" ? result : result?.toLowerCase();
-});
-module.exports = {
-	rules: {
-		"type-enum": [
-			2,
-			"always",
-			[
-				"feat",
-				"fix",
-				"docs",
-				"style",
-				"refactor",
-				"perf",
-				"test",
-				"build",
-				"ci",
-				"revert",
-				"chore"
-			]
-		],
-		"body-leading-blank": [2, "always"],
-		"body-max-line-length": [
-			2,
-			"always",
-			100
-		],
-		"footer-leading-blank": [2, "always"],
-		"footer-max-line-length": [
-			2,
-			"always",
-			100
-		],
-		"footer-max-length": [
-			2,
-			"always",
-			100
-		],
-		"header-max-length": [
-			2,
-			"always",
-			200
-		],
-		"type-case": [
-			2,
-			"always",
-			"lower-case"
-		],
-		"type-empty": [2, "never"],
-		"scope-case": [
-			2,
-			"always",
-			"kebab-case"
-		],
-		"scope-max-length": [
-			2,
-			"always",
-			30
-		],
-		"scope-min-length": [
-			2,
-			"always",
-			2
-		],
-		"subject-max-length": [
-			2,
-			"always",
-			100
-		],
-		"subject-min-length": [
-			2,
-			"always",
-			3
-		],
-		"subject-empty": [2, "never"],
-		"subject-full-stop": [
-			2,
-			"never",
-			"."
-		]
-	},
-	prompt: {
-		messages: {
-			type: "选择提交的类型 :",
-			scope: "选择修改范围 :",
-			customScope: "请输入自定义的提交范围 :",
-			subject: "填写简短精炼的变更描述 :\n",
-			footer: "列举关联issue (可选) 例如: #31, #101 :\n",
-			confirmCommit: "是否提交或修改 commit ?"
-		},
-		types: [
-			{
-				value: "feat",
-				name: "feat:     ✨  新增功能 | A new feature",
-				emoji: ":sparkles:"
-			},
-			{
-				value: "fix",
-				name: "fix:      🐛  修复缺陷 | A bug fix",
-				emoji: ":bug:"
-			},
-			{
-				value: "docs",
-				name: "docs:     📝  文档更新 | Documentation only changes",
-				emoji: ":memo:"
-			},
-			{
-				value: "style",
-				name: "style:    💄  代码格式 | Changes that do not affect the meaning of the code",
-				emoji: ":lipstick:"
-			},
-			{
-				value: "refactor",
-				name: "refactor: ♻️   代码重构 | A code change that neither fixes a bug nor adds a feature",
-				emoji: ":recycle:"
-			},
-			{
-				value: "perf",
-				name: "perf:     ⚡️  性能提升 | A code change that improves performance",
-				emoji: ":zap:"
-			},
-			{
-				value: "test",
-				name: "test:     ✅  测试相关 | Adding missing tests or correcting existing tests",
-				emoji: ":white_check_mark:"
-			},
-			{
-				value: "build",
-				name: "build:    📦️  构建相关 | Changes that affect the build system or external dependencies",
-				emoji: ":package:"
-			},
-			{
-				value: "ci",
-				name: "ci:       🎡  持续集成 | Changes to our CI configuration files and scripts",
-				emoji: ":ferris_wheel:"
-			},
-			{
-				value: "revert",
-				name: "revert:   ⏪️  代码回退 | Revert to a commit",
-				emoji: ":hammer:"
-			},
-			{
-				value: "chore",
-				name: "chore:    🔨  其他修改 | Other changes that do not modify src or test files",
-				emoji: ":rewind:"
-			}
-		],
-		scopes,
-		customScopesAlias: "自定义",
-		allowBreakingChanges: [
-			"feat",
-			"fix",
-			"refactor",
-			"chore",
-			"ci",
-			"perf",
-			"revert"
-		],
-		skipQuestions: [
-			"body",
-			"footerPrefix",
-			"breaking",
-			"customFooterPrefixs"
-		],
-		maxHeaderLength: 200,
-		maxSubjectLength: 100,
-		minSubjectLength: 3,
-		formatMessageCB: ({ defaultHeader, footer }) => {
-			let res = defaultHeader;
-			if (footer) {
-				const result = footer.replace(/#(\d+)/g, `\nhttps://redmine.semi-tech.com/issues/$1`).replace(/^\n|\n$/g, "");
-				res += `${result}`;
-			}
-			return res;
-		}
-	}
-};