Merge pull request #99 from mmdapl/feat/ci-lint

Author: 微信公众号：储凡

.eslintignore

@@ -3,5 +3,4 @@ docs/manuscripts
 .github
 .idea
 .dockerignore
-.gitignore
-
+.gitignore

.gitignore

@@ -5,7 +5,6 @@ logs
 .vscode/*
 */.DS_Store
 .DS_Store
-*/.vscode
 .idea
 # Coverage directory used by tools like istanbul
 coverage
@@ -36,4 +35,3 @@ docs/.vuepress/.temp/
 docs/.vuepress/dist/
 # TernJS port file
 .tern-port
-/.husky/

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+## 校验commit信息
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+
+## 代码、文档校验
+npx lint-staged

.lintstagedrc.js

@@ -1,5 +1,7 @@
-// 参考： https://www.npmjs.com/package/lint-staged#configuration
-// 对add的内容格式化后再commit
+/**
+ * 对add的内容格式化后再commit
+ * 参考： https://www.npmjs.com/package/lint-staged#configuration
+ */
 module.exports = {
   "*.{js,ts,md}":[
     "./scripts/lint --fix",

.markdownlint.js

@@ -1,4 +1,7 @@
-// 参考：<https://github.com/updownpress/markdown-lint/tree/master/rules>
+/**
+ * markdownlint-cli格式化markdown文档
+ * 规则参考：https://github.com/updownpress/markdown-lint/tree/master/rules
+ */
 module.exports = {
   "default": true,
   "MD001": false,

.versionrc.js

@@ -1,5 +1,9 @@
-// commit-and-tag-version 配置，参考：https://github.com/conventional-changelog/standard-version
-// 配置参考：https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md
+/**
+ *
+ * commit-and-tag-version 模块配置提交、标签功能
+ * - 使用：https://github.com/conventional-changelog/standard-version
+ * - 配置：https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md
+ */
 module.exports = {
   header: '# Release history\n\nAll notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.\n\n<!-- #region recent-alpha -->\n',
   releaseCommitMessageFormat: 'chore(release): publish v{{currentTag}}',

Dockerfile

@@ -23,6 +23,8 @@ RUN if [ "$CONTAINER_BUILD" = "true" ]; then  \
 
 FROM registry.cn-hangzhou.aliyuncs.com/142vip/nginx:1.23.0-alpine
 
+
+## 自定义镜像的Label信息
 ARG APP_NAME
 ARG APP_VERSION
 ARG AUTHOR

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Chu·Fan
+Copyright (c) 2020 142vip.cn 储凡
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

commitlint.config.js

@@ -1 +1,7 @@
-module.exports = { extends: ['@commitlint/config-conventional'] }
+/**
+ * 校验Git Commit信息格式
+ * 参考：https://commitlint.js.org
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+}