Summary

[Demo] Enhance and fix up the setup experience in prepare-dev.py.

Review Request #11806 — Created Sept. 17, 2021 and discarded March 24, 2022, 8:37 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This modernizes the way we request input and display output on
prepare-dev.py, utilizing more of rb-site's ConsoleUI. This is a
better, more consistent way of displaying information and prompting for
information.

The text has been updated to be more user-friendly, to offer
guidance for when things go wrong, and to provide next steps when the
environment is prepared.

Testing Done

Ran prepare-dev.py and verified that it set up my tree correctly without
any errors.

Commits

Summary	ID
[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da

Summary

[Demo] Enhance and fix up the setup experience in prepare-dev.py.

This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.

e30f2fcf4418c1fd419ba7d034fbcabb3accca92

Fixes from review feedback.

e77f748462f8a4a61f0dca6076dfd58b00a308da

Issues

Description	From	Last Updated
Typo in description: prepare-dev.ppy -> prepare-dev.py	david	Sept. 17, 2021, 5:52 p.m.
Please flesh out the testing done section.	david	Sept. 17, 2021, 5:52 p.m.
There needs to be a blank line between the description and "Type"	david	Oct. 20, 2021, 1:58 a.m.
Typo: two spaces between "in" and "the"	david	Sept. 17, 2021, 5:52 p.m.
E126 continuation line over-indented for hanging indent	reviewbot	Sept. 17, 2021, 5:52 p.m.
This will assign to a locally scoped ui variable. You need to add global ui	david	Oct. 20, 2021, 1:57 a.m.
Please add a blank line after return	david	Sept. 17, 2021, 5:53 p.m.
Because these get concatenated, you need a space at the end of the first string.	david	Sept. 17, 2021, 5:53 p.m.

flake8 failed.

JSHint passed.

flake8

contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E126 continuation line over-indented for hanging indent
```

Fix it!

Most of this looks good, but please pay close attention to the global variable issue.

The issue has been resolved. Show all issues

Typo in description: prepare-dev.ppy -> prepare-dev.py

The issue has been resolved. Show all issues
```
Please flesh out the testing done section.
```
contrib/internal/prepare-dev.py (Diff revision 1)
An issue was opened. Show all issues
```
There needs to be a blank line between the description and "Type"
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: two spaces between "in" and "the"
```

contrib/internal/prepare-dev.py (Diff revision 1)

What does os.system do?

chipx86 Sept. 17, 2021, 5:50 p.m.

It's used to execute processes, similar to running a command in a shell. It's not always the right approach — the subprocess module is sometimes the better solution here.

contrib/internal/prepare-dev.py (Diff revision 1)

An issue was opened. Show all issues

This will assign to a locally scoped ui variable. You need to add global ui

contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please add a blank line after return
```

contrib/internal/prepare-dev.py (Diff revision 1)

The issue has been resolved. Show all issues

Because these get concatenated, you need a space at the end of the first string.

Change Summary:


Fixed typos in docstrings and docs.
Added global ui before assigning ConsoleUI.

Description:

		This modernizes the way we request input and display output on
~		`prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a
	~	`prepare-dev.py`, utilizing more of rb-site's `ConsoleUI`. This is a
		better, more consistent way of displaying information and prompting for
		information.

		The text has been updated to be more user-friendly, to offer
		guidance for when things go wrong, and to provide next steps when the
		environment is prepared.

Testing Done:

~		Fixed the bug.
	~	Ran `prepare-dev.py` and verified that it set up my tree correctly without
	+	any errors.

Commits:

	Summary	ID
	[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
	[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
	Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da

Diff:

Revision 2 (+139 -49)

Show changes

contrib/internal/prepare-dev.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Discarded