Skip to content

fix(plugin): rename aux generator paths reserved on Windows - #94

Open
qagwaai wants to merge 1 commit into
angular-threejs:mainfrom
qagwaai:Windows-aux-directory-rename
Open

qagwaai wants to merge 1 commit into
angular-threejs:mainfrom
qagwaai:Windows-aux-directory-rename

Conversation

@qagwaai

@qagwaai qagwaai commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

Problem

Cloning this repository on Windows fails:

error: invalid path 'libs/plugin/src/generators/aux/aux.ts'
fatal: unable to checkout working tree

AUX is a reserved device name on Windows, and the restriction applies to a path segment's basename before its extension — so both the directory src/generators/aux/ and the file aux.ts inside it are invalid paths.

The clone aborts partway through, leaving the working tree unusable. Windows contributors currently have to set core.protectNTFS=false to check the repo out at all, which is a workaround rather than a fix.

Change

Before After
src/generators/aux/aux.ts src/generators/auxiliary/auxiliary.ts
src/generators/aux/compat.ts src/generators/auxiliary/compat.ts
src/generators/aux/schema.json src/generators/auxiliary/schema.json

Factory/schema paths in generators.json and the relative import in compat.ts are updated to match.

Note: renaming only the directory is not sufficient — aux.ts on its own is still an invalid path. Both had to change.

No public API impact

The generator remains registered under the name aux in generators.json, so consumers invoke it exactly as before:

nx g angular-three-plugin:aux

Only internal file paths change. The schematics (Angular CLI compat) entry is updated in lockstep.

Validation

Performed on Windows with core.protectNTFS at its default (true):

  • Reproduced the failure by cloning at the previous commit — fails as above.
  • Verified a directory-only rename still fails on auxiliary/aux.ts, confirming the file rename is required.
  • Clone of the fixed tree succeeds — exit 0, clean working tree, all 940 files checked out.
  • nx build plugin passes, and dist/ contains auxiliary/auxiliary.js, compat.js, and schema.json.
  • All 8 generator entries (4 generators + 4 schematics) resolve from the built output: each factory loads and exports a callable default, and each schema parses as valid JSON.
  • Scanned the entire tree for remaining reserved names (CON, PRN, AUX, NUL, COM0-9, LPT0-9) — none left.

Note on plugin:test

migrate-tweakpane.spec.ts fails via a 5s timeout, but this is pre-existing and unrelated — it fails identically on an unmodified checkout of main (the generator takes ~9-14s on Windows). Left untouched so as not to mix concerns into this PR.

`AUX` is a reserved device name on Windows, and the restriction applies
to a path segment's basename before its extension. Both the directory
`src/generators/aux/` and the file `aux.ts` within it were therefore
invalid paths, causing `git clone` to fail on Windows with
"error: invalid path" and leaving the working tree unusable.

Rename the directory to `auxiliary/` and the file to `auxiliary.ts`, and
update the factory paths in `generators.json` plus the import in
`compat.ts` to match.

The generator is still registered under the name `aux`, so consumers
continue to invoke it as `nx g angular-three-plugin:aux`. Only internal
file paths change, so there is no public API impact.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for angularthreesoba ready!

Name Link
🔨 Latest commit b0cfaf5
🔍 Latest deploy log https://app.netlify.com/projects/angularthreesoba/deploys/6ab94cc08b13c400080648db
😎 Deploy Preview https://deploy-preview-94--angularthreesoba.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for angularthreedemo ready!

Name Link
🔨 Latest commit b0cfaf5
🔍 Latest deploy log https://app.netlify.com/projects/angularthreedemo/deploys/6ab94cc0bd664c0008cb8218
😎 Deploy Preview https://deploy-preview-94--angularthreedemo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant