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

chore: remove-project-json #495

Draft
wants to merge 14 commits into
base: develop
Choose a base branch
from
Draft

chore: remove-project-json #495

wants to merge 14 commits into from

Conversation

ryanbas21
Copy link
Contributor

@ryanbas21 ryanbas21 commented Nov 24, 2024

This is more along the lines of what I intend to push to the new repo.

This removes all instances of a project.json file, except for the root one. This is just for demonstration purposes. This type of setup uses nx more as a background task
and uses pnpm to execute scripts. Its
not very different than the existing setup

the core difference is you must reference
a project based on the name in its
package.json file rather than the short-name
that the project.json defined.

I left the root project.json in because the nx executor does some nice things for spawning verdaccio and modifying the .npmrc file for you so your npm points to verdaccio when its running and tries to clean it up when you exit.

Why may we want this setup

Well - this is basically what a pnpm monorepo will look like. Its just using npm scripts instead of nx executors. nx is just in the background for CI and task organization

I still use nx to run commands because I did not setup the repo for pnpm to do that.

But this makes it easier to rip out nx if we want to at some point. So i figured i'd djust present this idea to see how it looks and make sure everything worked.

package generator

This includes a package generator now available when calling pnpm create-package. It has a small walkthrough of prompts, and will create a package in the packages directory.

JIRA Ticket

Please link jira ticket here

Description

Type of Change

Please Delete options that are not relevant

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Definition of Done

Check all that apply

  • Acceptance criteria is met.
  • All tasks listed in the user story have been completed.
  • Coded to standards.
  • Code peer-reviewed.
  • Ensure backward compatibility (special attention).
  • API reference docs is updated.
  • Unit tests are written.
  • Integration tests are written.
  • e2e tests are written.
  • CI build passing on the feature branch.
  • Functional spec is written/updated
  • contains example code snippets.
  • Change log updated.
  • Documentation story is created and tracked.
  • UI is completed or ticket is created.
  • Demo to PO and team.
  • Tech debts and remaining tasks are tracked in separated ticket(s).

Documentation

  • Acceptance criteria met
  • Spell-check run
  • Peer reviewed
  • Proofread

Copy link

changeset-bot bot commented Nov 24, 2024

⚠️ No Changeset found

Latest commit: 02779e2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

nx-cloud bot commented Nov 24, 2024

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

changes outputs for e2e suites to be in .playwright of project root

updates dynamic changesets to save ci computation

update eslint ignore files
This removes all instances of a project.json file.
This is just for demonstration purposes. This type
of setup uses `nx` more as a background task
and uses `pnpm` to execute scripts. Its
not very different than the existing setup

the core difference is you must reference
a project based on the name in its
`package.json` file rather than the short-name
that the project.json defined.
@ryanbas21 ryanbas21 force-pushed the remove-project-json branch 2 times, most recently from c57f3d6 to b33bc2f Compare December 16, 2024 22:52
@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.38%. Comparing base (26f6855) to head (02779e2).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #495      +/-   ##
===========================================
- Coverage    57.24%   56.38%   -0.87%     
===========================================
  Files          123       22     -101     
  Lines        26966     2476   -24490     
  Branches      1717       91    -1626     
===========================================
- Hits         15438     1396   -14042     
+ Misses       11528     1080   -10448     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Successfully merging this pull request may close these issues.

2 participants