Skip to content
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

feat(testing): renamed cypress-e2e-configuration to configuration to maintain consistency between plugins #17998

Merged
merged 1 commit into from
Jul 7, 2023

Conversation

jaysoo
Copy link
Member

@jaysoo jaysoo commented Jul 6, 2023

This PR renames @nx/cypress:cypress-e2e-configuration to @nx/cypress:configuration to maintain consistency between plugins (e.g. Vite is already @nx/vite:configuration).

Also renames @nx/cypress:cypress-component-configuration to @nx/cypress:component-configuration since "cypress" is implied by the package name.

What's done:

  • Renamed generators and provided alias to previous names
  • Added redirect rules for nx.dev so old generator pages don't break
  • Updated docs where the old names used
  • Re-exported the old names in case community plugins/workspaces use them
  • Update our own usage within Next/React/Angular to the new names

Current Behavior

Expected Behavior

Related Issue(s)

Fixes #

@jaysoo jaysoo requested review from FrozenPandaz, AgentEnder and a team as code owners July 6, 2023 15:11
@jaysoo jaysoo requested review from bcabanes and mandarini July 6, 2023 15:11
@vercel
Copy link

vercel bot commented Jul 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 7, 2023 2:56pm

@jaysoo jaysoo force-pushed the feat/cypress-consistency-naming branch from 70d9b8c to e180a4a Compare July 6, 2023 15:11
@nx-cloud
Copy link

nx-cloud bot commented Jul 6, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 0695f7d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Comment on lines -17 to +25
"cypress-e2e-configuration": {
"aliases": ["e2e", "e2e-config"],
"factory": "./src/generators/cypress-e2e-configuration/cypress-e2e-configuration#compat",
"schema": "./src/generators/cypress-e2e-configuration/schema.json",
"configuration": {
"aliases": ["cypress-e2e-configuration", "e2e", "e2e-config"],
"factory": "./src/generators/configuration/configuration#compat",
"schema": "./src/generators/configuration/schema.json",
"description": "Add a Cypress E2E Configuration to an existing project."
},
"cypress-component-configuration": {
"factory": "./src/generators/cypress-component-configuration/cypress-component-configuration#cypressComponentConfiguration",
"schema": "./src/generators/cypress-component-configuration/schema.json",
"component-configuration": {
"aliases": ["cypress-component-configuration"],
"factory": "./src/generators/component-configuration/component-configuration#compat",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @nx/cypress:cypress-e2e-configuration should be @nx/cypress:e2e-configuration instead of just configuration since the generator assumes e2e setup which might catch people off?

but also just hate the long names to begin with so kind of split. but figured I'd bring it up.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think keeping it as configuration is fine, an matches the other configuration generators. Component tests is a special case of Cypress I think.

packages/cypress/index.ts Outdated Show resolved Hide resolved
…aintain consistency between plugins

Also rename cypress-component-configuration to component-configuration
@jaysoo jaysoo force-pushed the feat/cypress-consistency-naming branch from 7f097c0 to 0695f7d Compare July 7, 2023 14:53
@jaysoo jaysoo merged commit 9940a0c into nrwl:master Jul 7, 2023
@jaysoo jaysoo deleted the feat/cypress-consistency-naming branch July 7, 2023 16:43
@github-actions
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants