Go modules overview - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Go module?

A Go module is a collection of Go packages stored in a file tree with a go.mod file at its root. It defines the module's path and its dependency requirements.

beginner

What is the purpose of the go.mod file?

The go.mod file declares the module's path and lists the specific versions of dependencies the module requires. It helps Go manage dependencies consistently.

beginner

How do you create a new Go module?

You create a new Go module by running the command go mod init <module-path> in your project folder. This creates a go.mod file.

intermediate

What command updates dependencies in a Go module?

The command go get updates or adds dependencies in your module. It modifies go.mod and downloads the needed versions.

intermediate

Why are Go modules important compared to GOPATH?

Go modules allow versioning and better dependency management outside GOPATH. They make projects reproducible and easier to share.

Which file defines a Go module's dependencies?

A main.go

B go.mod

C go.sum

D module.go

The go.mod file lists the module path and its dependencies.

What command initializes a new Go module?

A go run

B go get <package>

C go build

D go mod init <module-path>

The 'go mod init' command creates a new go.mod file for your module.

What does the go.sum file do?

A Stores checksums to verify module integrity

B Lists all Go source files

C Defines module path

D Specifies Go version

go.sum contains cryptographic hashes to ensure dependencies are not tampered with.

How do Go modules improve dependency management?

A By storing all code in GOPATH

B By removing the need for imports

C By allowing versioning and reproducible builds

D By compiling faster

Modules track versions and ensure consistent builds across environments.

Which command updates dependencies in a Go module?

A go get

B go mod tidy

C go build

D go clean

The 'go get' command adds or updates dependencies in go.mod.

Explain what a Go module is and why it is useful.

Think about how Go modules help organize and manage code and dependencies.

Describe the steps to create and manage dependencies in a Go module.

Consider the commands and files involved in starting and maintaining a module.

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