Verb-Noun naming convention in PowerShell - Mini Project: Build & Apply

Verb-Noun Naming Convention in PowerShell

📖 Scenario: You are creating PowerShell functions to automate simple tasks. Using the correct naming style helps others understand what your functions do quickly.PowerShell uses a Verb-Noun naming style for functions. For example, Get-Item or Set-Content.

🎯 Goal: Learn to create PowerShell functions with proper Verb-Noun names and call them to see their output.

📋 What You'll Learn

Create a PowerShell function with a Verb-Noun name

Use the Write-Output cmdlet inside the function

Call the function to display its output

💡 Why This Matters

🌍 Real World

Using clear Verb-Noun names in PowerShell functions helps system administrators and automation engineers write scripts that are easy to understand and maintain.

💼 Career

Many IT jobs require writing PowerShell scripts. Following naming conventions is a key skill for professional scripting and automation.

1

Create a simple function with a Verb-Noun name

Create a PowerShell function called Get-Greeting that uses Write-Output to output the text 'Hello, PowerShell!'.

PowerShell

# Create the function Get-Greeting below
# Your code here

Hint

Use the function keyword, then the name Get-Greeting, and inside use Write-Output to print the greeting.

2

Add a variable to store the greeting message

Inside the Get-Greeting function, create a variable called $message and set it to 'Hello, PowerShell!'. Then use Write-Output to output $message.

PowerShell

function Get-Greeting {
    # Create variable $message with the greeting text
    # Your code here
}

Hint

Assign the greeting text to $message and then output it with Write-Output.

3

Call the function to display the greeting

Call the function Get-Greeting to display the greeting message.

PowerShell

function Get-Greeting {
    $message = 'Hello, PowerShell!'
    Write-Output $message
}

# Call the function Get-Greeting below
# Your code here

Hint

Simply type the function name Get-Greeting to call it and see the output.

4

Print the output of the function call

Use Write-Output to print the result of calling Get-Greeting.

PowerShell

function Get-Greeting {
    $message = 'Hello, PowerShell!'
    Write-Output $message
}

Get-Greeting

# Print the output of Get-Greeting using Write-Output
# Your code here

Hint

Use Write-Output (Get-Greeting) to print the greeting returned by the function.

Practice

1. What does the Verb-Noun naming convention in PowerShell primarily help with?

easy

A. Encrypting scripts for security

B. Shortening command names

C. Adding comments to scripts

D. Making commands clear and consistent

Solution

1. Step 1: Understand the purpose of Verb-Noun naming

   The Verb-Noun style is designed to make commands easy to read and understand by showing the action and the target clearly.

2. Step 2: Identify the main benefit

   This naming style helps users quickly know what a command does, improving clarity and consistency.

3. Final Answer:

   Making commands clear and consistent -> Option D

4. Quick Check:

   Verb-Noun naming = clarity and consistency [OK]

Hint: Verb shows action, noun shows target for clarity [OK]

Common Mistakes:

• Thinking it shortens command names
• Confusing it with script encryption
• Believing it adds comments automatically

2. Which of the following is the correct syntax for a PowerShell function name following the Verb-Noun convention?

easy

A. Get-Process

B. ProcessGet

C. GetProcess

D. process-get

Solution

1. Step 1: Identify the correct Verb-Noun format

   The correct format uses a verb, a dash, then a noun, like 'Get-Process'.

2. Step 2: Compare options

   Only Get-Process uses the dash and proper order; others do not follow the convention.

3. Final Answer:

   Get-Process -> Option A

4. Quick Check:

   Verb-Noun = Verb-Noun with dash [OK]

Hint: Look for verb-noun separated by a dash [OK]

Common Mistakes:

• Omitting the dash between verb and noun
• Reversing noun and verb order
• Using camelCase instead of dash

3. What will be the output of this PowerShell command if you define a function named Set-UserName and call it with Set-UserName -Name 'Alice' assuming the function prints the name parameter?

function Set-UserName { param($Name) Write-Output "User name is $Name" }

medium

A. Error: Unknown command

B. Set-UserName -Name Alice

C. User name is Alice

D. User name is $Name

Solution

1. Step 1: Understand the function definition

   The function takes a parameter called Name and outputs a string including that parameter.

2. Step 2: Analyze the function call

   Calling Set-UserName with -Name 'Alice' passes 'Alice' to the $Name parameter, so the output is 'User name is Alice'.

3. Final Answer:

   User name is Alice -> Option C

4. Quick Check:

   Parameter passed correctly = output with name [OK]

Hint: Parameters passed by name show in output [OK]

Common Mistakes:

• Expecting the command name as output
• Not recognizing variable substitution
• Assuming an error without function definition

4. Identify the error in this PowerShell function name that violates the Verb-Noun naming convention:

function Process-Data { Write-Output "Processing" }

medium

A. Verb should be a standard approved verb

B. Noun should come before verb

C. Missing dash between verb and noun

D. Verb is not approved

Solution

1. Step 1: Check the function name structure

   The name 'Process-Data' uses a dash and has verb-noun order, so structure is correct.

2. Step 2: Verify the verb against approved verbs

   'Process' is not an approved PowerShell verb, so it violates the naming convention.

3. Final Answer:

   Verb should be a standard approved verb -> Option A

4. Quick Check:

   Approved verbs required = Verb should be a standard approved verb [OK]

Hint: Use only approved verbs in function names [OK]

Common Mistakes:

• Thinking noun comes before verb
• Ignoring approved verb list
• Assuming dash is missing

5. You want to create a PowerShell function that deletes temporary files. Which of these names follows the Verb-Noun naming convention correctly and uses an approved verb?

hard

A. Erase-TempFiles

B. Remove-TempFiles

C. Delete-TempFiles

D. ClearTempFiles

Solution

1. Step 1: Identify approved verbs for deleting

   PowerShell approved verbs for deleting include 'Remove' and 'Clear', but 'Delete' and 'Erase' are not approved.

2. Step 2: Check naming format

   Remove-TempFiles uses 'Remove' (approved verb), a dash, and 'TempFiles' (noun), following Verb-Noun convention correctly.

3. Step 3: Evaluate other options

   Erase-TempFiles uses unapproved verb 'Erase', Delete-TempFiles uses unapproved verb 'Delete', and ClearTempFiles lacks dash between verb and noun.

4. Final Answer:

   Remove-TempFiles -> Option B

5. Quick Check:

   Approved verb + dash + noun = Remove-TempFiles [OK]

Hint: Use approved verbs like Remove with dash and noun [OK]

Common Mistakes:

• Using unapproved verbs like Delete or Erase
• Omitting dash between verb and noun
• Combining words without dash