Chikamichi 项目教程

1. 项目的目录结构及介绍

chikamichi/
├── .github/
│   └── workflows/
├── dist/
├── node_modules/
├── src/
│   ├── assets/
│   ├── components/
│   ├── content/
│   ├── hooks/
│   ├── lib/
│   ├── pages/
│   ├── styles/
│   ├── types/
│   ├── utils/
│   ├── App.tsx
│   ├── index.tsx
│   └── manifest.json
├── .gitignore
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── vite.config.ts

目录结构介绍

• .github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• dist/: 存放构建后的项目文件。
• node_modules/: 存放项目的依赖包。
• src/: 项目的源代码目录。
  • assets/: 存放静态资源文件，如图片、字体等。
  • components/: 存放 React 组件。
  • content/: 存放项目的内容文件。
  • hooks/: 存放自定义 React Hooks。
  • lib/: 存放项目的库文件。
  • pages/: 存放项目的页面组件。
  • styles/: 存放项目的样式文件。
  • types/: 存放 TypeScript 类型定义文件。
  • utils/: 存放工具函数。
  • App.tsx: 项目的根组件。
  • index.tsx: 项目的入口文件。
  • manifest.json: 项目的浏览器扩展配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• vite.config.ts: Vite 构建工具的配置文件。

2. 项目的启动文件介绍

src/index.tsx

这是项目的入口文件，负责初始化应用并渲染根组件。

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById('root')
);

src/App.tsx

这是项目的根组件，负责管理应用的状态和路由。

import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import Home from './pages/Home';
import About from './pages/About';

function App() {
  return (
    <Router>
      <Switch>
        <Route path="/" exact component={Home} />
        <Route path="/about" component={About} />
      </Switch>
    </Router>
  );
}

export default App;

3. 项目的配置文件介绍

package.json

这是项目的依赖和脚本配置文件，包含了项目的依赖包、脚本命令等信息。

{
  "name": "chikamichi",
  "version": "1.0.0",
  "scripts": {
    "dev": "vite",
    "build": "tsc && vite build",
    "serve": "vite preview"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  },
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3",
    "typescript": "^4.2.4",
    "vite": "^2.3.0"
  }
}

tsconfig.json

这是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "jsx": "react",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"]
}

vite.config.ts

这是 Vite 构建工具的配置文件，定义了 Vite 的构建选项。

import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';

export default defineConfig({
  plugins: [react()],
  build: {
    outDir: 'dist',
    assetsDir: 'assets'
  }
});

manifest.json

这是浏览器扩展的配置文件，定义了扩展的名称、版本、权限等信息。

{
  "manifest_version": 2,
  "name": "Chikamichi",
  "version": "1.0.0",
  "description": "Command pallet for the browser",
  "permissions": ["history", "bookmarks", "tabs"],
  "background": {
    "scripts": ["background.js"]
  },
  "browser_action": {
    "default_popup": "popup.html"
  }
}

以上是 Chikamichi 项目的教程，包含了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！