Skip to content

fix: use basename(workspace) instead of repoName for workspaceFolder #126

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.

Sign up for GitHub

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

Open
sdiazbarraza wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −5
Open

fix: use basename(workspace) instead of repoName for workspaceFolder #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b41507a
fix: use basename(workspace) instead of repoName for workspaceFolder
sdiazbarraza May 8, 2026
2e72543
test(config): add test for basename(workspace) precedence over repoName
sdiazbarraza May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion plugin/core/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ function removePortArgs(runArgs) {
export async function generateOverrideConfig(workspace, port, repoName) {
const baseConfig = await readDevcontainerJson(workspace) || {}
const internalPort = detectInternalPort(baseConfig)
const workspaceName = repoName || basename(workspace)
const workspaceName = basename(workspace) || repoName

// Build override config
// Remove forwardPorts and appPort to prevent devcontainer CLI from setting up
Expand Down
23 changes: 19 additions & 4 deletions test/unit/config.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,22 +169,37 @@ describe('generateOverrideConfig', () => {
assert.ok(override.name.includes('13003'))
})

test('sets correct workspaceFolder using repoName', async () => {
test('uses basename(workspace) for workspaceFolder', async () => {
// When workspace path is provided, basename(workspace) is used for workspaceFolder
const workspace = join(testDir, 'workspace')
const overridePath = await generateOverrideConfig(workspace, 13004, 'myrepo')

const override = JSON.parse(readFileSync(overridePath, 'utf-8'))
assert.strictEqual(override.workspaceFolder, '/workspaces/myrepo')
// workspaceFolder should use basename(workspace), not repoName
assert.strictEqual(override.workspaceFolder, '/workspaces/workspace')
})

test('falls back to basename when repoName not provided', async () => {
const workspace = join(testDir, 'workspace')
const overridePath = await generateOverrideConfig(workspace, 13004)

const override = JSON.parse(readFileSync(overridePath, 'utf-8'))
assert.strictEqual(override.workspaceFolder, '/workspaces/workspace')
})

test('prefers basename(workspace) over repoName when both provided', async () => {
// When workspace path and repoName are both provided,
// basename(workspace) should take precedence for workspaceFolder
const workspace = join(testDir, 'my-clone')
const overridePath = await generateOverrideConfig(workspace, 13007, 'different-repo-name')

const override = JSON.parse(readFileSync(overridePath, 'utf-8'))
// workspaceFolder should use basename(workspace), not repoName
assert.strictEqual(override.workspaceFolder, '/workspaces/my-clone')
// name should also use basename(workspace)
assert.strictEqual(override.name, 'my-clone (port 13007)')
})

test('handles config without runArgs', async () => {
writeFileSync(
join(testDir, 'workspace', '.devcontainer', 'devcontainer.json'),
Expand Down