Repository navigation
fix(cli): 修复创建页面时配置属性识别 #19561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Single-Dancer
merged 6 commits into
NervJS:main
from
Jarvis636431:fix/cli-config-property-keys
Oct 26, 2026
+328
−9
Merged
fix(cli): 修复创建页面时配置属性识别 #19561
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ce2ca51
fix(cli): handle quoted config keys when creating pages
Jarvis636431 6600101
fix(cli): update the last matching config property
Jarvis636431 0d65b9c
fix(cli): explicitly narrow config object types
Jarvis636431 00a7f4d
fix(cli): reject unresolved config property overrides
Jarvis636431 f71dfca
fix(cli): continue searching past unresolved subpackage roots
Jarvis636431 7d42d01
Merge branch 'main' into fix/cli-config-property-keys
Jarvis636431 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,262 @@ | ||
| import * as os from 'node:os' | ||
| import * as path from 'node:path' | ||
|
|
||
| import { babelKit, fs } from '@tarojs/helper' | ||
|
|
||
| import Page, { ConfigModificationState } from '../create/page' | ||
| import { modifyPagesOrSubPackages } from '../util/createPage' | ||
|
|
||
| // Config updates do not use the native template generator. | ||
| jest.mock('@tarojs/binding', () => ({ | ||
| CompilerType: { Webpack5: 'webpack5' }, | ||
| CSSType: { None: 'none' }, | ||
| FrameworkType: { React: 'react' } | ||
| })) | ||
|
|
||
| function updateConfig (source: string, subPkgRootPath?: string) { | ||
| const ast = babelKit.parse(source, { sourceType: 'module' })! | ||
| const originalCode = babelKit.generate(ast, { compact: true }).code | ||
| const callback = jest.fn() | ||
| babelKit.traverse(ast, { | ||
| ExportDefaultDeclaration (path) { | ||
| modifyPagesOrSubPackages({ | ||
| path, | ||
| fullPagePath: subPkgRootPath ? `${subPkgRootPath}/new/index` : 'pages/new/index', | ||
| subPkgRootPath, | ||
| callback | ||
| }) | ||
| } | ||
| }) | ||
| expect(callback).toHaveBeenCalledTimes(1) | ||
| return { | ||
| state: callback.mock.calls[0][0], | ||
| code: babelKit.generate(ast, { compact: true }).code, | ||
| originalCode | ||
| } | ||
| } | ||
|
|
||
| describe.each(['object', 'defineAppConfig'])('create page config: %s', (format) => { | ||
| const wrap = (config: string) => `export default ${format === 'object' ? config : `defineAppConfig(${config})`}` | ||
|
|
||
| it.each([ | ||
| 'pages: ["pages/home/index"]', | ||
| '"pages": ["pages/home/index"]', | ||
| '...baseConfig, pages: ["pages/home/index"]', | ||
| '...baseConfig, "pages": ["pages/home/index"]', | ||
| 'get pages() { return [] }, "pages": ["pages/home/index"]', | ||
| '[pages]: [], "pages": ["pages/home/index"]' | ||
| ])('appends to explicit pages: %s', (properties) => { | ||
| const result = updateConfig(wrap(`{ ${properties} }`)) | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('["pages/home/index","pages/new/index"]') | ||
| if (properties.includes('...baseConfig')) expect(result.code).toContain('...baseConfig') | ||
| if (properties.includes('[pages]')) expect(result.code).toContain('[pages]:[]') | ||
| }) | ||
|
|
||
| it.each(['pages', '"pages"'])('does not duplicate an existing page: %s', (key) => { | ||
| const result = updateConfig(wrap(`{ ${key}: ["pages/new/index"] }`)) | ||
| expect(result.state).toBe(ConfigModificationState.NeedLess) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| ['"pages"', 'pages'], | ||
| ['pages', '"pages"'], | ||
| ['pages', 'pages'], | ||
| ['"pages"', '"pages"'] | ||
| ])('updates the last pages property: %s followed by %s', (firstKey, lastKey) => { | ||
| const result = updateConfig(wrap(`{ ${firstKey}: ["ignored"], ${lastKey}: ["pages/home/index"] }`)) | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain(`${firstKey}:["ignored"]`) | ||
| expect(result.code).toContain(`${lastKey}:["pages/home/index","pages/new/index"]`) | ||
| }) | ||
|
|
||
| it('checks duplicates in the last pages property', () => { | ||
| const result = updateConfig(wrap('{ "pages": [], pages: ["pages/new/index"] }')) | ||
| expect(result.state).toBe(ConfigModificationState.NeedLess) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it('leaves a nonliteral last pages property unchanged', () => { | ||
| const result = updateConfig(wrap('{ "pages": [], pages: pageList }')) | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| '{}', | ||
| '{ ...baseConfig }', | ||
| '{ pages: pageList }', | ||
| '{ [pages]: [] }', | ||
| '{ ["pages"]: [] }', | ||
| '{ pages() { return [] } }' | ||
| ])('leaves unsupported pages config unchanged: %s', (config) => { | ||
| const result = updateConfig(wrap(config)) | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| 'subPackages: [{ root: "pkg/", pages: ["home/index"] }]', | ||
| '"subPackages": [{ "root": "pkg/", "pages": ["home/index"] }]', | ||
| '...baseConfig, "subPackages": [{ ...subConfig, "root": "pkg/", "pages": ["home/index"] }]', | ||
| 'subPackages: [{ root() {}, root: "pkg/", pages() {}, pages: ["home/index"] }]' | ||
| ])('updates an existing subpackage: %s', (properties) => { | ||
| const result = updateConfig(wrap(`{ ${properties} }`), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('["home/index","new/index"]') | ||
| expect(result.code.match(/"pkg\/"/g)).toHaveLength(1) | ||
| }) | ||
|
|
||
| it('does not duplicate a page in a quoted subpackage config', () => { | ||
| const result = updateConfig(wrap('{ "subPackages": [{ "root": "pkg/", "pages": ["new/index"] }] }'), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.NeedLess) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| '{ "subPackages": [{ root: "ignored/", pages: [] }], subPackages: [{ root: "pkg/", pages: ["home/index"] }] }', | ||
| '{ subPackages: [{ "root": "ignored/", root: "pkg/", pages: ["home/index"] }] }', | ||
| '{ subPackages: [{ root: "pkg/", "pages": ["ignored"], pages: ["home/index"] }] }' | ||
| ])('updates the effective subpackage properties: %s', (config) => { | ||
| const result = updateConfig(wrap(config), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('pages:["home/index","new/index"]') | ||
| expect(result.code).toContain('"ignored') | ||
| expect(result.code.match(/"pkg\/"/g)).toHaveLength(1) | ||
| }) | ||
|
|
||
| it('matches the root property instead of an unrelated string value', () => { | ||
| const result = updateConfig(wrap('{ subPackages: [{ name: "pkg/", root: "other/", pages: [] }, { "root": "pkg/", "pages": ["home/index"] }] }'), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('root:"other/",pages:[]') | ||
| expect(result.code).toContain('"root":"pkg/","pages":["home/index","new/index"]') | ||
| }) | ||
|
|
||
| it('adds a missing subPackages property', () => { | ||
| const result = updateConfig(wrap('{ pages: [] }'), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('subPackages:[{root:"pkg/",pages:["new/index"]}]') | ||
| }) | ||
|
|
||
| it.each([ | ||
| 'pages() {}', | ||
| 'get pages() { return [] }', | ||
| 'set pages(value) {}', | ||
| '[key]: []', | ||
| '...baseConfig' | ||
| ])('does not update pages shadowed by %s', (member) => { | ||
| const result = updateConfig(wrap(`{ pages: [], ${member} }`)) | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| 'subPackages() {}', | ||
| 'get subPackages() { return [] }', | ||
| 'set subPackages(value) {}', | ||
| '[key]: []', | ||
| '...baseConfig' | ||
| ])('does not update or add subPackages shadowed by %s', (member) => { | ||
| for (const properties of [member, `subPackages: [], ${member}`]) { | ||
| const result = updateConfig(wrap(`{ ${properties} }`), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| } | ||
| }) | ||
|
|
||
| it.each([ | ||
| 'root() {}', | ||
| 'get root() { return "pkg/" }', | ||
| 'set root(value) {}', | ||
| '[key]: "pkg/"', | ||
| '...subConfig' | ||
| ])('does not update or add a subpackage with root shadowed by %s', (member) => { | ||
| for (const properties of [`${member}, pages: []`, `root: "pkg/", ${member}, pages: []`]) { | ||
| const result = updateConfig(wrap(`{ subPackages: [{ ${properties} }] }`), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| } | ||
| }) | ||
|
|
||
| it.each([ | ||
| 'pages() {}', | ||
| 'get pages() { return [] }', | ||
| 'set pages(value) {}', | ||
| '[key]: []', | ||
| '...subConfig' | ||
| ])('does not update subpackage pages shadowed by %s', (member) => { | ||
| const result = updateConfig(wrap(`{ subPackages: [{ root: "pkg/", pages: [], ${member} }] }`), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| '{ pages() {}, pages: [] }', | ||
| '{ get pages() { return [] }, pages: [] }', | ||
| '{ set pages(value) {}, pages: [] }', | ||
| '{ [key]: [], pages: [] }', | ||
| '{ ...baseConfig, pages: [] }' | ||
| ])('updates pages when an explicit array overrides earlier members: %s', (config) => { | ||
| const result = updateConfig(wrap(config)) | ||
| expect(result.state).toBe(ConfigModificationState.Success) | ||
| expect(result.code).toContain('pages:["pages/new/index"]') | ||
| }) | ||
|
|
||
| it('does not add a subpackage when an existing root is dynamic', () => { | ||
| const result = updateConfig(wrap('{ subPackages: [{ root: packageRoot, pages: [] }] }'), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
|
|
||
| it.each([ | ||
| '{ "subPackages": subPackages }', | ||
| '{ "subPackages": [{ "root": "pkg/", "pages": pageList }] }' | ||
| ])('leaves nonliteral subpackage configs unchanged: %s', (config) => { | ||
| const result = updateConfig(wrap(config), 'pkg') | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| }) | ||
| }) | ||
|
|
||
| it.each(['defineAppConfig()', 'defineAppConfig(config)', 'defineAppConfig(null)'])( | ||
| 'leaves a non-object config unchanged: %s', (config) => { | ||
| for (const subPkgRootPath of [undefined, 'pkg']) { | ||
| const result = updateConfig(`export default ${config}`, subPkgRootPath) | ||
| expect(result.state).toBe(ConfigModificationState.Fail) | ||
| expect(result.code).toBe(result.originalCode) | ||
| } | ||
| } | ||
| ) | ||
|
|
||
| describe('create page config file updates', () => { | ||
| let projectDir: string | ||
|
|
||
| beforeEach(() => { | ||
| projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'taro-create-page-')) | ||
| jest.spyOn(console, 'log').mockImplementation(() => {}) | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| fs.removeSync(projectDir) | ||
| jest.restoreAllMocks() | ||
| }) | ||
|
|
||
| it.each(['js', 'ts'])('writes the new page to app.config.%s', (extension) => { | ||
| const configPath = path.join(projectDir, 'src', `app.config.${extension}`) | ||
| const baseConfig = extension === 'ts' ? 'const baseConfig: { window?: object } = {}' : 'const baseConfig = {}' | ||
| fs.outputFileSync(configPath, `${baseConfig}\nexport default defineAppConfig({ ...baseConfig, "pages": ["pages/home/index"] })`) | ||
| const page = Object.create(Page.prototype) | ||
| page.conf = { projectDir, typescript: extension === 'ts' } | ||
| page.pageEntryPath = '/src/pages/new/index' | ||
|
|
||
| page.updateAppConfig() | ||
| const updated = fs.readFileSync(configPath, 'utf8') | ||
| expect(updated).toContain('pages/home/index') | ||
| expect(updated).toContain('pages/new/index') | ||
| expect(updated).toContain('...baseConfig') | ||
|
|
||
| page.updateAppConfig() | ||
| expect(fs.readFileSync(configPath, 'utf8')).toBe(updated) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里遇到一个无法确定
root的分包配置时就直接返回了,后面的分包不会再继续检查。比如:
这时
pkg/其实是能确定的,应该可以正常添加页面,但现在会因为前面的rootVar直接失败。之前的逻辑会继续查找,不会受这个无关配置影响。建议先继续检查后面的分包;如果找到了明确匹配的
root就更新它。只有找不到匹配项、又存在无法判断的配置时,再返回失败。最好补一个对应的测试。There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
感谢指出,这里确实不应该在遇到无法确定 root 的分包项时直接结束查找。已在 f71dfca 中修改:
新增 22 个回归用例,覆盖普通对象和 defineAppConfig 两种形式、不确定项位于明确目标之前或之后、未匹配时拒绝新增,以及全部 root 已知时正常新增;同时检查其他配置保持原样。修复前该测试集 10 个失败、133 个通过,修复后 143 个全部通过。CLI 的 tsc 构建、修改文件 ESLint 和 git diff --check 均通过。本轮未重跑 CLI 全量测试。
烦请复查。