umijs/dumi

bug: menu render unexpect when docs dir path include `enum`

Open

#871 opened on Sep 11, 2021

View on GitHubContributor guide
 (7 comments) (0 reactions) (0 assignees)JavaScript (1,169 forks)github user discovery
buggood first issuesomeone working on it

Repository metrics

Stars
 (3,797 stars)
PR merge metrics
 (Avg merge 4h 27m) (21 merged PRs in 30d)

Description

Versions

  • dumi:1.1.26
  • node:14.16.1
  • npm:6.14.12
  • OS:MacBook Pro (13-inch, M1, 2020)
  • Browser:Google Chrome 93.0.4577.63 (arm64)

Steps to reproduce

  1. Create a folder named with enum in the docs directory, like this:
docs
├── docs
│   └── enum
│       ├── ListCard.en.md
│       └── ListCard.md
├── index.en.md
└── index.md

With locale config:

locales: [
  ['zh', '中文'],
  ['en', 'English'],
],
  1. Click locale bar changing current language, enum menu render error:

Living demo: https://saber2pr-umi.github.io/test-dumi-enum/en/docs/enum/list-card

Demo source code: https://github.com/saber2pr-umi/test-dumi-enum

What is Expected?

  • The menu path can contain enum words

  • In Chinese, only the Chinese menu is displayed

  • In English, only the English menu is displayed

What is actually happening?

living.gif

Contributor guide

Research direction
Investigate how dumi generates routes from docs directory structure, specifically handling of directory names that conflict with JavaScript reserved words like 'enum'.
Tech stack
javascripttypescriptreact
Domain
frontendtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65