feat(core): introduce nx import #26847

FrozenPandaz · 2024-07-05T21:50:38Z

Current Behavior

Importing other projects/ repositories into an Nx workspace is a natural part of the Nx adoption story. However, there is no easy built in way of handling this while maintaining git history.

Expected Behavior

nx import is a new command which allows teams to merge code from other repositories into a Nx workspace.

https://asciinema.org/a/oQiA9qOvA2z85AQvVJ5QRVTp1

Related Issue(s)

Fixes #

vercel · 2024-07-05T21:50:41Z

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

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	Aug 12, 2024 8:53pm

nx-cloud · 2024-07-05T21:51:16Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 847e8be. 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 4 targets

Sent with 💌 from NxCloud.

github-actions · 2024-07-18T18:02:02Z

🐳 We have a release for that!

This PR has a release associated with it. You can try it out using this command:

npx [email protected] my-workspace

Or just copy this version and use it in your own command:

0.0.0-pr-26847-80c36f5

Release details	📑
Published version	0.0.0-pr-26847-80c36f5
Triggered by	@FrozenPandaz
Branch	nx-import
Commit	80c36f5
Workflow run	9996161849

To request a new release for this pull request, mention someone from the Nx team or the @nrwl/nx-pipelines-reviewers.

jaysoo · 2024-08-09T18:06:21Z

packages/nx/src/command-line/import/import.ts

+          type: 'input',
+          name: 'sourceRemoteUrl',
+          message:
+            'What is the Remote URL of the repository you want to import?',


We can rephrase this to also include local directories.

Should test and verify the path passed if it's local

jaysoo · 2024-08-09T18:10:27Z

packages/nx/src/command-line/import/import.ts

+  }
+
+  if (!source) {
+    source = (


Validate this exists.

Q: Can we validate the project? Maybe after import we can verify and log out some hints if things didn't work.

jaysoo · 2024-08-09T18:14:59Z

packages/nx/src/command-line/import/utils/prepare-source-repo.ts

+    `Fetching ${ref} from ${sourceRemoteUrl}`
+  );
+  await gitClient.addFetchRemote('origin', ref);
+  await gitClient.fetch('origin', { depth: 1, ref });


Check if all the history if depth: 1

Yup, that messed it up. I made it the full history...

If it's a local path... it kind of adopts the history depth of the local path... so if people have a shallow clone, then they might be missing some commits 🤔

But if it's a remote path, we get the full history, however long it is

jaysoo · 2024-08-09T18:21:20Z

packages/nx/src/command-line/import/utils/prepare-source-repo.ts

+      const newPath = join(destinationInSource, file);
+
+      await mkdirAsync(dirname(newPath), { recursive: true });
+      try {


If we're moving to a gitignored directory, what will happen? (Looks like it just works!)

jaysoo · 2024-08-09T18:33:57Z

e2e/nx/src/import.test.ts

+  afterAll(() => cleanupProject());
+
+  it('should be able to import a vite app', () => {
+    const remote = 'https://github.com/nrwl/nx.git';


Maybe use a local remote so it's not necessary to have a reference on remote?

jaysoo · 2024-08-12T19:33:22Z

packages/nx/src/command-line/import/import.ts

+  } catch {}
+  await mkdir(tempImportDirectory, { recursive: true });
+
+  const sourceGitClient = await cloneFromUpstream(


If this fails, we may want to ask user to check their URL / directory path. If there is a typo, or what they are importing isn't a git repo.

AgentEnder · 2024-08-12T16:58:36Z

e2e/nx/src/import.test.ts

+      }
+    );
+
+    checkFilesExist(


Can we make some assertion about the git history of the project files? I trust that it is working, but just to keep it that way.

AgentEnder · 2024-08-12T16:59:19Z

e2e/nx/src/import.test.ts

+    execSync(`git commit -am "initial commit"`, {
+      cwd: tempViteProjectPath,
+    });


Can we create an extra commit or two? Just want to be safe :)

github-actions · 2024-08-28T00:13:28Z

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.

vercel bot deployed to Preview July 5, 2024 22:07 View deployment

FrozenPandaz force-pushed the nx-import branch from 2b7ec6c to cac06a3 Compare July 9, 2024 17:09

vercel bot deployed to Preview July 9, 2024 17:17 View deployment

FrozenPandaz force-pushed the nx-import branch 2 times, most recently from 6fef53f to ebf8ad0 Compare July 9, 2024 17:42

vercel bot deployed to Preview July 9, 2024 17:52 View deployment

FrozenPandaz force-pushed the nx-import branch from ebf8ad0 to f062f6e Compare July 9, 2024 21:58

vercel bot deployed to Preview July 9, 2024 22:07 View deployment

FrozenPandaz force-pushed the nx-import branch from f062f6e to 5d83309 Compare July 9, 2024 22:37

vercel bot deployed to Preview July 9, 2024 22:45 View deployment

FrozenPandaz force-pushed the nx-import branch from 5d83309 to a7a8d00 Compare July 9, 2024 23:46

vercel bot deployed to Preview July 9, 2024 23:54 View deployment

FrozenPandaz force-pushed the nx-import branch 3 times, most recently from 6bc28c3 to 5c3528b Compare July 15, 2024 14:31

FrozenPandaz force-pushed the nx-import branch from 5c3528b to 80c36f5 Compare July 18, 2024 17:41

FrozenPandaz self-assigned this Jul 22, 2024

FrozenPandaz force-pushed the nx-import branch 6 times, most recently from 615f0e3 to 6e5743d Compare August 2, 2024 19:45

FrozenPandaz force-pushed the nx-import branch 4 times, most recently from d8d201f to c317fec Compare August 8, 2024 14:35

FrozenPandaz force-pushed the nx-import branch 3 times, most recently from fb3d93f to a2b1a9c Compare August 9, 2024 17:14

jaysoo reviewed Aug 9, 2024

View reviewed changes

FrozenPandaz force-pushed the nx-import branch 9 times, most recently from 38ae368 to 6c75bf6 Compare August 9, 2024 23:05

FrozenPandaz marked this pull request as ready for review August 12, 2024 14:40

FrozenPandaz requested a review from a team as a code owner August 12, 2024 14:40

FrozenPandaz requested a review from xiongemi August 12, 2024 14:40

jaysoo approved these changes Aug 12, 2024

View reviewed changes

jaysoo reviewed Aug 12, 2024

View reviewed changes

FrozenPandaz force-pushed the nx-import branch from 6c75bf6 to cca66f9 Compare August 12, 2024 19:46

feat(core): introduce nx import

847e8be

FrozenPandaz force-pushed the nx-import branch from cca66f9 to 847e8be Compare August 12, 2024 20:51

FrozenPandaz merged commit c72ba9b into master Aug 12, 2024
6 checks passed

FrozenPandaz deleted the nx-import branch August 12, 2024 21:52

AgentEnder reviewed Aug 12, 2024

View reviewed changes

github-actions bot locked as resolved and limited conversation to collaborators Aug 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): introduce nx import #26847

feat(core): introduce nx import #26847

FrozenPandaz commented Jul 5, 2024 •

edited

Loading

vercel bot commented Jul 5, 2024 •

edited

Loading

nx-cloud bot commented Jul 5, 2024 •

edited

Loading

github-actions bot commented Jul 18, 2024

jaysoo Aug 9, 2024

jaysoo Aug 9, 2024

jaysoo Aug 9, 2024 •

edited

Loading

FrozenPandaz Aug 9, 2024

jaysoo Aug 9, 2024

FrozenPandaz Aug 9, 2024 •

edited

Loading

jaysoo Aug 9, 2024 •

edited

Loading

jaysoo Aug 9, 2024

FrozenPandaz Aug 9, 2024

jaysoo Aug 12, 2024

AgentEnder Aug 12, 2024

AgentEnder Aug 12, 2024

github-actions bot commented Aug 28, 2024

feat(core): introduce nx import #26847

feat(core): introduce nx import #26847

Conversation

FrozenPandaz commented Jul 5, 2024 • edited Loading

Current Behavior

Expected Behavior

Related Issue(s)

vercel bot commented Jul 5, 2024 • edited Loading

nx-cloud bot commented Jul 5, 2024 • edited Loading

☁️ Nx Cloud Report

github-actions bot commented Jul 18, 2024

🐳 We have a release for that!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaysoo Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FrozenPandaz Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

jaysoo Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Aug 28, 2024

FrozenPandaz commented Jul 5, 2024 •

edited

Loading

vercel bot commented Jul 5, 2024 •

edited

Loading

nx-cloud bot commented Jul 5, 2024 •

edited

Loading

jaysoo Aug 9, 2024 •

edited

Loading

FrozenPandaz Aug 9, 2024 •

edited

Loading

jaysoo Aug 9, 2024 •

edited

Loading