Go modules overview - Mini Project: Build & Apply

Go Modules Overview

📖 Scenario: You are creating a simple Go program that uses Go modules to manage dependencies. This helps you keep your project organized and makes it easy to share your code.

🎯 Goal: Build a basic Go module project with a go.mod file, add a dependency, and write a simple program that uses that dependency.

📋 What You'll Learn

Create a new Go module with the name example.com/hello

Add the golang.org/x/text module as a dependency

Write a Go program that imports golang.org/x/text/language and prints a language tag

Print the language tag to the console

💡 Why This Matters

🌍 Real World

Go modules help developers manage project dependencies easily, making it simple to build and share Go programs.

💼 Career

Understanding Go modules is essential for Go developers to maintain clean projects and collaborate effectively in professional environments.

1

Initialize a new Go module

Create a new Go module named example.com/hello by writing the line module example.com/hello in a file called go.mod.

Go

# Create a file named go.mod and add the line:
# module example.com/hello

Hint

The go.mod file starts with the module keyword followed by your module path.

2

Add a dependency to the module

Add the dependency golang.org/x/text to your module by running go get golang.org/x/text or by adding it manually in go.mod under require.

Go

module example.com/hello

// Add the dependency golang.org/x/text here
# Your code here

Hint

You can add dependencies by running go get or by editing go.mod to include a require line.

3

Write a Go program using the dependency

Create a file named main.go and write a Go program that imports golang.org/x/text/language. Inside main, create a variable tag using language.Make("en").

Go

package main

import (
	"golang.org/x/text/language"
)

func main() {
	// Create a variable tag using language.Make("en")
	// Your code here
}

Hint

Import fmt to print the tag. Use language.Make("en") to create the tag.

4

Run the program and display the output

Run the program and print the value of tag to the console using fmt.Println(tag).

Go

package main

import (
	"fmt"
	"golang.org/x/text/language"
)

func main() {
	tag := language.Make("en")
	// Print the tag variable
	// Your code here
}

Hint

Use fmt.Println(tag) to show the language tag on the screen.

Practice

1. What is the main purpose of Go modules in a Go project?

easy

A. To compile Go code faster

B. To manage project dependencies and versions easily

C. To replace the Go compiler

D. To write Go code without packages

Solution

1. Step 1: Understand what Go modules do and compare options

   Go modules help manage dependencies and versions in a Go project. Only "To manage project dependencies and versions easily" correctly describes this purpose; others are unrelated.

2. Final Answer:

   To manage project dependencies and versions easily -> Option B

3. Quick Check:

   Go modules = dependency management [OK]

Hint: Remember: modules manage dependencies and versions [OK]

Common Mistakes:

• Thinking modules speed up compilation
• Confusing modules with compiler tools
• Believing modules remove packages

2. Which command initializes a new Go module in your project directory?

easy

A. go mod init

B. go build

C. go run

D. go get

Solution

1. Step 1: Identify the command to start a module and check others

   The command go mod init creates a new module in the current directory. go build compiles code, go run runs code, and go get fetches packages, so they don't initialize modules.

2. Final Answer:

   go mod init -> Option A

3. Quick Check:

   Initialize module = go mod init [OK]

Hint: Init module with 'go mod init' command [OK]

Common Mistakes:

• Using 'go build' to start a module
• Confusing 'go get' with module initialization
• Trying 'go run' to create modules

3. What does the command go mod tidy do when run in a Go module project?

medium

A. It compiles the project

B. It deletes the go.mod file

C. It runs all tests

D. It removes unused dependencies and adds missing ones

Solution

1. Step 1: Understand the purpose of 'go mod tidy' and compare options

   This command cleans the module dependencies by removing unused ones and adding any missing required dependencies. Options A, C, and D describe unrelated actions like compiling, testing, or deleting files.

2. Final Answer:

   It removes unused dependencies and adds missing ones -> Option D

3. Quick Check:

   go mod tidy = clean dependencies [OK]

Hint: Use 'go mod tidy' to clean dependencies [OK]

Common Mistakes:

• Thinking it compiles code
• Assuming it runs tests
• Believing it deletes module files

4. You ran go mod init myproject but got an error saying "go.mod file already exists". What is the likely cause?

medium

A. The Go compiler is not installed

B. You need to run 'go mod tidy' first

C. You already have a go.mod file in the directory

D. You must delete the main.go file first

Solution

1. Step 1: Understand the error and check other options

   The error "go.mod file already exists" means the module file is already present in the directory. Running 'go mod tidy' or deleting main.go won't fix this. The compiler installation is unrelated.

2. Final Answer:

   You already have a go.mod file in the directory -> Option C

3. Quick Check:

   Existing go.mod file causes this error [OK]

Hint: Check if go.mod already exists before init [OK]

Common Mistakes:

• Trying to tidy before init
• Assuming compiler missing causes error
• Deleting unrelated files to fix error

5. You want to share your Go project with others and ensure they get the exact dependencies you used. Which two commands should you run to prepare your project? (Choose the best pair)

hard

A. go mod vendor and go mod tidy

B. go build and go run

C. go get and go test

D. go mod init and go mod tidy

Solution

1. Step 1: Identify commands to prepare modules for sharing and evaluate options

   go mod vendor copies dependencies into the vendor directory, ensuring exact versions are included, and go mod tidy cleans dependencies to ensure correctness. go mod init creates the module file but is usually done once at project start. Other options do not prepare dependencies for sharing.

2. Final Answer:

   go mod vendor and go mod tidy -> Option A

3. Quick Check:

   Vendor + tidy prepare exact dependencies for sharing [OK]

Hint: Use 'go mod vendor' and 'go mod tidy' before sharing [OK]

Common Mistakes:

• Using build or run commands for module setup
• Confusing get or test with module preparation
• Relying only on init and tidy without vendoring