Implement shell script for creating folder structure for new programming languages #25

darrylbalderas · 2019-02-01T06:48:17Z

This PR is to address #24

This commit was made to create a script to eliminate the time to copy and paste folders for new programming languages Signed-off-by: darrylbalderas <[email protected]>

This commit was made to update the readme with a comment on how to use the createFolder.sh shell script Signed-off-by: darrylbalderas <[email protected]>

lhchavez · 2019-02-01T16:16:02Z

createFolders.sh

+#!/bin/bash
+
+PROJECT_NAME=data-and-algorithms
+DIRECTORY=${PWD}


you can avoid most of the boilerplate and validation by using

DIRECTORY="$(readlink -f -- "$(dirname -- "$0")")"

yes, all those quotes are needed. otherwise you'll break people who clone this repository in a path that has spaces!

lhchavez · 2019-02-01T16:17:29Z

createFolders.sh

+   cp -a ./Python/ ./$rootfileName/
+   rm ./$rootfileName/*/*/*.py
+else
+   echo "Missing folder name: sh createFolders.sh <folder_name>"


you can use the guard clause pattern

if [[ $# -lt 1 ]]; then echo "Usage: bash createFolders.sh <programming language>" > &2 exit 1 fi # The rest. You can now use $1 confidently.

the >&2 prints to stderr.

lhchavez · 2019-02-01T16:19:56Z

README.md


 Feel free to add your solutions in your channel of your choice 😃

+Run this script to create the folder structure for your favorite programming language


you should use bash instead of sh. otherwise you lose a lot of functionality!

lhchavez · 2019-02-01T16:21:43Z

createFolders.sh

+      echo "Make sure you are in $PROJECT_NAME project"
+      exit
+   fi
+   rootfileName=$1


you should always quote all your variables. otherwise if they contain a space, they will be expanded to unexpected stuff!

bash createFolders.sh "hello world"

would cause this line to expand to

rootfileName=hello world

which would try to invoke world with the rootfileName=hello environment variable.

also, if this is the programming language, maybe call it programmingLanguage.

lhchavez · 2019-02-01T16:23:33Z

createFolders.sh

+      exit
+   fi
+   rootfileName=$1
+   mkdir ./$rootfileName


here you can do

mkdir "${DIRECTORY}/${rootfileName}"

you should always try to brace the variables to make it super clear where they end. otherwise things like $myvar_would confuse readers. is the intention to be a variable called myvar_ or is it $myvar followed by an underscore?

also, by using the rsync or find alternatives sugegsted below, this mkdir is unneeded.

lhchavez · 2019-02-01T16:25:41Z

createFolders.sh

+   fi
+   rootfileName=$1
+   mkdir ./$rootfileName
+   cp -a ./Python/ ./$rootfileName/


try to use the long forms of flags: https://xkcd.com/1168/

lhchavez · 2019-02-01T16:33:06Z

createFolders.sh

+   rootfileName=$1
+   mkdir ./$rootfileName
+   cp -a ./Python/ ./$rootfileName/
+   rm ./$rootfileName/*/*/*.py


maybe it's better to not copy the files in the first place:

rsync --archive --include='*/' --exclude='*' "${DIRECTORY}/Python/" "${DIRECTORY}/${programmingLanguage}"

source: https://stackoverflow.com/a/40586240/688337

or if you want to avoid rsync for whatever reason

(cd "${DIRECTORY}/Python/" && \ find . -type d -depth -exec mkdir -p "${DIRECTORY}/${programmingLanguage}/{}" \;)

lhchavez · 2019-02-01T16:35:38Z

README.md


 Feel free to add your solutions in your channel of your choice 😃

+Run this script to create the folder structure for your favorite programming language
+`sh createFolders.sh  <Programming Language Name>`


tiny naming nit: in POSIX, these are called directories, not folders.

darrylbalderas · 2019-02-01T17:21:29Z

Let me add these changes. Gracias amigo 👍

lhchavez · 2019-02-01T23:05:46Z

createFolders.sh

+fi
+
+programmingLanguage=$1


nit: remember the double quotes or you'll get weird results if somebody decides to pass in spaces within an argument. https://google.github.io/styleguide/shell.xml?showone=Quoting#Quoting

Rule of thumb is: every single var should be double quoted AND braced (except for the bash builtin ones, so $1 and $# are fine. https://google.github.io/styleguide/shell.xml?showone=Variable_expansion#Variable_expansion

and in general read that whole style guide, it's great!

I'll stay consistent and add the double quotes 💯

lhchavez · 2019-02-01T23:06:24Z

createFolders.sh

+
+programmingLanguage=$1
+mkdir "${DIRECTORY}/${programmingLanguage}"
+rsync --archive --include='*/' --exclude='*' "${DIRECTORY}/Python/" "${DIRECTORY}/${programmingLanguage}"


nit: break long lines for better readability.

Suggested change

rsync --archive --include='*/' --exclude='*' "${DIRECTORY}/Python/" "${DIRECTORY}/${programmingLanguage}"

rsync --archive --include='*/' --exclude='*' "${DIRECTORY}/Python/" \

"${DIRECTORY}/${programmingLanguage}"

lhchavez · 2019-02-01T23:07:17Z

createFolders.sh

+fi
+
+programmingLanguage=$1
+mkdir "${DIRECTORY}/${programmingLanguage}"


you should be able to drop this now since rsync will create it. if it doesn't, it might be because i forgot to add a trailing / to the destination directory ^^;

lhchavez · 2019-02-01T23:51:55Z

createFolders.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+DIRECTORY="$(dirname "$(readlink "$0")")"


note that you do need to use the boilerplate i shared as-is to avoid some issues on some POSIX systems:

Suggested change

DIRECTORY="$(dirname "$(readlink "$0")")"

DIRECTORY="$(readlink --canonicalize -- "$(dirname -- "$0")")"

the --canonicalize flag removes any symlinks in the path, and the -- are needed because if some component of the path starts with -, the commands may interpret as a flag instead of a path.

Does readlink have a canonicalize flag ? I didn't see that option in terminal manual file for readlink. I have a mac os machine and the -f does exist but it is for formatting

argh. does it have an -f flag? i was trying to avoid the shorthand names.

I just see the -f option for the stat command

yuck, portable bash programming is hard.

seems like you'll have to live with some platforms being broken. or convert this into Python code.

That was going to be my first choice in using python but I was like well let's give bash a try 😉

i just realized there's a better alternative:

Suggested change

DIRECTORY="$(dirname "$(readlink "$0")")"

DIRECTORY="$(git rev-parse --show-toplevel)"

this should work everywhere.

Works like a charm 👍

lhchavez · 2019-02-01T23:53:10Z

createFolders.sh

+DIRECTORY="$(dirname "$(readlink "$0")")"
+
+if [[ $# -lt 1 ]]; then
+  echo "Usage: bash createFolders.sh <programming language>" >&2


WDYT about renaming this file to createDirectories for consistency with the POSIX terminology?

I think that is fair to have it be consistent with POSIX terminology

lhchavez

\o/

lhchavez · 2019-02-10T20:16:43Z

README.md

@@ -1,19 +1,31 @@
 # data-and-algorithms
 Let's go over data structures and algorithms together! 
-We will use Cracking the Coding Interview as reference.
+We will use [Cracking the Coding Interview Book](http://www.crackingthecodinginterview.com/) as reference.

 Feel free to add your solutions in your channel of your choice 😃


now that you're editing this, can you change channel for programming language?

lhchavez · 2019-02-11T04:50:21Z

createDirectories.sh

+fi
+
+programmingLanguage="$1"
+rsync --archive --include='*/' --exclude='*' "${DIRECTORY}/Python/" \


oh i just forgot a crucial detail: git never stores empty directories! so you might want to create empty files afterwards:

find "${DIRECTORY}/${programmingLanguage}/" -mindepth 2 -maxdepth 2 \ -exec touch -- "{}/empty.txt" \; git add "${DIRECTORY}/${programmingLanguage}/"

Oh that's right 😢

i just got merge privileges back! do you want to fix this before it's merged?

let me do that

Signed-off-by: darrylbalderas <[email protected]>

darrylbalderas added 2 commits January 31, 2019 22:42

Create shell script to create folder structure

072504a

This commit was made to create a script to eliminate the time to copy and paste folders for new programming languages Signed-off-by: darrylbalderas <[email protected]>

Update README.md

42b7e23

This commit was made to update the readme with a comment on how to use the createFolder.sh shell script Signed-off-by: darrylbalderas <[email protected]>

lhchavez reviewed Feb 1, 2019

View reviewed changes

lhchavez approved these changes Feb 10, 2019

View reviewed changes

lhchavez reviewed Feb 11, 2019

View reviewed changes

lhchavez mentioned this pull request Mar 2, 2019

Add general advice to the README.md lhchavez/data-and-algorithms#1

Open

Implement reviewer's comments

2a47138

Signed-off-by: darrylbalderas <[email protected]>

pr-triage bot added the PR: unreviewed label Aug 2, 2019

Add command to store empty directories

793c2b2

lhchavez approved these changes Aug 2, 2019

View reviewed changes

pr-triage bot added PR: reviewed-approved and removed PR: unreviewed labels Aug 2, 2019

lhchavez merged commit 90396a3 into techqueria:master Aug 2, 2019

pr-triage bot added PR: merged and removed PR: reviewed-approved labels Aug 2, 2019


		Feel free to add your solutions in your channel of your choice 😃

		Run this script to create the folder structure for your favorite programming language

	rsync --archive --include='/' --exclude='' "${DIRECTORY}/Python/" "${DIRECTORY}/${programmingLanguage}"
	rsync --archive --include='/' --exclude='' "${DIRECTORY}/Python/" \
	"${DIRECTORY}/${programmingLanguage}"

		@@ -0,0 +1,12 @@
		#!/bin/bash

		DIRECTORY="$(dirname "$(readlink "$0")")"

	DIRECTORY="$(dirname "$(readlink "$0")")"
	DIRECTORY="$(readlink --canonicalize -- "$(dirname -- "$0")")"

	DIRECTORY="$(dirname "$(readlink "$0")")"
	DIRECTORY="$(git rev-parse --show-toplevel)"

		fi

		programmingLanguage=$1

Implement shell script for creating folder structure for new programming languages #25

Implement shell script for creating folder structure for new programming languages #25

Uh oh!

Conversation

darrylbalderas commented Feb 1, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

darrylbalderas commented Feb 1, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

darrylbalderas Feb 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhchavez Feb 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhchavez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhchavez Feb 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

darrylbalderas Feb 1, 2019 •

edited

Loading

lhchavez Feb 8, 2019 •

edited

Loading

lhchavez Feb 11, 2019 •

edited

Loading