响水做网站哪家公司好,大钢模板相关信息圆柱钢模板优势是什么？企业网站建设模板和定制化有什么区别呢？人工费多少钱一平方,傻瓜式建网站,虚拟空间的网站赚钱吗本章分析package.json文件详解 本文主要对packge.json配置子文件详解 ObJack-Admin一款基于 Vue3.3、TypeScript、Vite3、Pinia、Element-Plus 开源的后台管理框架。在一定程度上节省您的开发效率。另外本项目还封装了一些常用组件、hooks、指令、动态路由、按钮级别权限控制等…本章分析package.json文件详解 本文主要对packge.json配置子文件详解 ObJack-Admin一款基于 Vue3.3、TypeScript、Vite3、Pinia、Element-Plus 开源的后台管理框架。在一定程度上节省您的开发效率。另外本项目还封装了一些常用组件、hooks、指令、动态路由、按钮级别权限控制等功能。感兴趣的小伙伴可以访问源码点个赞 地址 首先分析一下有哪些配置项文件
.editorconfig
.eslintignore
.eslintrc.cjs
.prettierignore
.prettierrc.cjs
.stylelintignore
.stylelintrc.cjs
commitlint.config.cjs
lint-staged.config.cjs
package-lock.json
pnpm-lock.yaml那么以上文件都是什么作用呢 可以配置哪些属性呢接下来我们一一拆分
深入解析 .editorconfig 文件 亿点小知识 .editorconfig 文件是一个帮助开发者在不同编辑器和IDE之间定义和维护一致代码风格的配置文件。它允许你指定不同文件或文件类型的代码风格规则从而确保团队成员使用统一的代码格式。 .editorconfig 文件的基本结构 .editorconfig 文件是一个简单的INI文件包含了多个以[section]开头的部分每个部分内定义了一系列的key value键值对。这些键值对定义了特定的代码风格规则。属性解释 下面是对你给出的.editorconfig文件内容的详细解释
root true
这告诉编辑器.editorconfig文件位于项目的根目录其他目录中的.editorconfig文件应该被忽略。
[*]
这是一个通配符表示以下规则适用于项目中的所有文件。
charset utf-8设置文件字符集为UTF-8这是现代软件开发中最常用的字符集。
end_of_line lf指定换行符为LFLine Feed这是Unix和Linux系统的标准换行符。
insert_final_newline true确保每个文件都以一个新行结束这有助于一些工具和编辑器正确地处理文件。
indent_style space使用空格进行缩进而不是制表符Tab。
indent_size 2缩进的大小为2个空格。
max_line_length 130限制每行的最大长度为130个字符以提高代码的可读性。
[*.md]
这是一个特定的文件类型通配符表示以下规则仅适用于.md文件Markdown文件。
max_line_length off对于Markdown文件关闭最大行长度限制。Markdown文件经常包含长的列表项或引用所以关闭此限制更为合适。
trim_trailing_whitespace false不修剪Markdown文件末尾的空格。在某些情况下Markdown文件中的末尾空格可能是有意为之的。如何使用 .editorconfig 文件 要使用.editorconfig文件你需要确保你的编辑器或IDE支持它。大多数现代编辑器和IDE如Visual Studio Code、Sublime Text、IntelliJ IDEA等都内置了对.editorconfig文件的支持。只需将.editorconfig文件放在项目的根目录并确保你的编辑器或IDE已启用对它的支持即可。
深入解析 .eslintignore 文件 亿点小知识 .eslintignore 文件是一个文本文件用于指定 ESLint 应该忽略哪些文件或目录。这个文件通常位于项目的根目录下并且其语法与 .gitignore 文件非常相似因为它也使用模式匹配来指定要忽略的文件和目录。 *.sh这个模式会忽略所有以 .sh 结尾的文件即 Shell 脚本文件。由于这些文件不是 JavaScript 或 TypeScript因此通常不需要 ESLint 来检查。
node_modules这个目录包含了项目的所有依赖项。由于这些文件是第三方库通常不需要进行 linting。此外linting node_modules 目录可能会导致大量的性能问题因为其中包含大量文件。
*.md忽略所有的 Markdown 文件.md 扩展名。Markdown 文件主要用于文档编写而不是代码编写因此不需要 ESLint 检查。
*.woff 和 *.ttf这些是字体文件的扩展名。它们不是源代码文件因此不需要 ESLint 来进行代码风格检查。
.vscode 和 .idea这些目录通常包含特定 IDE如 Visual Studio Code 或 IntelliJ IDEA的配置文件和缓存文件。这些文件不是源代码因此应该被忽略。
dist这个目录通常包含编译后的文件如构建输出。这些文件是在源代码文件基础上生成的因此不需要进行 linting。
/public 和 /docs这些目录可能包含静态资源、文档或其他非源代码文件因此应该被 ESLint 忽略。
.husky这个目录通常包含与 Git 钩子hooks相关的配置用于在 Git 操作如提交之前或之后运行脚本。这些文件不是源代码因此不需要 ESLint 检查。
.local这个目录可能包含本地开发环境的特定配置或数据与源代码无关因此应该被忽略。
/bin这个目录可能包含一些执行脚本或其他可执行文件它们通常不是 JavaScript 或 TypeScript 编写的因此不需要 ESLint 检查。
/src/mock/*这个模式会忽略 src/mock 目录下的所有文件。这可能是因为这些文件包含模拟数据或测试数据而不是实际的源代码。
stats.html这是一个具体的文件名可能是一个 Webpack 打包统计文件或其他类型的报告文件。由于它不是源代码因此应该被 ESLint 忽略。深入解析 .eslintrc.cjs 文件
// see: http://eslint.cnmodule.exports {root: true,env: {browser: true,node: true,es6: true},// 指定如何解析语法parser: vue-eslint-parser,// 优先级低于 parse 的语法解析配置parserOptions: {parser: typescript-eslint/parser,ecmaVersion: 2020,sourceType: module,jsxPragma: React,ecmaFeatures: {jsx: true}},// 继承某些已有的规则extends: [plugin:vue/vue3-recommended, plugin:typescript-eslint/recommended, plugin:prettier/recommended],/*** off 或 0 关闭规则* warn 或 1 打开的规则作为警告不影响代码执行* error 或 2 规则作为一个错误代码不能执行界面报错*/rules: {// eslint (http://eslint.cn/docs/rules)no-var: error, // 要求使用 let 或 const 而不是 varno-multiple-empty-lines: [error, { max: 1 }], // 不允许多个空行prefer-const: off, // 使用 let 关键字声明但在初始分配后从未重新分配的变量要求使用 constno-use-before-define: off, // 禁止在 函数/类/变量 定义之前使用它们no-irregular-whitespace: off, // 禁止不规则的空白// typeScript (https://typescript-eslint.io/rules)typescript-eslint/no-unused-vars: error, // 禁止定义未使用的变量typescript-eslint/prefer-ts-expect-error: error, // 禁止使用 ts-ignoretypescript-eslint/no-inferrable-types: off, // 可以轻松推断的显式类型可能会增加不必要的冗长typescript-eslint/no-namespace: off, // 禁止使用自定义 TypeScript 模块和命名空间。typescript-eslint/no-explicit-any: off, // 禁止使用 any 类型typescript-eslint/ban-types: off, // 禁止使用特定类型typescript-eslint/explicit-function-return-type: off, // 不允许对初始化为数字、字符串或布尔值的变量或参数进行显式类型声明typescript-eslint/no-var-requires: off, // 不允许在 import 语句中使用 require 语句typescript-eslint/no-empty-function: off, // 禁止空函数typescript-eslint/no-use-before-define: off, // 禁止在变量定义之前使用它们typescript-eslint/ban-ts-comment: off, // 禁止 ts-directive 使用注释或要求在指令后进行描述typescript-eslint/no-non-null-assertion: off, // 不允许使用后缀运算符的非空断言(!)typescript-eslint/explicit-module-boundary-types: off, // 要求导出函数和类的公共类方法的显式返回和参数类型// vue (https://eslint.vuejs.org/rules)vue/script-setup-uses-vars: error, // 防止script setup使用的变量template被标记为未使用此规则仅在启用该no-unused-vars规则时有效。vue/v-slot-style: error, // 强制执行 v-slot 指令样式vue/no-mutating-props: off, // 不允许组件 prop的改变vue/no-v-html: off, // 禁止使用 v-htmlvue/custom-event-name-casing: off, // 为自定义事件名称强制使用特定大小写vue/attributes-order: off, // vue api使用顺序强制执行属性顺序vue/one-component-per-file: off, // 强制每个组件都应该在自己的文件中vue/html-closing-bracket-newline: off, // 在标签的右括号之前要求或禁止换行vue/max-attributes-per-line: off, // 强制每行的最大属性数vue/multiline-html-element-content-newline: off, // 在多行元素的内容之前和之后需要换行符vue/singleline-html-element-content-newline: off, // 在单行元素的内容之前和之后需要换行符vue/attribute-hyphenation: off, // 对模板中的自定义组件强制执行属性命名样式vue/require-default-prop: off, // 此规则要求为每个 prop 为必填时必须提供默认值vue/multi-word-component-names: off // 要求组件名称始终为 “-” 链接的单词}
};深入解析 .prettierignore 文件 亿点小知识 .prettierignore 文件是一个文本文件用于指定 Prettier 应该忽略哪些文件或目录。这个文件通常位于项目的根目录下并且其语法与 .gitignore 文件非常相似因为它也使用模式匹配来指定要忽略的文件和目录。 # .prettierignore 文件内容 # 忽略 dist 目录下的所有文件
/dist/* # 忽略 .local 目录或文件如果存在
.local # 忽略 node_modules 目录下的所有文件和子目录
/node_modules/** # 忽略所有目录下的 .svg 文件
**/*.svg # 忽略所有目录下的 .sh 文件
**/*.sh # 忽略 public 目录下的所有文件
/public/* # 忽略名为 stats.html 的文件
stats.html深入解析.prettierrc.cjs 文件
// see: https://www.prettier.cnmodule.exports {// 指定最大换行长度printWidth: 130,// 缩进制表符宽度 | 空格数tabWidth: 2,// 使用制表符而不是空格缩进行 (true制表符false空格)useTabs: false,// 结尾不用分号 (true有false没有)semi: true,// 使用单引号 (true单引号false双引号)singleQuote: false,// 在对象字面量中决定是否将属性名用引号括起来 可选值 as-needed|consistent|preservequoteProps: as-needed,// 在JSX中使用单引号而不是双引号 (true单引号false双引号)jsxSingleQuote: false,// 多行时尽可能打印尾随逗号 可选值none|es5|alltrailingComma: none,// 在对象数组括号与文字之间加空格 { foo: bar } (true有false没有)bracketSpacing: true,// 将 多行元素放在最后一行的末尾而不是单独放在下一行 (true放末尾false单独一行)bracketSameLine: false,// (x) {} 箭头函数参数只有一个时是否要有小括号 (avoid省略括号always不省略括号)arrowParens: avoid,// 指定要使用的解析器不需要写文件开头的 prettierrequirePragma: false,// 可以在文件顶部插入一个特殊标记指定该文件已使用 Prettier 格式化insertPragma: false,// 用于控制文本是否应该被换行以及如何进行换行proseWrap: preserve,// 在html中空格是否是敏感的 css - 遵守 CSS 显示属性的默认值 strict - 空格被认为是敏感的 ignore - 空格被认为是不敏感的htmlWhitespaceSensitivity: css,// 控制在 Vue 单文件组件中 script 和 style 标签内的代码缩进方式vueIndentScriptAndStyle: false,// 换行符使用 lf 结尾是 可选值 auto|lf|crlf|crendOfLine: auto,// 这两个选项可用于格式化以给定字符偏移量分别包括和不包括开始和结束的代码 (rangeStart开始rangeEnd结束)rangeStart: 0,rangeEnd: Infinity
};
深入解析commitlint.config.cjs 文件
// see: https://cz-git.qbenben.com/zh/guide
const fs require(fs);
const path require(path);const scopes fs.readdirSync(path.resolve(__dirname, src), { withFileTypes: true }).filter(dirent dirent.isDirectory()).map(dirent dirent.name.replace(/s$/, ));/** type {import(cz-git).UserConfig} */
module.exports {ignores: [commit commit.includes(init)],extends: [commitlint/config-conventional],rules: {// see: https://commitlint.js.org/#/reference-rulesbody-leading-blank: [2, always],footer-leading-blank: [1, always],header-max-length: [2, always, 108],subject-empty: [2, never],type-empty: [2, never],subject-case: [0],type-enum: [2,always,[feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert,wip,workflow,types,release]]},prompt: {messages: {type: Select the type of change that youre committing:,scope: Denote the SCOPE of this change (optional):,customScope: Denote the SCOPE of this change:,subject: Write a SHORT, IMPERATIVE tense description of the change:\n,body: Provide a LONGER description of the change (optional). Use | to break new line:\n,breaking: List any BREAKING CHANGES (optional). Use | to break new line:\n,footerPrefixsSelect: Select the ISSUES type of changeList by this change (optional):,customFooterPrefixs: Input ISSUES prefix:,footer: List any ISSUES by this change. E.g.: #31, #34:\n,confirmCommit: Are you sure you want to proceed with the commit above?// 中文版// type: 选择你要提交的类型 :,// scope: 选择一个提交范围可选:,// customScope: 请输入自定义的提交范围 :,// subject: 填写简短精炼的变更描述 :\n,// body: 填写更加详细的变更描述可选。使用 | 换行 :\n,// breaking: 列举非兼容性重大的变更可选。使用 | 换行 :\n,// footerPrefixsSelect: 选择关联issue前缀可选:,// customFooterPrefixs: 输入自定义issue前缀 :,// footer: 列举关联issue (可选) 例如: #31, #I3244 :\n,// confirmCommit: 是否提交或修改commit ?},types: [{value: feat,name: feat: A new feature,emoji: },{value: fix,name: fix: A bug fix,emoji: },{value: docs,name: docs: Documentation only changes,emoji: },{value: style,name: style: Changes that do not affect the meaning of the code,emoji: },{value: refactor,name: refactor: ♻️ A code change that neither fixes a bug nor adds a feature,emoji: ♻️},{value: perf,name: perf: ⚡️ A code change that improves performance,emoji: ⚡️},{value: test,name: test: ✅ Adding missing tests or correcting existing tests,emoji: ✅},{value: build,name: build: ️ Changes that affect the build system or external dependencies,emoji: ️},{value: ci,name: ci: Changes to our CI configuration files and scripts,emoji: },{value: chore,name: chore: Other changes that dont modify src or test files,emoji: },{value: revert,name: revert: ⏪️ Reverts a previous commit,emoji: ⏪️},{value: wip,name: wip: work in process,emoji: },{value: workflow,name: workflow: workflow improvements,emoji: },{value: type,name: type: type definition file changes,emoji: }// 中文版// { value: feat, name: 特性: 新增功能, emoji: },// { value: fix, name: 修复: 修复缺陷, emoji: },// { value: docs, name: 文档: 文档变更, emoji: },// { value: style, name: 格式: 代码格式不影响功能例如空格、分号等格式修正, emoji: },// { value: refactor, name: 重构: ♻️ 代码重构不包括 bug 修复、功能新增, emoji: ♻️ },// { value: perf, name: 性能: ⚡️ 性能优化, emoji: ⚡️ },// { value: test, name: 测试: ✅ 添加疏漏测试或已有测试改动, emoji: ✅ },// { value: build, name: 构建: ️ 构建流程、外部依赖变更如升级 npm 包、修改 webpack 配置等, emoji: ️ },// { value: ci, name: 集成: 修改 CI 配置、脚本, emoji: },// { value: chore, name: 回退: ⏪️ 回滚 commit, emoji: ⏪️ },// { value: revert, name: 其他: 对构建过程或辅助工具和库的更改不影响源文件、测试用例, emoji: },// { value: wip, name: 开发: 正在开发中, emoji: },// { value: workflow, name: 工作流: 工作流程改进, emoji: },// { value: types, name: 类型: 类型定义文件修改, emoji: }],useEmoji: true,scopes: [...scopes],customScopesAlign: bottom,emptyScopesAlias: empty,customScopesAlias: custom,allowBreakingChanges: [feat, fix]}
};
深入解析lint-staged.config.cjs 文件
module.exports {*.{js,jsx,ts,tsx}: [eslint --fix, prettier --write],{!(package)*.json,*.code-snippets,.!(browserslist)*rc}: [prettier --write--parser json],package.json: [prettier --write],*.vue: [eslint --fix, prettier --write, stylelint --fix],*.{scss,less,styl,html}: [stylelint --fix, prettier --write],*.md: [prettier --write]
}; 如碰到其他的问题 可以私下我 一起探讨学习 如果对你有所帮助还请 点赞 收藏谢谢~ 关注收藏博客 作者会持续更新…
