feat: refactor project

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc

@@ -0,0 +1,55 @@
+{
+  "plugins": ["prettier"],
+  "extends": ["next", "next/core-web-vitals", "prettier"],
+  "rules": {
+    "prettier/prettier": "error",
+    "camelcase": "off",
+    "import/prefer-default-export": "off",
+    "react/jsx-filename-extension": "off",
+    "react/jsx-props-no-spreading": "off",
+    "react/no-unused-prop-types": "off",
+    "react/require-default-props": "off",
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "ts": "never",
+        "tsx": "never",
+        "js": "never",
+        "jsx": "never"
+      }
+    ],
+    "quotes": "off",
+    "jsx-a11y/anchor-is-valid": [
+      "error",
+      {
+        "components": ["Link"],
+        "specialLink": ["hrefLeft", "hrefRight"],
+        "aspects": ["invalidHref", "preferButton"]
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": "**/*.+(ts|tsx)",
+      "parser": "@typescript-eslint/parser",
+      "plugins": ["@typescript-eslint/eslint-plugin"],
+      "extends": ["plugin:@typescript-eslint/recommended", "prettier"],
+      "rules": {
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "no-use-before-define": [0],
+        "@typescript-eslint/no-use-before-define": [1],
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/quotes": [
+          2,
+          "backtick",
+          {
+            "avoidEscape": true
+          }
+        ]
+      }
+    }
+  ]
+}

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: Check PR
+
+on: [ pull_request ]
+
+jobs:
+  run-ci:
+
+    name: Run Type Check & Linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install dependencies (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Check types
+        run: yarn type-check
+
+      - name: Check linting
+        run: yarn lint
+
+      - name: Check commits messages
+        uses: wagoid/commitlint-github-action@v4

.gitignore

@@ -0,0 +1,39 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# JetBrains IDE files
+.idea/
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+tsconfig.tsbuildinfo
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn commitlint --edit $1

.husky/common.sh

@@ -0,0 +1,8 @@
+command_exists () {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Workaround for Windows 10, Git Bash and Yarn
+if command_exists winpty && test -t 1; then
+  exec < /dev/tty
+fi

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn lint-staged

.npmrc

@@ -0,0 +1 @@
+save-exact = true

.nvmrc

@@ -0,0 +1 @@
+12.22

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2
+}

README.md

@@ -16,40 +16,40 @@
 ## 更新日志 
 
 今日（**2022-4-16**）：
-- [阿里巴巴大牛亲身经历分享：EB1, NIW, O1...如何在国内申请美国绿卡](润学实例/计算机/如何在国内申请美国绿卡.md)
-- [更新润学方法论](润学方法论/README.md)
+- [阿里巴巴大牛亲身经历分享：EB1, NIW, O1...如何在国内申请美国绿卡](docs/润学实例/计算机/如何在国内申请美国绿卡.md)
+- [更新润学方法论](docs/润学方法论/README.md)
 
 过往更新（不完全版）：
-- [润学感悟之润文解字](润学感悟/润文解字.md)
-- [10043润美方法](润学实例/10043学校如何润/10043润美方法.md)
-- [方舱医院现状](新冠疫情相关/新闻/README.md)
-- [上海疫情逝者名单](新冠疫情相关/上海疫情逝者名单.md)
-- [我为什么要润：基本哲学概念合集](哲学概念)
-- [人口问题相关](人口问题相关)
-- [冷锋吴京：一些常见的计算机去美国问题总结（含10043问题）](润学实例/计算机/一些常见的计算机去美国问题总结.md)
-- [加拿大各省提名具体要求](润学方法论/各国选择/加拿大/加拿大各省提名具体要求.md)
-- [添加北邮和中科大的飞跃手册](润学方法论/飞跃手册/README.md)
-- [芬兰留学移民优缺点](润学方法论/各国选择/西欧北欧/芬兰留学移民优缺点.md)
-- [北美王探长：拿EB1, EB2, L1可能比你想象的要更简单](润学方法论/各国选择/美国/王探长谈为什么来了就是美国人.md)
-- [硕士秋招SDE找工时间线总结](润学实例/计算机/硕士秋招SDE找工时间线总结.md)
-- [冷锋吴京：如何去美国当程序员](润学实例/计算机/去美国当程序员V2.5.0.md)
-- [美国如果没抽到H1B怎么办](润学方法论/各国选择/美国/没抽到H1B怎么办.md)
-- [海专精算比我懂更比你懂](张维为陈平曹丰泽等知名言论收集/海专精算比我懂更比你懂.jpg)
-- [出国经历之：浙大本科美国三本弗罗里达数据工程师](润学实例/计算机/浙大本科美国三本弗罗里达数据工程师.md)
+- [润学感悟之润文解字](docs/润学感悟/润文解字.md)
+- [10043润美方法](docs/润学实例/10043学校如何润/10043润美方法.md)
+- [方舱医院现状](docs/新冠疫情相关/新闻/README.md)
+- [上海疫情逝者名单](docs/新冠疫情相关/上海疫情逝者名单.md)
+- [我为什么要润：基本哲学概念合集](docs/哲学概念)
+- [人口问题相关](docs/人口问题相关)
+- [冷锋吴京：一些常见的计算机去美国问题总结（含10043问题）](docs/润学实例/计算机/一些常见的计算机去美国问题总结.md)
+- [加拿大各省提名具体要求](docs/润学方法论/各国选择/加拿大/加拿大各省提名具体要求.md)
+- [添加北邮和中科大的飞跃手册](docs/润学方法论/飞跃手册/README.md)
+- [芬兰留学移民优缺点](docs/润学方法论/各国选择/西欧北欧/芬兰留学移民优缺点.md)
+- [北美王探长：拿EB1, EB2, L1可能比你想象的要更简单](docs/润学方法论/各国选择/美国/王探长谈为什么来了就是美国人.md)
+- [硕士秋招SDE找工时间线总结](docs/润学实例/计算机/硕士秋招SDE找工时间线总结.md)
+- [冷锋吴京：如何去美国当程序员](docs/润学实例/计算机/去美国当程序员V2.5.0.md)
+- [美国如果没抽到H1B怎么办](docs/润学方法论/各国选择/美国/没抽到H1B怎么办.md)
+- [海专精算比我懂更比你懂](docs/张维为陈平曹丰泽等知名言论收集/海专精算比我懂更比你懂.jpg)
+- [出国经历之：浙大本科美国三本弗罗里达数据工程师](docs/润学实例/计算机/浙大本科美国三本弗罗里达数据工程师.md)
 
 ## 阅读大纲
 
-请从阅读 [润学纲领](润学纲领.md) 开始, 或者查看 [润学感悟](润学感悟)
+请从阅读 [润学纲领](docs/润学纲领.md) 开始, 或者查看 [润学感悟](docs/润学感悟)
 
-- 关于**为什么润**的理论部分会被分类整理到 [哲学概念](哲学概念)
+- 关于**为什么润**的理论部分会被分类整理到 [哲学概念](docs/哲学概念)
 
-- 关于**润哪里**，可以移步 [润学方法论/各国选择](润学方法论/各国选择)
+- 关于**润哪里**，可以移步 [润学方法论/各国选择](docs/润学方法论/各国选择)
 
-    - 美国签证顺序和常见问题：[润学方法论/各国选择/美国](润学方法论/各国选择/美国)
+    - 美国签证顺序和常见问题：[润学方法论/各国选择/美国](docs/润学方法论/各国选择/美国)
 
-- 关于**怎么润**，请参考全球润友自身的经历 [润学实例](润学实例)：
+- 关于**怎么润**，请参考全球润友自身的经历 [润学实例](docs/润学实例)：
 
-最后，茶余饭后，博君一笑，可以访问 [咱们赢麻了知名言论合集](张维为陈平曹丰泽等知名言论收集)
+最后，茶余饭后，博君一笑，可以访问 [咱们赢麻了知名言论合集](docs/张维为陈平曹丰泽等知名言论收集)
 
 ## 鸣谢