fix(core): filter branch in preparation for nx import

[jaysoo]

This PR fixes an issue with nx import where multiple directories cannot be imported from the same repo. We now use git filter-repo (if installed) or git filter-branch (fallback) to prepare the repo for import so anything not in the subdirectory will be ignored (i.e. cleaner history).

Note: filter-repo is much faster but requires the user to install it first via their package manager (e.g. brew install git-filter-repo or apt install git-filter-repo). We fallback to git filter-branch since it comes with git, but it is slower, so the process may take 10+ minutes on really large monorepos (e.g. next.js).

Also:

• Use await before returning a promise to Node can maintain correct stacktrace
• Remove logic for if (relativeSourceDir === '') since using filter-branch moves all the files to the root (.)
• Default destination project location to be the same as source (e.g. importing packages/a will go to packages/a unless user types in something else)
• Add --depth option if users don't want to clone with full history (default is full history)
• Fix issues with special characters causing git ls-files + git mv to since mv doesn't work with escaped names

Current Behavior

Expected Behavior

Related Issue(s)

Fixes #

[vercel]

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 29, 2024 7:44pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5d5aa16. 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

---

🟥 Failed Commands
nx affected --targets=lint,test,build,e2e,e2e-ci --base=0ef6892a6e3eb525548972b2e18b187a750a0356 --head=5d5aa161ab94405806a5a26ee534984dcdfd1499 --parallel=3

✅ Successfully ran 3 targets

• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=0ef6892a6e3eb525548972b2e18b187a750a0356 --head=5d5aa161ab94405806a5a26ee534984dcdfd1499
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[github-actions]

🐳 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-27652-a405076

Release details	📑
Published version	0.0.0-pr-27652-a405076
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	a405076
Workflow run	10584370515

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

[github-actions]

🐳 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-27652-0a94c12

Release details	📑
Published version	0.0.0-pr-27652-0a94c12
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	0a94c12
Workflow run	10585273535

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

[github-actions]

🐳 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-27652-a15068b

Release details	📑
Published version	0.0.0-pr-27652-a15068b
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	a15068b
Workflow run	10598165965

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

[github-actions]

🐳 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-27652-3af8043

Release details	📑
Published version	0.0.0-pr-27652-3af8043
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	3af8043
Workflow run	10599985131

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

[github-actions]

🐳 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-27652-5a954f2

Release details	📑
Published version	0.0.0-pr-27652-5a954f2
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	5a954f2
Workflow run	10603094689

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

[github-actions]

🐳 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-27652-161cc40

Release details	📑
Published version	0.0.0-pr-27652-161cc40
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	161cc40
Workflow run	10607305410

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

[github-actions]

🐳 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-27652-1746961

Release details	📑
Published version	0.0.0-pr-27652-1746961
Triggered by	@jaysoo
Branch	fix/import-filter-branch
Commit	1746961
Workflow run	10620171971

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

[github-actions]

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.