pl-preset 0.0.1 → 0.0.2

package/README.md

@@ -1,4 +1,4 @@
-# PL-PRESET
+# pl-preset
 
 一键生成web项目格式化（Pretty）、校验（Lint）、Git提交规范等配置，支持设置开发语音（javascript、typescript）,样式扩展语言（css、less、scss），前端开发框架（vue2、vue3、react）
 

package/package.json

@@ -1,17 +1,21 @@
 {
 	"name": "pl-preset",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"bin": {
 		"plp": "dist/cli.js"
 	},
 	"scripts": {
 		"build": "rollup -c rollup.config.js",
 		"dev": "rollup -c rollup.config.js -w",
-		"c": "cz"
+		"c": "cz",
+		"beta": "run-p build publish:beta",
+		"release": "run-p build publish:prod",
+		"publish:prod": "npm publish",
+		"publish:beta": "npm publish --tag beta"
 	},
 	"files": [
 		"dist",
-		"templage",
+		"template",
 		"package.json",
 		"README.md"
 	],
@@ -19,6 +23,12 @@
 	"author": "Chad.Ding",
 	"license": "MIT",
 	"description": "A cli tool to generate project common settings quickly.",
+	"keywords": [
+		"prettier",
+		"commitlint",
+		"eslint",
+		"stylelint"
+	],
 	"devDependencies": {
 		"@babel/eslint-parser": "^7.28.5",
 		"@babel/preset-env": "^7.28.5",
@@ -29,6 +39,7 @@
 		"@rollup/plugin-json": "^6.1.0",
 		"@rollup/plugin-node-resolve": "^16.0.3",
 		"cz-conventional-changelog": "^3.3.0",
+		"npm-run-all": "^4.1.5",
 		"prettier": "^3.6.2",
 		"rollup": "^4.52.5"
 	},

package/template/.prettierrc

@@ -0,0 +1,19 @@
+{
+	"semi": false,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"arrowParens": "avoid",
+	"useTabs": true,
+	"tabWidth": 4<%= styleSheets != supportedStyleSheets.others ? ',' : ''%>
+	<%_ if (styleSheets != supportedStyleSheets.others) { _%>
+	"overrides": [
+		{
+			"files": ["**/*.css", "**/*.scss", "**/*.less"],
+			"options": {
+				"singleQuote": false
+			}
+		}
+	]
+	<%_ } _%>
+}

package/template/.stylelintrc.js

@@ -0,0 +1,119 @@
+module.exports = {
+	extends: [
+		<%_ if (styleSheets == supportedStyleSheets.less) { _%>
+		'stylelint-config-recommended-less',
+		<%_ } else if (styleSheets == supportedStyleSheets.scss) { _%>
+		'stylelint-config-recommended-scss',
+		<%_ } _%>
+		<%_ if (vue) { _%>
+		'stylelint-config-html/vue',
+		<%_ } _%>
+		'stylelint-config-standard',
+		'stylelint-config-recess-order'
+	],
+	plugins: [
+		<%_ if (styleSheets == supportedStyleSheets.scss) { _%>
+		'stylelint-scss',
+		<%_ } else if (styleSheets == supportedStyleSheets.less) { _%>
+		'stylelint-less',
+		<%_ } _%>
+		'stylelint-order'
+	],
+	rules: {
+		<%_ if (styleSheets == supportedStyleSheets.scss) { _%>
+		// SCSS嵌套语法检查
+		'scss/at-extend-no-missing-placeholder': true,
+		'scss/at-import-no-partial-leading-underscore': true,
+		'scss/at-import-partial-extension-blacklist': ['scss', 'sass'],
+		'scss/dollar-variable-pattern': [
+			'^[a-z0-9\\-_]+$',
+			{
+				message: '变量名只能由小写字母、数字、中划线和下划线组成'
+			}
+		],
+		<%_ } else if (styleSheets == supportedStyleSheets.less) {_%>
+		// Less 语法检查规则
+		'less/color-no-invalid-hex': true,
+		'less/color-hex-case': 'lower',
+		<%_ } _%>
+		'value-keyword-case': null,
+		// 处理 Tailwind CSS 的 at-rule
+		'at-rule-no-unknown': [
+			true,
+			{
+				ignoreAtRules: ['apply', 'layer', 'responsive', 'screen', 'tailwind', 'variants']
+			}
+		],
+		'declaration-block-trailing-semicolon': null,
+		'no-descending-specificity': null,
+		// 不支持浏览器前缀，自行使用autoprefixer添加
+		'at-rule-no-vendor-prefix': true,
+		'media-feature-name-no-vendor-prefix': true,
+		'property-no-vendor-prefix': true,
+		'selector-no-vendor-prefix': true,
+		'value-no-vendor-prefix': true,
+		// 多行规则前总是有空行
+		'rule-empty-line-before': [
+			'always-multi-line',
+			{
+				except: ['first-nested'],
+				ignore: ['after-comment']
+			}
+		],
+		// 最大嵌套深度
+		'max-nesting-depth': [
+			5,
+			{
+				ignoreAtRules: ['media', 'each', 'supports', 'include']
+			}
+		],
+		// 匹配规则中不限制选择器的个数
+		'selector-max-compound-selectors': null,
+		// 匹配规则中最多只能出现一个id选择器
+		'selector-max-id': 1,
+		// 禁止用元素选择器来修饰某个选择器
+		'selector-no-qualifying-type': [
+			true,
+			{
+				ignore: ['attribute', 'class']
+			}
+		],
+		// 类选择器模式，类名只能由小写字母、数字和连字符组成
+		'selector-class-pattern': [
+			'^[a-z0-9\\-_]+$',
+			{
+				message: '类名只能由小写字母、数字、中划线和下划线组成'
+			}
+		],
+		// 禁止未知的伪元素
+		'selector-pseudo-element-no-unknown': [true],
+		// 禁止颜色名称
+		'color-named': 'never',
+		// url()中地址必须使用引号
+		'function-url-quotes': 'always',
+		// 能简写的属性尽量简写，禁止冗余的值
+		'shorthand-property-no-redundant-values': true,
+		// 规则集大括号里的内容排序方式
+		'order/properties-order': null,
+		'order/properties-alphabetical-order': true
+	},
+	overrides: [
+		<%_ if (vue) { _%>
+		{
+			files: ['**/*.vue'],
+			customSyntax: 'postcss-html'
+		}<%= styleSheets == supportedStyleSheets.less || styleSheets == supportedStyleSheets.scss ? ',' : ''%>
+		<%_ } _%>
+		<%_ if (styleSheets == supportedStyleSheets.less) { _%>
+		{
+			files: ['**/*.less'],
+			customSyntax: 'postcss-less'
+		}
+		<%_ } else if (styleSheets == supportedStyleSheets.scss) { _%>
+		{
+			files: ['**/*.scss'],
+			customSyntax: 'postcss-scss'
+		}
+		<%_ } _%>
+	]
+}

package/template/.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+	"recommendations": [
+		"esbenp.prettier-vscode",
+		"dbaeumer.vscode-eslint",
+		<%_ if (style) { _%>
+		"stylelint.vscode-stylelint",
+		<%_ } _%>
+		<%_ if (vue) { _%>
+		"octref.vetur"
+		<%_ } _%>
+	]
+}

package/template/.vscode/settings.json

@@ -0,0 +1,53 @@
+{
+	<%_ if (framework == supportedFramework.vue2 || framework == supportedFramework.vue3) { _%>
+	"[vue]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } _%>
+	<%_ if (language == supportedLanguage.typescript) { _%>
+	"[typescript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } else if (language == supportedLanguage.javascript) { _%>
+	"[javascript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } _%>
+	<%_ if (styleSheets == supportedStyleSheets.css) { _%>
+	"css.validate": false,
+	"[css]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } else if (styleSheets === supportedStyleSheets.scss) { _%>
+	"scss.validate": false,
+	"[scss]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } else if (styleSheets === supportedStyleSheets.less) { _%>
+	"less.validate": false,
+	"[less]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	<%_ } _%>
+	"eslint.validate": [
+		<%_ if (framework == supportedFramework.react) { _%>
+		"javascriptreact",
+		"typescriptreact",
+		<%_ } _%>
+		"javascript",
+		"typescript"
+	],
+	"stylelint.validate": ["css", "scss", "vue", "less", "postcss"],
+	"files.eol": "\n",
+	"files.insertFinalNewline": true,
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "explicit"
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"javascript.format.enable": false,
+	"vetur.format.enable": false,
+	"editor.formatOnPaste": true,
+	"editor.formatOnType": true,
+	"prettier.useTabs": true
+}

package/template/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	extends: ['@commitlint/config-conventional']
+}

package/template/eslint.config.js

@@ -0,0 +1,182 @@
+const js = require('@eslint/js')
+const globals = require('globals')
+const eslintParser = require('@babel/eslint-parser')
+const eslintPretterPlugin = require('eslint-plugin-prettier')
+<%_ if(language == supportedLanguage.typescript) { _%>
+const tsParser = require('@typescript-eslint/parser')
+const tsPlugin = require('@typescript-eslint/eslint-plugin')
+<%_ } _%>
+<%_ if (framework == supportedFramework.vue2 || framework == supportedFramework.vue3) { _%>
+const vuePlugin = require('eslint-plugin-vue')
+const vueParser = require('vue-eslint-parser')
+<%_ } else if (framework == supportedFramework.react) { _%>
+const reactHooks = require('eslint-plugin-react-hooks')
+const reactPlugin = require('eslint-plugin-react')	
+<%_ } _%>
+
+module.exports = [
+	// 忽略文件配置
+	{
+		ignores: ['node_modules/', 'dist/', 'test/', 'coverage/']
+	},
+	<%_ if(language == supportedLanguage.typescript) { _%>
+	// TypeScript 配置
+	{
+		files: ['**/*.ts', <%- framework == supportedFramework.react ? '\'**/*.tsx\'' : ''-%>],
+		plugins: {
+			<%_ if (framework == supportedFramework.react) { _%>
+				react: reactPlugin,
+      			'react-hooks': reactHooks,
+			<%_ } _%>
+			prettier: eslintPretterPlugin,
+			'@typescript-eslint': tsPlugin
+		},
+		languageOptions: {
+			parser: tsParser,
+			ecmaVersion: 'latest',
+			parserOptions: {
+				<%_ if(framework == supportedFramework.react) { _%>
+				ecmaFeatures: {
+					jsx: true
+				},
+				<%_ } _%>
+				project: "./tsconfig.json"
+			},
+			sourceType: 'module',
+			globals: { ...globals.browser, ...globals.node, ...globals.es2020 }
+		},
+		rules: {
+			...tsPlugin.configs.recommended.rules,
+			<%_ if(framework == supportedFramework.react) { _%>
+			"react/jsx-uses-react": "error",
+			"react/jsx-uses-vars": "error",
+			"react/react-in-jsx-scope": "off",
+			// React Hooks 规则
+			"react-hooks/rules-of-hooks": "error",
+			"react-hooks/exhaustive-deps": "warn",
+			<%_ } _%>
+			'@typescript-eslint/no-explicit-any': 'warn',
+			'@typescript-eslint/explicit-function-return-type': 'off'
+		}
+	},
+	<%_ } _%>
+	<%_ if (framework == supportedFramework.vue2 || framework == supportedFramework.vue3) { _%>
+	// Vue 文件配置
+	{
+		files: ['**/*.vue'],
+		languageOptions: {
+			parser: vueParser,
+			parserOptions: {
+				parser: <%= language == supportedLanguage.typescript ? 'tsParser' : 'eslintParser'%>,
+				requireConfigFile: false,
+				ecmaVersion: 'latest',
+				sourceType: 'module'
+			},
+			globals: { ...globals.browser, ...globals.node }
+			<%_ if (language == supportedLanguage.javascript) { _%>
+			babelOptions: {
+				presets: ['@babel/preset-env']
+			}
+			<%_ } _%>
+		},
+		plugins: {
+			<%_ if (language == supportedLanguage.typescript) { _%>
+			'@typescript-eslint': tsPlugin,
+			<%_ } _%>
+			vue: vuePlugin
+		},
+		rules: {
+			<%_ if (language == supportedLanguage.typescript) { _%>
+			...tsPlugin.configs.recommended.rules,
+			<%_ } else { _%>
+			...js.configs.recommended.rules,
+			<%_ } _%>
+			...vuePlugin.configs['flat/base'].rules,
+			<%_ if (framework == supportedFramework.vue2) { _%>
+			...vuePlugin.configs['flat/vue2-recommended'].rules,
+			...vuePlugin.configs['flat/vue2-strongly-recommended'].rules,
+			...vuePlugin.configs['flat/vue2-essential'].rules,
+			<%_ } else { _%>
+			...vuePlugin.configs['vue3-recommended'].rules,
+			...vuePlugin.configs['vue3-strongly-recommended'].rules,
+			...vuePlugin.configs['vue3-essential'].rules,
+			<%_ } _%>
+			'vue/multi-word-component-names': 'off',
+			'vue/comment-directive': 'off',
+			'vue/html-indent': 'off',
+			'vue/max-attributes-per-line': 'off',
+			'vue/require-default-prop': 'off',
+			'vue/html-closing-bracket-newline': 'off',
+			'vue/html-self-closing': [
+				'error',
+				{
+					html: {
+						void: 'always',
+						normal: 'always',
+						component: 'always'
+					},
+					svg: 'always',
+					math: 'always'
+				}
+			]
+		}
+	},
+	<%_ } _%>
+	// 基础 JavaScript 配置
+	{
+		files: ['**/*.js', <%- framework == supportedFramework.react ? '\'**/*.jsx\'' : '' -%>],
+		languageOptions: {
+			ecmaVersion: 'latest',
+			sourceType: 'module',
+			parser: eslintParser,
+			parserOptions: {
+				requireConfigFile: false,
+				<%_ if (framework == supportedFramework.react) { _%>
+				ecmaFeatures: {
+					jsx: true
+				},
+				<%_ } _%>
+				babelOptions: {
+					babelrc: false,
+					configFile: false,
+					presets: ['@babel/preset-env']
+				}
+			},
+			globals: { ...globals.browser, ...globals.node, ...globals.es2020 }
+		},
+		plugins: {
+			<%_ if (framework == supportedFramework.react) { _%>
+				react: reactPlugin,
+      			'react-hooks': reactHooks,
+			<%_ } _%>
+			prettier: eslintPretterPlugin
+		},
+		<%_ if (framework == supportedFramework.react) { _%>
+		settings: {
+			react: {
+				version: "detect"
+			}
+		},
+		<%_ } _%>
+		rules: {
+			...js.configs.recommended.rules,
+			<%_ if(framework == supportedFramework.react) { _%>
+			"react/jsx-uses-react": "error",
+			"react/jsx-uses-vars": "error",
+			"react/react-in-jsx-scope": "off",
+			// React Hooks 规则
+			"react-hooks/rules-of-hooks": "error",
+			"react-hooks/exhaustive-deps": "warn",
+			<%_ } _%>
+			'prettier/prettier': [
+				'error',
+				{
+					singleQuote: true,
+					semi: false
+				}
+			],
+			'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+			'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
+		}
+	}
+]