sorrycc/roadhog được TopGit xếp vào nhóm dự án mã nguồn mở, với 2.7k sao trên GitHub, viết chủ yếu bằng JavaScript. 🐷 Cli tool for creating react apps, configurable version of create-react-app.
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Roadhog is a cli tool with dev、build and test commands. It's based on react-dev-utils and is consistent with the experience of create-react-app. You can imagine this is a configurable version of create-react-app.
Docs
2.0 发布日志
Migrate from 1.x
1.x docs
Features
📦 out of the box React application development tools, built-in css-modules, babel, postcss, HMR, etc.
🐠 create-react-app experience
🚨 webpack configuration in JSON format
🔥 mock
✂️ test based on jest, ui test with enzyme
Getting started
## Install globally or locally
$ npm i roadhog -g
## Check version
$ roadhog -v
2.0.0
## Local development
$ roadhog dev
## Build
$ roadhog build
$ NO_COMPRESS=1 roadhog build
## Test
$ roadhog test
Mock
roadhog dev support mock, configured in .roadhogrc.mock.js.
e.g.
export default {
// Support type as Object and Array
'GET /api/users': { users: [1,2] },
// Method like GET or POST can be omitted
'/api/users/1': { id: 1 },
// Support for custom functions, the API is the same as express@4
'POST /api/users/create': (req, res) => { res.end('OK'); },
};
Use the public directory
Files in the public directory would be copied to the output directory (by default ./dist) on the dev and build. So favicon, iconfont, html, html quoted pictures could be stored here.
Configuration
roadhog's webpack part is based on the af-webpack's implementation. For configuration, create .webpackrc in the project root. The format is JSON, e.g.
{
"externals": { "react": "window.React" }
}
If you prefer JS configuration, or need to do some programming or abstract judgment, you can use .webpackrc.js configuration file, support ES6 syntax, e.g.
suppose your project is multipages, wanting files in src/pages as entries. you can do the followings.
"entry": "src/pages/*.js"
theme
Configure the theme, in fact, with less variables. Support both object and string type, the string needs to point to a file which return configurations.
e.g.
"theme": {
"@primary-color": "#1DA57A"
}
or,
"theme": "./theme-config.js"
define
Pass to code through the webpack's DefinePlugin plugin, the value will automatically be processed with JSON.stringify.
Configuration to build with hash file name, and it's usually used in conjunction with the manifest.
html
Configure html-webpack-plugin plugin.
e.g.
"html": {
"template": "./src/index.ejs"
}
disableCSSModules
Disable CSS Modules,we do not recommend doing this.
disableCSSSourceMap
Disable generate CSS's SourceMap.
extraBabelPresets
Define an additional list of babel presets, the formatt is Array.
extraBabelPlugins
Define an additional list of babel plugins, the formatt is Array.
extraBabelIncludes
Define an additional list of file matches that need to be transformed with babel, the format is Array.
copy
Define a list of files that need to be copied. The format is an array, and the format of the item refers to the configuration of [copy-webpack-plugin] (https://github.com/webpack-contrib/copy-webpack-plugin).
e.g.
"copy": [
{
"from": "",
"to": ""
}
]
proxy
Configure the [proxy] (https://webpack.js.org/configuration/dev-server/#devserver-proxy) property of webpack-dev-server.
Then visit / api / users to access the data from [http://jsonplaceholder.typicode.com/users](http://jsonplaceholder.typicode.com/users].
sass
Configure the options for [node-sass] (https://github.com/sass/node-sass#options). Note: node-sass and sass-loader dependencies must be installed in the project directory when using sass.
manifest
Configure to generate manifest.json, it's option will pass to https://www.npmjs.com/package/webpack-manifest-plugin.
e.g.
"manifest": {
"basePath": "/app/"
}
ignoreMomentLocale
Ignore moment locale file, used to reduce the size.
disableDynamicImport
Disable import () to load on demand, but bundle all the files in a single file, implement via babel-plugin-dynamic-import-node-sync.
env
Set specific options for certain environment. development is for dev, and production is for build.
Thus, extraBabelPlugins in development is ['transform-runtime', 'dva-hmr'], and ['transform-runtime'] in production.
Environment Variables
You can temporarily configure some parameters for environment variables, including:
PORT, default 8000
HOST, default localhost
ANALYZE, whether to analyze the output bundle in roadhog build
ESLINT, set none disable eslint check
TSLINT, set none disable tslint check
COMPRESS, set none to disable file compressing in roadhog build
BROWSER, set none to disable browser open in roadhog dev
e.g. start dev server with port 3000,
# OS X, Linux
$ PORT=3000 roadhog dev
# Windows (cmd.exe)
$ set PORT=3000&&roadhog dev
# Or use cross-env for all platforms
$ cross-env PORT=3000 roadhog dev
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/sorrycc/roadhog là nguồn chính thức.
sorrycc/roadhog có bao nhiêu sao?
sorrycc/roadhog có 2.7k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/sorrycc/roadhog. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
sorrycc/roadhog có phải mã nguồn mở không?
TopGit chưa ghi nhận license cho sorrycc/roadhog. Phần lớn repo public trên GitHub là mã nguồn mở, nhưng điều khoản khác nhau từng repo — mở file LICENSE để xác nhận.
sorrycc/roadhog có website riêng không?
TopGit chưa ghi nhận URL trang chủ cho sorrycc/roadhog. Phần README ở tab phía trên thường có link demo, hoặc xem mô tả GitHub của repo.
sorrycc/roadhog là gì?
sorrycc/roadhog (sorrycc/roadhog) là dự án JavaScript trên GitHub. Theo mô tả gốc: 🐷 Cli tool for creating react apps, configurable version of create-react-app.
Đọc đầy đủ README ở tab phía trên.
roadhog có đáng để bạn bỏ thời gian?
ChatGPT, Claude và Perplexity đều đọc được trang này. Hỏi thử xem họ nghĩ gì về roadhog.