npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@orca-fe/vite-plugin-react-convention-routes

v0.0.11

Published

A vite plugin for react convention routes

Downloads

3

Readme

@orca-fe/vite-plugin-react-convention-routes

一款适用于 react-router-dom@6 的路由插件,可以根据约定的目录结构自动生成路由配置。

插件会生成一份 RouteObject[] 类型的路由配置,你需要使用 @orca-fe/vite-plugin-react-convention-routes/routes 引入。 路由配置可以通过 react-router-dom@6useRoutes 直接生成路由。

import React from 'react';
import ReactDOM from 'react-dom/client';
import { BrowserRouter, useRoutes } from 'react-router-dom';
import '@orca-fe/vite-plugin-react-convention-routes/typing.d';
import routes from 'virtual:convention-routes';

// 生成路由组件
const ConventionRoutes = () => useRoutes(routes);

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <BrowserRouter>
      <ConventionRoutes />
    </BrowserRouter>
  </React.StrictMode>,
);

安装

npm install @orca-fe/vite-plugin-react-convention-routes --save-dev

使用

vite.config.js 中添加插件配置,以下是所有可配置的参数

// vite.config.js
import conventionRoutes from '@orca-fe/vite-plugin-react-convention-routes';

export default {
  plugins: [
    conventionRoutes({
      // 需要扫描的页面根目录,默认为 `src/pages`
      pageRoot: resolve(process.cwd(), 'src/pages'),
      // 是否按需加载,默认为 true
      dynamic: true,
      // 是否支持 `.` 开头的文件,默认为 false (来自 `fast-glob` 的 `dot` 参数)
      dot: false,
      // 扫描目录的深度(来自 `fast-glob` 的 `deep` 参数)
      deep: undefined,
      // 忽略的文件(来自 `fast-glob` 的 `ignore` 参数) 默认规则如下
      ignore: ['**/node_modules/**', '**/components/**', '**/layouts/**', '**/services/**', '**/model/**', '**/hox/**'],
      // 扫描的文件规则(传递给 `fast-glob`) 默认规则如下
      globRule: ['*.{js,jsx,ts,tsx}', '**/*.{js,jsx,ts,tsx}'],
      // 对扫描到的文件进行过滤,默认不过滤
      filter: (path) => true,
      // 标记需要作为 layout 的文件,默认识别文件名为 `_layout` 的文件。
      isLayout: (path) => basename(path.split('.').slice(0, -1)
        .join('.')) === '_layout',
      // 标记需要作为 index 的文件,默认识别文件名为 `index` 的文件。
      isIndex: (path) => basename(path.split('.').slice(0, -1)
        .join('.')) === 'index',
      // 根据文件路径生成路由路径,默认为 `path => path`
      transform: subPath => subPath,
    }),
  ],
};

main.tsx 中引入路由配置 @orca-fe/vite-plugin-react-convention-routes/routes 并使用 useRoutes 生成一个路由组件。 接下来你就可以在 App 组件中使用该路由组件了。

import React from 'react';
import ReactDOM from 'react-dom/client';
import { BrowserRouter, useRoutes } from 'react-router-dom';
import routes from '@orca-fe/vite-plugin-react-convention-routes/routes';

// 生成路由组件
const ConventionRoutes = () => useRoutes(routes);

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <BrowserRouter>
      <ConventionRoutes />
    </BrowserRouter>
  </React.StrictMode>,
);

404 页面

如果需要自定义 404 页面,可以在 src/pages 目录下创建 404 文件,插件会自动将其作为 404 页面。当路由无法匹配到页面文件时,就会渲染该页面。

动态路由

兼容 [email protected] 的动态路由规则

$ 前缀的目录或文件为动态路由。若 $ 后不指定参数名,则代表 * 通配,比如:

  • src/pages/users/$id.tsx 会成为 /users/:id
  • src/pages/users/$id/settings.tsx 会成为 /users/:id/settings

兼容 [email protected] 的动态路由规则

约定 [] 包裹的文件或文件夹为动态路由。

比如:

  • src/pages/users/[id].tsx 会成为 /users/:id
  • src/pages/users/[id]/settings.tsx 会成为 /users/:id/settings

嵌套路由

约定目录下有 _layout.tsx 时会生成嵌套路由,以 _layout.tsx 为该目录的 layoutlayout 文件需要返回一个 React 组件,并通过 props.children 渲染子组件。

.
└── pages
    └── users
        ├── _layout.tsx
        ├── index.tsx
        └── list.tsx

注意:你可以通过 isLayout 配置,来自定义哪些文件需要作为 layout。默认为 _layout

全局 layout

umijs 不同,你可以在 src/pages 目录下创建 _layout.tsx,作为全局的 layout。而不是 src/layouts

配置推荐

// vite.config.js
import conventionRoutes from '@orca-fe/vite-plugin-react-convention-routes';
import { paramCase } from 'change-case';

export default {
  plugins: [
    conventionRoutes({
      // 只扫描 404, index 和 _layout 文件,其他文件都不作为路由入口,这样可以避免一些不必要的路由生成,也使得路由更加清晰
      filter: path => /^(.*\/)?(index|_layout|404)\.(j|t)sx?$/.test(path),
      // 规范路由路径,避免出现大写字母和下划线
      transform: paramCase,
    }),
  ],
};