feat: delta analysis scoped by source parameter #174

sudhanshu-gupta-0704 · 2021-07-31T14:43:21Z

What does this pull request contains

This pull request contains code modification so that the delta can be generated for a particular module or type of metadata, such as delta only for classes/lwc/etc.
It is complementary to '--ignore' and '--ignore-destructive' and works with it

Use same message for both legacy cli and sfdx plugin

~~Default output folder is now '.'. See "Explain you changes" and "README.md" changes~~

Added for new features.
Changed for changes in existing functionality.
Deprecated for soon-to-be removed features.
Removed for now removed features.
Fixed for any bug fixes.
Security in case of vulnerabilities.

Explain your changes

--source option added in CLI to select or pass the folder path only to be taken into consideration while generating Delta, by default whole folder is taken into consideration (no change to existing functionality).

2. /!\ breaking change /!\ output default folder is now '.' (instead of 'output'). It will be taken automatically when not specified, except if delta generation ('-d') is also passed. In this case an error will be thrown because it would override the current repository with the delta generation file (To be discussed)

Does this close any currently open issues?

Closes #168

Any particular element to being able to test locally

~~-o has now a new default => check your integration !~~
-s newly added can focus the command to sub folder (see README.md changes)

Any other comments?

Where has this been tested?

on Windows, Azure DevOps Pipeline, Mac

Operating System: WINDOWS 10 21H1

**yarn version:**1.22.11

**node version:**14.17.3

**git version:**2.31.0.windows.1

**sfdx version:**7.110.0

**sgd plugin version:**4.7.2

codeclimate · 2021-07-31T14:43:40Z

src/main.js

@@ -29,6 +29,12 @@ const checkConfig = (config, repoSetup) => {
  ) {
    errors.push(`${config.output} folder does not exist`)
  }
+  if (


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2021-07-31T15:06:05Z

src/main.js

-  ) {
-    errors.push(`${config.output} folder does not exist`)
-  }
+  this.chkIfDirExist(config.output);


codeclimate · 2021-07-31T15:06:05Z

src/main.js

-    errors.push(`${config.output} folder does not exist`)
-  }
+  this.chkIfDirExist(config.output);
+  this.chkIfDirExist(config.source);


codeclimate · 2021-07-31T15:06:05Z

src/main.js

@@ -43,10 +39,20 @@ const checkConfig = (config, repoSetup) => {
  return errors
 }

+function chkIfDirExist(Dir){


'chkIfDirExist' is defined but never used.

codeclimate · 2021-07-31T15:06:06Z

src/main.js

@@ -43,10 +39,20 @@ const checkConfig = (config, repoSetup) => {
  return errors
 }

+function chkIfDirExist(Dir){


Insert ·

codeclimate · 2021-07-31T15:06:06Z

src/main.js

@@ -43,10 +39,20 @@ const checkConfig = (config, repoSetup) => {
  return errors
 }

+function chkIfDirExist(Dir){
+  if (


Replace ⏎····!fs.existsSync(Dir)·||⏎····!fs.statSync(Dir).isDirectory()⏎·· with !fs.existsSync(Dir)·||·!fs.statSync(Dir).isDirectory()

codeclimate · 2021-07-31T15:13:42Z

src/main.js

  if (!repoSetup.isToEqualHead() && config.generateDelta) {
    errors.push(
      `--generate-delta (-d) parameter cannot be used when --to (-t) parameter is not equivalent to HEAD`
    )
+  errors=chkIfDirExist(config.output, errors)


Replace errors= with ··errors·=·

codeclimate · 2021-07-31T15:13:42Z

src/main.js

  if (!repoSetup.isToEqualHead() && config.generateDelta) {
    errors.push(
      `--generate-delta (-d) parameter cannot be used when --to (-t) parameter is not equivalent to HEAD`
    )
+  errors=chkIfDirExist(config.output, errors)


'errors' is constant.

codeclimate · 2021-07-31T15:13:42Z

src/main.js

  if (!repoSetup.isToEqualHead() && config.generateDelta) {
    errors.push(
      `--generate-delta (-d) parameter cannot be used when --to (-t) parameter is not equivalent to HEAD`
    )
+  errors=chkIfDirExist(config.output, errors)
+  errors=chkIfDirExist(config.source, errors)


Replace ··errors= with ····errors·=·

codeclimate · 2021-07-31T15:13:42Z

src/main.js

  if (!repoSetup.isToEqualHead() && config.generateDelta) {
    errors.push(
      `--generate-delta (-d) parameter cannot be used when --to (-t) parameter is not equivalent to HEAD`
    )
+  errors=chkIfDirExist(config.output, errors)
+  errors=chkIfDirExist(config.source, errors)


'errors' is constant.

codeclimate · 2021-07-31T15:13:42Z

src/main.js

  }

  return errors
 }

+function chkIfDirExist(dir,errors){


Replace errors) with ·errors)·

scolladon · 2021-08-01T16:39:55Z

Hi @sudhanshu-gupta-0704 !

Thanks for this contribution ! That is great.
I'm currently reviewing it.

Could you give me access to your fork please ? So I can add commits to the PR

sudhanshu-gupta-0704 · 2021-08-01T17:04:20Z

Hi @scolladon ,

I have added you as a contributor to my fork, Please use Sudhanshu/AddModularSupport branch for changes.

Thanks

src/utils/cliHelper.js

codecov · 2021-08-01T18:15:57Z

Codecov Report

Merging #174 (90b0eb6) into master (dda6327) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #174   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          18       19    +1     
  Lines         440      450   +10     
=======================================
+ Hits          439      449   +10     
  Misses          1        1

Impacted Files	Coverage Δ
src/utils/repoGitDiff.js	`100.00% <ø> (ø)`
src/main.js	`100.00% <100.00%> (ø)`
src/service/standardHandler.js	`100.00% <100.00%> (ø)`
src/utils/childProcessUtils.js	`100.00% <100.00%> (ø)`
src/utils/cliHelper.js	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dda6327...90b0eb6. Read the comment docs.

src/utils/cliHelper.js

scolladon · 2021-08-01T19:16:39Z

FYI: PR Lint issue is false positive

Issue is related to GITHUB_TOKEN not accessible because PR is created from a fork (cf known issue)
The PR name is correct following our convention

codeclimate · 2021-08-04T13:49:44Z

Code Climate has analyzed commit 90b0eb6 and detected 0 issues on this pull request.

View more on Code Climate.

codeclimate bot reviewed Jul 31, 2021

View reviewed changes

sudhanshu-gupta-0704 changed the title ~~Sudhanshu/add modular support~~ Modular support for Delta Generation Jul 31, 2021

scolladon self-requested a review August 1, 2021 10:27

scolladon self-assigned this Aug 1, 2021

scolladon requested a review from mehdicherf August 1, 2021 10:28

feat: add source scoping

2c159c4

scolladon added 3 commits August 1, 2021 20:11

fix: test and pack issues

87c98ed

docs: add advanced use case explanation

83ec985

refactor: use static member

975f708

scolladon force-pushed the Sudhanshu/AddModularSupport branch from 49ead89 to 1f419a9 Compare August 1, 2021 18:14

codeclimate bot reviewed Aug 1, 2021

View reviewed changes

src/utils/cliHelper.js Show resolved Hide resolved

src/utils/cliHelper.js Show resolved Hide resolved

src/utils/cliHelper.js Outdated Show resolved Hide resolved

src/utils/cliHelper.js Outdated Show resolved Hide resolved

src/utils/cliHelper.js Outdated Show resolved Hide resolved

scolladon changed the title ~~Modular support for Delta Generation~~ feat: delta analysis scoped by source parameter Aug 1, 2021

scolladon added 5 commits August 1, 2021 21:05

refactor: create a dedicated cli helper for cli checks

582296e

refactor: use shared default values

dc8e36b

feat: make output default "." except when using "-d"

e914fb1

test: add test for the new output behavior

ae0cbc4

refactor: simplified code and improve readability

a1f8f41

scolladon force-pushed the Sudhanshu/AddModularSupport branch from 1f419a9 to a1f8f41 Compare August 1, 2021 19:10

codeclimate bot reviewed Aug 1, 2021

View reviewed changes

src/utils/cliHelper.js Show resolved Hide resolved

src/utils/cliHelper.js Show resolved Hide resolved

scolladon added 3 commits August 2, 2021 20:15

revert: output parameter default value to "./output"

8085b3d

fix: default value issue from refactoring

6938a41

Merge branch 'master' into Sudhanshu/AddModularSupport

90b0eb6

mehdicherf approved these changes Aug 4, 2021

View reviewed changes

scolladon enabled auto-merge (squash) August 4, 2021 14:01

scolladon disabled auto-merge August 4, 2021 14:01

scolladon merged commit 62f0cf2 into scolladon:master Aug 4, 2021

scolladon mentioned this pull request Dec 12, 2023

chore(main): release 5.31.1 #739

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: delta analysis scoped by source parameter #174

feat: delta analysis scoped by source parameter #174

sudhanshu-gupta-0704 commented Jul 31, 2021 •

edited by scolladon

Loading

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

codeclimate bot Jul 31, 2021

scolladon commented Aug 1, 2021

sudhanshu-gupta-0704 commented Aug 1, 2021

codecov bot commented Aug 1, 2021 •

edited

Loading

scolladon commented Aug 1, 2021 •

edited

Loading

codeclimate bot commented Aug 4, 2021

feat: delta analysis scoped by source parameter #174

feat: delta analysis scoped by source parameter #174

Conversation

sudhanshu-gupta-0704 commented Jul 31, 2021 • edited by scolladon Loading

What does this pull request contains

Explain your changes

Does this close any currently open issues?

Any particular element to being able to test locally

Any other comments?

Where has this been tested?

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

codeclimate bot Jul 31, 2021

Choose a reason for hiding this comment

scolladon commented Aug 1, 2021

sudhanshu-gupta-0704 commented Aug 1, 2021

codecov bot commented Aug 1, 2021 • edited Loading

Codecov Report

scolladon commented Aug 1, 2021 • edited Loading

codeclimate bot commented Aug 4, 2021

sudhanshu-gupta-0704 commented Jul 31, 2021 •

edited by scolladon

Loading

codecov bot commented Aug 1, 2021 •

edited

Loading

scolladon commented Aug 1, 2021 •

edited

Loading