开源项目 rackt/history
使用教程
history项目地址:https://gitcode.com/gh_mirrors/hist/history
1. 项目的目录结构及介绍
history/
├── dist/
│ ├── history.js
│ └── history.min.js
├── docs/
│ ├── api-reference.md
│ └── getting-started.md
├── examples/
│ ├── basic.html
│ └── advanced.html
├── src/
│ ├── createBrowserHistory.js
│ ├── createHashHistory.js
│ ├── createMemoryHistory.js
│ └── index.js
├── .babelrc
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js
dist/
: 包含编译后的文件,如history.js
和history.min.js
。docs/
: 包含项目的文档,如 API 参考和入门指南。examples/
: 包含示例文件,展示如何使用history
库。src/
: 包含源代码文件,如createBrowserHistory.js
、createHashHistory.js
和createMemoryHistory.js
。.babelrc
: Babel 配置文件。.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证。package.json
: 项目依赖和脚本配置。README.md
: 项目介绍和使用说明。webpack.config.js
: Webpack 配置文件。
2. 项目的启动文件介绍
项目的入口文件是 src/index.js
,它导出了 createBrowserHistory
、createHashHistory
和 createMemoryHistory
等函数。这些函数用于创建不同类型的历史记录管理器。
// src/index.js
export { default as createBrowserHistory } from './createBrowserHistory';
export { default as createHashHistory } from './createHashHistory';
export { default as createMemoryHistory } from './createMemoryHistory';
3. 项目的配置文件介绍
package.json
: 包含了项目的依赖、脚本和其他元数据。
{
"name": "history",
"version": "4.10.1",
"description": "Manage session history with JavaScript",
"main": "dist/history.js",
"scripts": {
"build": "webpack",
"test": "jest"
},
"dependencies": {
"invariant": "^2.2.4",
"loose-envify": "^1.4.0",
"warning": "^4.0.3"
},
"devDependencies": {
"babel-core": "^6.26.3",
"babel-loader": "^7.1.5",
"babel-preset-env": "^1.7.0",
"jest": "^23.6.0",
"webpack": "^4.26.1",
"webpack-cli": "^3.1.2"
},
"license": "MIT"
}
webpack.config.js
: 包含了 Webpack 的配置,用于构建项目。
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
filename: 'history.js',
path: path.resolve(__dirname, 'dist'),
libraryTarget: 'umd',
globalObject: 'this'
},
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader'
}
}
]
}
};
以上是 rackt/history
项目的基本使用教程,包含了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助!