DDEV DDEV-Local tutorials, 13 Aug 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Simplifying Docker and PHP-based Local Development with DDEV-Local’s Custom Commands and zsh

Description

DDEV-Local is a powerful open-source local development environment for PHP developers that comes preconfigured with environments for Drupal 6/7/8, TYPO3 CMS, Backdrop CMS, WordPress, Magento, and more — plus its more recent versions (v1.10+) add custom commands and other goodies that increase the simplicity and time savings offered.

In this screencast, we’ll show you how to make these commands to add web server packages and extras in “.ddev/homeadditions” to support your specific project needs.

As the title suggests, many folks absolutely love “zsh” and “oh-my-zsh” (an alternative Unix shell and an accompanying framework) — so we’ll demonstrate these features by showing you how to add “zsh” and “oh-my-zsh” to a DDEV project, including how to:

Add the “zsh” Debian package into the web container with “webimage_extra_packages”
Add a custom command that works just like “ddev ssh”, but it’s going to be “ddev zsh”
Add all the scaffolding for “oh-my-zsh” in the home directory for lovers of “oh-my-zsh”

For a full list of instructions, click here to read the accompanying blog post: https://bit.ly/3oIq7f4
If you’re new to the community and eager to get started, check out the Quickstart guides: https://bit.ly/37W8rXk

A

Hi, my name is Randy Faye, I'm, Aarthi and most of the world I work on the deed, a local project which is a way to get local development. Web environments on your local machine on Mac or Linux or Windows works all over the place and I'm going to go through this article that we're looking through looking at here. It's a it's. It does three advanced things, but they're they're, all very easy and I just want to demonstrate them. What we're gonna do is just a sample project.

A

Is we're gonna, add oh, my zsh to the web container of a DJ of local project. Now you may or may not need to do this. Some people are very, very much addicted to zsh and oh my zsh, and we want to cater to you, but more than that, we want to demonstrate the three things that we're going to do to do this. So we are going to first of all, just add a zsh package, the debian package into the web container and that's just a little config setup. We're going to do that.

A

That's easy enough, then we're gonna add a DITA of zsh command, which is just like DITA of SSH, but it instead of running bash. It runs esh so that zsh users will be happy. That again is just adding a simple script into the project and then the third thing we're gonna do. Is it's not hard, but it's just a little more work. All the scaffolding for zsh.

A

We want that to be added into the home directory every time. Somebody starts up everything and that's an optional step, but we're gonna try to do that, so we're going to give that a shot. Okay, let's start out again. The first thing we're going to do is we're gonna. Just add this web image extra packages, so I'm gonna go over to my terminal, and here I have just a this- is just an ordinary composer bill, Drupal 8 site that I have here doesn't matter what it could be.

A

It could be anything but but it's just an out of the box, nothing done to it d, dev setup, so I am going to I'll. Do it with the command line. Let's do it d dev config web web image, extra packages equals Z SH, and that is just gonna. Add that line to the config yeah mo. Let's just take a look at what it just did.

A

So all it did was add this line just like what we were to what we'd expect it to do so: editing the config dot, Y amel and using the command line they're the same same exact thing: okay! So now, if I do a deed of start, that package is going to get built into the web container.

A

So now we we've got that up and if I do a deed of I do a deed of SSH. Here I can just run zsh because the package is now installed and I'm not going to do anything right now, because we're gonna do all this work anyway, but zsh is now installed and I can do everything that we need to do and I'm gonna exit out as e SH and exit out of there, so that we did the first part.

A

Now we we have added the zsh package and the CSH binary is now available to us. You can add any package, that's available in Debian, using that web image extra packages, technique and, and that helps that helps everybody, because in the past we used it for every feature request. We had to add new stuff into the web container, and now you can do it yourself and have exactly in the environment. You need in the web container. Okay. So let's do the second part we're going to.

A

Let's just take a look at what we're gonna do here we are going to add this little script. This is a custom script. This is a custom command D de inversión 1.10 plus has the ability for you to add your own commands in 2d dev with a simple bash script.

A

So I'm gonna copy this and we'll just paste that we're gonna go into D dev commands- and this goes in the web container- is where it's gonna execute so I'm going to I'm going to just cat it into a file called CSH and there it is and I'm going to make it executable.

A

And let's just take a look at that because it's awfully awfully easy look at what we're doing here. All we're doing is we're adding a command called gsh and we did it with that much non code. That's it! And now, if I do a deed of, if I, just type D dev you see, I have a zsh command here. It says SSH into web container using C SH and it says it's a custom web container command.

A

So now now that I've done that I can actually use that and I'll do a bead of Z SH, and it's going to give me the same complaint again about wanting to set up the Z SHRC and I. Don't want to do that yet so I'm going to move on to the next part that what we're going to do.

A

So let's go back and take a look at the article we're stepping through here.

A

Okay, so if you had your own Z shrc that you're happy with you can copy that into the home additions directory at this point, or if you you know, you can do it, you can do a lot of things in that point, but we're gonna do the oh. My is e sh way if you're not familiar with oh my z, SH, if you're not addicted to it, then you may want to take a look at the write-up about it over here.

A

You can just search for oh, my z, SH and you'll find it in no time. I am a bash addict, I! Guess I'm, not a know. My zsh addict, but I know how addictive that is, and you know who you are out there and we want you to be happy. So if you already have the stuff that you need for that, you can copy it into dot DITA at home editions.

A

But we are going to use this technique here, we're going to go into home, editions and we're going to curl the let's see if I can copy this, maybe I can't we are going to curl the Installer down and then we're going to run it. So, let's just do that.

A

This home additions is new in version 110 and what it is is everything in this directory gets copied into the home directory of the web user when you do a deed of start, and so, if you need your own custom, dot, SSH config or if you need a composer author Jason, this is the place for it.

A

In our case, we're gonna put the o-mai zsh stuff here, so we're gonna curl that installer down here we got the installer from from the site and now we're going to go ahead and do this install technique, which is this is a. This is a little awkward, because zsh assumes that it owns the whole machine and we're actually working in a different place, but we're going to say to put the o-mai zsh in the current directory here and then we're going to install it. Oh and I have to install zsh in my debian here.

A

So hang on. Just second.

A

So now to do it, go back up and we're going to put it in there and it's gonna happily give me it's gonna give me an extra zs HRC that I didn't actually want, but I'm gonna copy, the one that it made over into this directory. Because remember this is the directory where stuff is going to get copied into the web container and.

A

Now we have a Z shrc, we have an O, my z, SH and there's one thing we have to do to correct the work of the Installer and.

A

It's right here this CSH statement. Remember it doesn't understand the context that it was at N, so we're just gonna change this to tilde slash dot. Oh my G Sh! So that's what we want in there. Oh I didn't get it right. Oh yeah, right.

A

Okay, there we go and that should be right: dot, o my z, SH and now I'm gonna do a deed of restart and what happens is everything in this directory? That is not an example.

A

File gets copied in when we do this, so I'm gonna do a deed of restart and it's going to cause the the container to be rebuilt and the stuff in this directory to be to be brought in the first thing I'm going to do when we get in there is I'm going to just do a DITA of SSH to show those files that get copied in there into the container so I'm gonna do a diva of SSH and I'm gonna go to the home directory, and you see the oh, my zsh is there and the z SHRC is there and the example?

A

Is there? Okay? So now everything's in there watch this d, dev z s H, now I'm gonna, clear the screen first deed of these eh. Will it work and there it is, and it doesn't work very well on a on a white screen like this, but there it is running zsh.

A

We're missing the part over here on the left side cos we're on a white on a white screen, but that's the whole scoop. Let me just review what we actually just did, because it each section was fairly simple as he you know. Oh, my zsh. Isn't that simple, but the ideas here are really straightforward. Ok, we added an extra package which we just did with web image extra packages. That's just a config option.

A

Then we added a custom command to use to add deed of zsh and then basically, we just added- oh, my oh, my Z SH and a dot z, SH, our C into D des of home additions and that stuff gets added to the web directory. When we do a deed of start. The dev restart there's docks for each of those steps here and love to hear your experience with each of these three things.

A

They can be used a pile of different ways and we'd love to hear how you use them anyway, thanks a whole bunch and have a great day today,.