Rollback docs addition - #5
Merged
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit bb74112
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗ ☁️ Nx Cloud last updated this comment at |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
It introduces a functional issue around package.json patching/exports for generated libs and significantly reduces effective test coverage by skipping/removing key tests.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR rolls back the previously added documentation website and related tooling, returning the repo to a packages-only Nx workspace focused on the nx-workspace-tools plugin.
Changes:
- Remove the
websiteandwebsite-e2eapps and associated Vue/Vite/Playwright configuration and dependencies. - Simplify workspace configuration to a
packages/*layout (TypeScript project references + pnpm workspace). - Refactor feature-libs generator utilities (move
addInternalDepsToPackageJsonintofile-helpers) and adjust/disable tests.
File summaries
| File | Description |
|---|---|
| tsconfig.json | Remove TS solution references to deleted apps. |
| pnpm-workspace.yaml | Restrict workspace packages to packages/*. |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/string-helpers.spec.ts | Reword test names (no functional change). |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/patch-file.spec.ts | Replace prior tests with it.todo (coverage reduced). |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/library-generators.ts | Update import to use file-helpers for internal deps. |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/library-generators.spec.ts | Update mock/import path to file-helpers. |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/file-helpers.ts | Add ensurePackageJson and call it before updating deps. |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/file-helpers.spec.ts | Add placeholder it.todo spec file (no coverage yet). |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/context.spec.ts | Reword test name (no functional change). |
| packages/nx-workspace-tools/src/generators/feature-libs/utils/add-internal-deps.spec.ts | Remove prior tests for internal deps helper. |
| packages/nx-workspace-tools/src/generators/feature-libs/feature-libs.spec.ts | Rewrite generator tests and mark suite describe.skip. |
| packages/nx-workspace-tools/src/executors/internal-deps/internal-deps.spec.ts | Reword test names (no functional change). |
| packages/nx-workspace-tools/package.json | Add nx dependency entry. |
| package.json | Remove website/Vue/Playwright-related deps from the repo root. |
| nx.json | Remove Vite/Playwright plugins; simplify release config. |
| eslint.config.mjs | Drop Vue file targeting; simplify ignore list. |
| CHANGELOG.md | Minor formatting adjustment. |
| apps/website/vite.config.mts | Delete website Vite config (website removal). |
| apps/website/tsconfig.spec.json | Delete website test TS config (website removal). |
| apps/website/tsconfig.json | Delete website TS solution config (website removal). |
| apps/website/tsconfig.app.json | Delete website app TS config (website removal). |
| apps/website/src/vue-shims.d.ts | Delete Vue shim (website removal). |
| apps/website/src/styles.css | Delete website styles (website removal). |
| apps/website/src/main.ts | Delete website entrypoint (website removal). |
| apps/website/src/app/utils/docs-content.ts | Delete docs content source (website removal). |
| apps/website/src/app/components/TocNav.vue | Delete component (website removal). |
| apps/website/src/app/components/SectionBlock.vue | Delete component (website removal). |
| apps/website/src/app/components/HeroSection.vue | Delete component (website removal). |
| apps/website/src/app/components/FeatureCard.vue | Delete component (website removal). |
| apps/website/src/app/components/DocumentationMain.vue | Delete component (website removal). |
| apps/website/src/app/components/DocItem.vue | Delete component (website removal). |
| apps/website/src/app/components/CodeSnippet.vue | Delete component (website removal). |
| apps/website/src/app/components/AppHeader.vue | Delete component (website removal). |
| apps/website/src/app/components/AppFooter.vue | Delete component (website removal). |
| apps/website/src/app/App.vue | Delete website root component (website removal). |
| apps/website/src/app/App.spec.ts | Delete website unit test (website removal). |
| apps/website/package.json | Delete website project manifest (website removal). |
| apps/website/index.html | Delete website HTML entry (website removal). |
| apps/website/eslint.config.mjs | Delete website ESLint config (website removal). |
| apps/website-e2e/tsconfig.json | Delete e2e TS config (e2e removal). |
| apps/website-e2e/src/example.spec.ts | Delete Playwright test (e2e removal). |
| apps/website-e2e/playwright.config.mts | Delete Playwright config (e2e removal). |
| apps/website-e2e/package.json | Delete e2e project manifest (e2e removal). |
| apps/website-e2e/eslint.config.mjs | Delete e2e ESLint config (e2e removal). |
| .vscode/extensions.json | Remove Playwright extension recommendation. |
| .prettierrc | Remove singleAttributePerLine option. |
| .gitignore | Stop ignoring some previously generated website/test artifacts. |
| .github/workflows/publish.yml | Remove GitHub Pages build/deploy steps; publish packages only. |
Review details
Suppressed comments (1)
packages/nx-workspace-tools/src/generators/feature-libs/utils/file-helpers.ts:26
- ensurePackageJson currently creates a package.json with an empty "exports" object. Because runGenericPatch/patchPackageJson runs before addInternalDepsToPackageJson, patchPackageJson will no-op when package.json doesn't exist yet, leaving the generated library without the expected exports map.
- Files reviewed: 44/49 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| expect(tree.exists('libs/my-lib/missing.txt')).toBe(false); | ||
| }); | ||
| }); | ||
| it.todo('@TODO write specs'); |
| @@ -0,0 +1 @@ | |||
| it.todo('@TODO write specs'); | |||
| import { FeatureLibsGeneratorSchema } from './schema'; | ||
|
|
||
| describe('featureLibsGenerator', () => { | ||
| describe.skip('feature-libs generator', () => { |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.