Skip to main content

Getting to know a completely new programming project

So since Feb this year, i have been assigned on a new project at work. This new project involves working with a variety of independent sub-projects for this client and the sheer variety of the sub-projects can sometimes be overwhelming. What has happened a few times is that, the client starts a new sub-project, hands it to us and says we need this application to do "X". Can you make it do that? So the task is assigned to me and I have a project with no documentation, no instructions but I need to get on with it and solve the issue as soon as i can.

So how do i approach this? Since i work on a mac,  which basically has the very awesome terminal that amongst others, has this useful tool called grep. 

How do i use it for my needs?  well say i have an AngularJS project, stored in a folder projFolder, and i have no prior knowledge of how it is structured and i have to figure out why a controller does not navigate to route blog after a certain function call. So firstly i need to figure out where the word blog is used in the project. The best thing to do here is to go through all the files of the project and find out every line where the word blog appears.  This can be achieved as follows,

Open the terminal and navigate to projFolder i.e. cd projFolder

Search through all the files in that folder that have the word blog, in them via

grep -nr "blog" projFolder/

That command will show up a bunch of results, which will show So what are -nr?


  • -n: show the line numbers in the search results
  • -r: recursively search through all the sub-directories of the folder being searched in, which in this case is projFolder
  • -nr: If we want to use both -n and -r for the same search, we can just chain them together i.e. -nr instead of doing -n -r.
Say projFolder contains a certain file i.e. global.min.js that i wanted to ignore in my search,  ok lets do that then

grep -nr "blog" --exclude=global.min.js projFolder/

The --exclude option does exactly what you would expect to do, ignore the files while doing the search. Ok so what if i want to exclude both global.min.js and all html files?


grep -nr "blog" --exclude={global.min.js,*.html} projFolder/

It is actually quite simple, we can just write the search results to another file. The files or a group of files to be ignored can be added in the {} operator would ensure those files are not looked at while searching through the files. The conditions to ignore must be separated by a comma (,) and you must make sure that there is not space before or after the comma.  Now lastly, say my search returns lots of results and i wish to analyse the results in a text editor rather than the terminal?

grep -nr "blog" --exclude={global.min.js,*.html} projFolder/ > searchResults.txt

With that command, a new file called searchResults.txt will be created in the directory from which the grep command was executed.

A tool like grep is very useful and it help save a lot time when familiarising yourself with a new project. To know more about grep, simply open the terminal and type

man grep


Comments

Popular posts from this blog

Upload to AWS S3 from Java API

In this post, you will see code samples for how to upload a file to AWS S3 bucket from a Java Spring Boot app. The code you will see here is from one of my open-source repositories on Github, called document-sharing. Problem Let’s say you are building a document sharing app where you allow your users to upload the file to a public cloud solution. Now, let’s say you are building the API for your app with Spring Boot and you are using AWS S3 as your public cloud solution. How would you do that? This blog post contains the code that can help you achieve that. Read more below,  Upload to AWS S3 bucket from Java Spring Boot app - My Day To-Do (mydaytodo.com)

Addressing app review rejections for auto-renewing subscription in-app purchase (iOS)

The ability to know what the weather is like while planning your day is a feature of  My Day To-Do  Pro and as of the last update it’s also a part of the  Lite version . Unlike the Pro version it’s an auto-renewing subscription based  in-app purchase (IAP)  in the Lite version. What means is that when a user purchases it, the user only pays for the subscription duration after which the user will be automatically charged for the next period. Adding an  auto-renewing  subscription based IAP proved to be somewhat challenging in terms of the app store review i.e. the app update was rejected by the App Review team thrice because of missing information about the IAP. Therefore in this post I will share my experiences and knowledge of adding auto-renewing IAP in hopes to save someone else the time that I had to spend on this problem. In-App purchase This year I started adding IAPs to My Day To-Do Lite which lead to learning about different types of IAP...

Ionic app with a Django backend: Part 2 - The Ionic app

In this post, I will continue from where we left in Part 1 of this series.  In part 2, I will talk more about the front-end side of things. Ahh, I have a background in web development, hence I call this front-end, but that's not the most accurate thing to say in these modern times. So the right way to say this is, I will talk about the Ionic app in this Github repository(IonicAppWithRestBackend) in more details in this post. So what did we do in part 1? In part 1, we got to the point of running our backend on the web server that ships with Django . To refresh your memory, this is how we got the backend server running, Clone the repo git clone https://github.com/cptdanko/IonicAppWithRestBackend Navigate to the backend project directory cd IonicAppWithRestBackend/backend/python_django/restBackend/ Note: if you are using Windows, you may want to change "/" to "\" in the above command. Once there you can run the backend server with the follow...