Clean code, recursive directory copying and path normalization #5

HoldYourWaffle · 2019-02-25T22:13:26Z

I found this module to be broken after 2 years without updates, so I cleaned it up a bit and fixed some path normalization.
Main changes are:

Added path normalization (I'm 90% sure this fixes TypeError: Path must be a string. Received undefined #3)
Formatted & organized code
Recursive directory copying

Also fixes #4 by mentioning the quote requirement in the readme.

Fixes zont#4 by mentioning the quote requirement in the readme

index.js

zont · 2019-02-26T06:22:32Z

index.js

+	chokidar.watch(sourceGlobs, {
+		ignoreInitial: true
+	})
+		.on('ready', () => sourceGlobs.forEach(s => console.log('[WATCHING]'.cyan, s)))


Why color changed?

I added some color diversity to the log messages to allow for easier reading. COPY is still yellow, I changed WATCHING to cyan, DELETE to red and added CLEAN in magenta.
I chose these colors (almost) randomly, if you want them changed just say the word.

zont · 2019-02-26T06:30:05Z

Too many fixes.

npm run lint show 71 errors

HoldYourWaffle · 2019-02-26T09:43:19Z

Whoops I completely forgot about the linter.
I fixed almost all errors (most of them were the indentation), with just 2 remaining.
These relate to the evil global variables, and it's a bit of a chicken-and-egg problem.

ESLint wants me to declare these variables before they are used. Fair game, it would be really stupid to bury globals like this. ESLint also wants me to define functions before they are used, again this makes a lot of sense. To solve this I can declare the globals on top, after that the functions that use them and lastly the actual code. Good? Wrong: ESLint wants me to declare these globals using const because they are never reassigned.
This of course isn't possible, because I can't decalre a variable using const without immediately initializing it. The only solution I see would be to split the acting code in half, the first part (which initializes the globals) before we define our functions, and the second part (which actual does stuff) afterwards.
I feel like this would actually make the code worse instead of cleaner, but of course if you really want to I could change it.

zont · 2019-02-26T10:29:24Z

index.js


-const findTarget = from => {
+/* FUNCTIONS */
+function findTarget(from) {


Why arrow functions converted to ES5 functions?

zont · 2019-02-26T10:39:02Z

Still 2 lint errors

HoldYourWaffle · 2019-02-26T11:33:37Z

Because there is no reason for using arrow functions here, it just hurts readability. Having the actual `function` keyword makes it very clear where the functions are instead of hiding them in variables.

-------- Oorspronkelijk bericht -------- Van: zont <[email protected]> Datum: 26-02-19 11:29 (GMT+01:00) Aan: zont/copy-and-watch <[email protected]> Cc: Ravi van Rooijen <[email protected]>, Author <[email protected]> Onderwerp: Re: [zont/copy-and-watch] Clean code, recursive directory copying and path normalization (#5) @zont commented on this pull request.

________________________________ In index.js<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fzont%2Fcopy-and-watch%2Fpull%2F5%23discussion_r260220190&data=02%7C01%7C%7C4b231cd7fc0c4a46f66908d69bd5486e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636867737668726342&sdata=h8nsHawjcueMxIKzKrecaNJZ6izSaYoTJOM6DzI%2FvP4%3D&reserved=0>:

-const findTarget = from => { +/* FUNCTIONS */ +function findTarget(from) { Why arrow functions converted to ES5 functions? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fzont%2Fcopy-and-watch%2Fpull%2F5%23pullrequestreview-207874541&data=02%7C01%7C%7C4b231cd7fc0c4a46f66908d69bd5486e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636867737668736355&sdata=at0vxTIzVsqCCcO7bOdqwGk2lQUPJf8R5tLtQA%2FFIKc%3D&reserved=0>, or mute the thread<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAK8NwESOmE7f_yMMAox4QG1F4CcT_0Dmks5vRQyFgaJpZM4bQ5wg&data=02%7C01%7C%7C4b231cd7fc0c4a46f66908d69bd5486e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636867737668746359&sdata=uzwJIDyjoqzWYkHACuy%2Ft63%2FOV%2BRATPILPxKeSUaA6A%3D&reserved=0>.

zont · 2019-02-26T13:28:03Z

Please fix 2 lint errors

HoldYourWaffle · 2019-02-26T14:07:42Z

As I said earlier:

ESLint wants me to declare these variables before they are used. Fair game, it would be really stupid to bury globals like this. ESLint also wants me to define functions before they are used, again this makes a lot of sense. To solve this I can declare the globals on top, after that the functions that use them and lastly the actual code. Good? Wrong: ESLint wants me to declare these globals using const because they are never reassigned.
This of course isn't possible, because I can't decalre a variable using const without immediately initializing it. The only solution I see would be to split the acting code in half, the first part (which initializes the globals) before we define our functions, and the second part (which actual does stuff) afterwards.
I feel like this would actually make the code worse instead of cleaner, but of course if you really want to I could change it.

There are 3 solutions:

Splitting the 'acting' code (which would be really bad)
Relaxing the lint settings
Removing the globals (which would complicate some pieces of code)

I think relaxing the lint settings would be our best option, since splitting the 'acting' code hurts readability a lot.

HoldYourWaffle · 2019-04-22T10:26:52Z

Any update on this?

HoldYourWaffle added 2 commits February 25, 2019 22:19

Clean code + fix directories

7993e8d

Add some path normalization

4632231

Fixes zont#4 by mentioning the quote requirement in the readme

HoldYourWaffle changed the title ~~Clean code + fix copying directories~~ Clean code , recursive directory copying and path normalization Feb 25, 2019

HoldYourWaffle changed the title ~~Clean code , recursive directory copying and path normalization~~ Clean code, recursive directory copying and path normalization Feb 25, 2019

zont reviewed Feb 26, 2019

View reviewed changes

index.js Outdated Show resolved Hide resolved

zont reviewed Feb 26, 2019

View reviewed changes

index.js Outdated Show resolved Hide resolved

zont reviewed Feb 26, 2019

View reviewed changes

Fix almost all linting errors

53b359d

zont reviewed Feb 26, 2019

View reviewed changes

index.js

const findTarget = from => {

/* FUNCTIONS */

function findTarget(from) {

Copy link

Owner

zont Feb 26, 2019

Choose a reason for hiding this comment

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

Why arrow functions converted to ES5 functions?

astery mentioned this pull request Mar 8, 2023

(node:43172) UnhandledPromiseRejectionWarning: TypeError [ERR_INVALID_ARG_TYPE #14

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean code, recursive directory copying and path normalization #5

Clean code, recursive directory copying and path normalization #5

HoldYourWaffle commented Feb 25, 2019 •

edited

Loading

zont Feb 26, 2019 •

edited

Loading

HoldYourWaffle Feb 26, 2019

zont commented Feb 26, 2019 •

edited

Loading

HoldYourWaffle commented Feb 26, 2019

zont Feb 26, 2019

zont commented Feb 26, 2019

HoldYourWaffle commented Feb 26, 2019 via email

zont commented Feb 26, 2019

HoldYourWaffle commented Feb 26, 2019

HoldYourWaffle commented Apr 22, 2019

Clean code, recursive directory copying and path normalization #5

Are you sure you want to change the base?

Clean code, recursive directory copying and path normalization #5

Conversation

HoldYourWaffle commented Feb 25, 2019 • edited Loading

zont Feb 26, 2019 • edited Loading

Choose a reason for hiding this comment

HoldYourWaffle Feb 26, 2019

Choose a reason for hiding this comment

zont commented Feb 26, 2019 • edited Loading

HoldYourWaffle commented Feb 26, 2019

zont Feb 26, 2019

Choose a reason for hiding this comment

zont commented Feb 26, 2019

HoldYourWaffle commented Feb 26, 2019 via email

zont commented Feb 26, 2019

HoldYourWaffle commented Feb 26, 2019

HoldYourWaffle commented Apr 22, 2019

HoldYourWaffle commented Feb 25, 2019 •

edited

Loading

zont Feb 26, 2019 •

edited

Loading

zont commented Feb 26, 2019 •

edited

Loading