Browse Source

Format rep

dufu1991 3 years ago
parent
commit
5c51553535
10 changed files with 114 additions and 35 deletions
  1. 74 1
      .eslintignore
  2. 26 0
      .eslintrc
  3. 0 15
      .eslintrc.cjs
  4. 0 10
      .eslintrcdfd
  5. 3 2
      .prettierrc
  6. 1 1
      demo/src/App.svelte
  7. 1 1
      doc/guide/contribution.md
  8. 1 1
      doc/guide/contribution_en.md
  9. 1 2
      doc/guide/milestone.md
  10. 7 2
      package.json

+ 74 - 1
.eslintignore

@@ -1 +1,74 @@
-node_modules
+/.idea
+/.vscode
+
+.DS_Store
+/node_modules
+pnpm-lock.yaml
+/scripts
+
+# 忽略 demo 相关文件 ignore demo related files
+/demo/node_modules
+/demo/dist
+/demo/dist-ssr
+/demo/*.local
+/demo/.vscode
+/demo/deploy.js
+/demo/Refresh.py
+/demo/RefreshAndPredload.log
+/demo/pnpm-lock.yaml
+/demo/public/fonts
+
+# 忽略全部 site 和 publish 文件
+/site
+publish.md
+publish_en.md
+
+# 忽略 packages 中 stdf 本地构建的文件 ignore the files built by stdf in packages
+/packages/stdf/pnpm-lock.yaml
+/packages/stdf/node_modules
+/packages/stdf/dist
+
+# 忽略 packages 中 create-stdf 本地构建的文件 ignore the files built by create-stdf in packages
+/packages/create-stdf/pnpm-lock.yaml
+/packages/create-stdf/node_modules
+/packages/create-stdf/dist
+
+# 忽略 packages 中 create-stdf 模板中的 node_modules ignore node_modules in create-stdf templates
+/packages/create-stdf/templates/vite-tailwind/node_modules
+/packages/create-stdf/templates/vite-tailwind/pnpm-lock.yaml
+/packages/create-stdf/templates/vite-tailwind/public/fonts
+/packages/create-stdf/templates/vite-tailwind/dist
+
+/packages/create-stdf/templates/vite-uno/node_modules
+/packages/create-stdf/templates/vite-uno/pnpm-lock.yaml
+/packages/create-stdf/templates/vite-uno/public/fonts
+/packages/create-stdf/templates/vite-uno/dist
+
+/packages/create-stdf/templates/sveltekit-tailwind/node_modules
+/packages/create-stdf/templates/sveltekit-tailwind/pnpm-lock.yaml
+/packages/create-stdf/templates/sveltekit-tailwind/static/fonts
+/packages/create-stdf/templates/sveltekit-tailwind/static/symbols
+/packages/create-stdf/templates/sveltekit-tailwind/.svelte-kit
+
+/packages/create-stdf/templates/sveltekit-uno/node_modules
+/packages/create-stdf/templates/sveltekit-uno/pnpm-lock.yaml
+/packages/create-stdf/templates/sveltekit-uno/static/fonts
+/packages/create-stdf/templates/sveltekit-uno/static/symbols
+/packages/create-stdf/templates/sveltekit-uno/.svelte-kit
+
+# 忽略 packages 中 rollup-plugin-stdf-icon 本地构建的文件 ignore the files built by rollup-plugin-stdf-icon in packages
+/packages/rollup-plugin-stdf-icon/pnpm-lock.yaml
+/packages/rollup-plugin-stdf-icon/node_modules
+/packages/rollup-plugin-stdf-icon/dist
+
+# 忽略 packages 中 vscode-extension 本地构建的文件 ignore the files built by vscode-extension in packages
+/packages/vscode-extension/pnpm-lock.yaml
+/packages/vscode-extension/node_modules
+/packages/vscode-extension/.vscode
+/packages/vscode-extension/.vscodeignore
+/packages/vscode-extension/src/doc
+/packages/vscode-extension/src/menuList.js
+
+
+
+

+ 26 - 0
.eslintrc

@@ -0,0 +1,26 @@
+{
+	"root": true,
+	"extends": [
+		"eslint:recommended",
+		"plugin:svelte/recommended",
+		"plugin:markdown/recommended",
+		"plugin:json/recommended",
+		"plugin:prettier/recommended"
+	],
+	"parserOptions": {
+		"sourceType": "module",
+		"ecmaVersion": 2020,
+		"extraFileExtensions": [".svelte", ".json", ".md"]
+	},
+	"rules": {},
+	"env": {
+		"browser": true,
+		"es6": true,
+		"node": true
+	},
+	"overrides": [
+		{
+			"files": "*.svelte"
+		}
+	]
+}

+ 0 - 15
.eslintrc.cjs

@@ -1,15 +0,0 @@
-// JavaScript Project
-module.exports = {
-	root: true,
-	extends: ['eslint:recommended', 'plugin:svelte/recommended', 'prettier'],
-	parserOptions: {
-		sourceType: 'module',
-		ecmaVersion: 2020,
-		extraFileExtensions: ['.svelte', '.json'],
-	},
-	env: {
-		browser: true,
-		es2017: true,
-		node: true,
-	},
-};

+ 0 - 10
.eslintrcdfd

@@ -1,10 +0,0 @@
-{
-	"root": true,
-	"env": {
-		"es2022": true
-	},
-	"extends": ["plugin:prettier/recommended", "plugin:svelte/recommended"],
-	"rules": {
-		"comma-dangle": ["error", "always-multiline"]
-	}
-}

+ 3 - 2
.prettierrc

@@ -3,6 +3,7 @@
 	"singleQuote": true,
 	"trailingComma": "all",
 	"printWidth": 140,
-	"arrowParens": "avoid",
-	"plugins": ["prettier-plugin-svelte"]
+	"plugins": ["prettier-plugin-svelte"],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }],
+	"arrowParens": "avoid"
 }

+ 1 - 1
demo/src/App.svelte

@@ -74,7 +74,7 @@
 				? isZh
 					? 'STDF 示例'
 					: 'STDF Demo'
-				: menuListArr.filter((item) => item.nav === $location.substring(1))[0][isZh ? 'title_zh' : 'title_en'] + (isZh ? '示例' : ' Demo')}
+				: menuListArr.filter(item => item.nav === $location.substring(1))[0][isZh ? 'title_zh' : 'title_en'] + (isZh ? '示例' : ' Demo')}
 			rightSlot
 			on:clickleft={toHomeFun}
 			injClass="bg-white/60 dark:bg-gray1/60 backdrop-blur"

+ 1 - 1
doc/guide/contribution.md

@@ -19,7 +19,7 @@
 
 按照下面的步骤操作,即可在本地快速启动 STDF Demo。
 
->由于 Demo 依赖的 stdf 和 rollup-plugin-stdf-icon 包都是本地构建的,所以请先构建一下这两个包。
+> 由于 Demo 依赖的 stdf 和 rollup-plugin-stdf-icon 包都是本地构建的,所以请先构建一下这两个包。
 
 ```bash
 ## 克隆 STDF 仓库

+ 1 - 1
doc/guide/contribution_en.md

@@ -19,7 +19,7 @@ Debugging STDF requires an engineering environment. For this purpose, a simple D
 
 Follow the steps below to quickly start the STDF Demo locally.
 
->Because the stdf and rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build these two packages first.
+> Because the stdf and rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build these two packages first.
 
 ```bash
 ## Clone STDF repository

+ 1 - 2
doc/guide/milestone.md

@@ -1,7 +1,6 @@
 ## 2023-08-24
 
-完成 STDF 配套的模板脚手架 [create-stdf](https://www.npmjs.com/package/create-stdf),Vite/Rollup 插件 [rollup-plugin-stdf-icon
-](https://www.npmjs.com/package/rollup-plugin-stdf-icon),VS Code 插件 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)。
+完成 STDF 配套的模板脚手架 [create-stdf](https://www.npmjs.com/package/create-stdf),Vite/Rollup 插件 [rollup-plugin-stdf-icon](https://www.npmjs.com/package/rollup-plugin-stdf-icon),VS Code 插件 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)。
 
 ## 2023-07-23
 

+ 7 - 2
package.json

@@ -8,14 +8,19 @@
 	},
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
-		"lint": "eslint --ext .svelte,.js,.md ./packages/stdf --max-warnings 0",
-		"format": "prettier --write --plugin prettier-plugin-svelte ./packages/stdf/components "
+		"lint": "eslint --ext .svelte,.js,.json ./demo",
+		"format": "prettier --write ./demo/**/*.{js,json,svelte,ts,css,html,cjs,md}  ",
+		"check": "prettier ./demo --check",
+		"lint-md": "lint-md ./**/*"
 	},
 	"author": "",
 	"license": "ISC",
 	"devDependencies": {
+		"@lint-md/cli": "^2.0.0",
 		"eslint": "^8.48.0",
 		"eslint-config-prettier": "^9.0.0",
+		"eslint-plugin-json": "^3.1.0",
+		"eslint-plugin-markdown": "^3.0.1",
 		"eslint-plugin-prettier": "^5.0.0",
 		"eslint-plugin-svelte": "^2.33.0",
 		"prettier-plugin-svelte": "^3.0.3",