Source maps for debugging in SASS - Mini Project: Build & Apply

Source Maps for Debugging in Sass

📖 Scenario: You are working on a website's styles using Sass. To make debugging easier, you want to create source maps. Source maps help you see the original Sass code in the browser's developer tools instead of the compiled CSS.

🎯 Goal: Create a Sass file with some styles, configure Sass to generate source maps, compile the Sass to CSS with source maps enabled, and link the source map in the CSS file.

📋 What You'll Learn

Create a Sass file named styles.scss with some basic styles.

Add a configuration variable to enable source maps during compilation.

Compile the Sass file to CSS with source maps enabled.

Ensure the compiled CSS file links to the source map for debugging.

💡 Why This Matters

🌍 Real World

Source maps are used by web developers to debug styles easily in browsers by seeing the original Sass code instead of compiled CSS.

💼 Career

Knowing how to generate and use source maps is important for front-end developers to efficiently fix style issues and maintain code.

1

Create the Sass file with basic styles

Create a file named styles.scss and write these styles exactly: a body selector with background-color: #f0f0f0; and a p selector with color: #333;.

SASS

# Your code here

Hint

Write the selectors body and p with the exact properties and values given.

2

Add configuration to enable source maps

Create a configuration variable named enableSourceMap and set it to true to indicate source maps should be generated.

SASS

body {
  background-color: #f0f0f0;
}

p {
  color: #333;
}

// Your code here

Hint

Use a Sass variable named $enableSourceMap and assign it the value true.

3

Compile Sass to CSS with source maps enabled

Use the Sass command line to compile styles.scss to styles.css with source maps enabled by adding the --source-map flag.

SASS

body {
  background-color: #f0f0f0;
}

p {
  color: #333;
}

$enableSourceMap: true;

// Your code here

Hint

Use the sass command with the --source-map option to generate source maps.

4

Link the source map in the compiled CSS

Ensure the compiled styles.css file includes a comment at the end linking to styles.css.map like /*# sourceMappingURL=styles.css.map */.

SASS

body {
  background-color: #f0f0f0;
}

p {
  color: #333;
}

$enableSourceMap: true;

// Run this command in terminal:
// sass styles.scss styles.css --source-map

/* Your code here */

Hint

Look at the end of the compiled CSS file and add the source map comment linking to styles.css.map.

Practice

1. What is the main purpose of source maps when working with Sass?

easy

A. To convert Sass files into JavaScript

B. To minify the CSS output for faster loading

C. To link compiled CSS back to the original Sass files for easier debugging

D. To automatically fix syntax errors in Sass code

Solution

1. Step 1: Understand what source maps do

   Source maps create a connection between the compiled CSS and the original Sass files.

2. Step 2: Identify the debugging benefit

   This connection helps developers see the original Sass code in browser DevTools, making debugging easier.

3. Final Answer:

   To link compiled CSS back to the original Sass files for easier debugging -> Option C

4. Quick Check:

   Source maps = link CSS to Sass for debugging [OK]

Hint: Source maps help find Sass code from CSS in browser tools [OK]

Common Mistakes:

• Thinking source maps minify CSS
• Believing source maps fix code errors automatically
• Confusing source maps with JavaScript conversion

2. Which command correctly generates a source map when compiling Sass from the command line?

easy

A. sass input.scss output.css --no-source-map

B. sass input.scss output.css --minify

C. sass input.scss output.css --watch

D. sass input.scss output.css --source-map

Solution

1. Step 1: Identify the flag for source maps

   The --source-map flag tells Sass to generate source maps during compilation.

2. Step 2: Check the command options

   sass input.scss output.css --source-map uses --source-map, which is correct. Other options either disable source maps or do unrelated tasks.

3. Final Answer:

   sass input.scss output.css --source-map -> Option D

4. Quick Check:

   Use --source-map flag to generate source maps [OK]

Hint: Look for --source-map flag to enable source maps [OK]

Common Mistakes:

• Using --no-source-map disables source maps
• Confusing --watch with source map generation
• Using --minify does not create source maps

3. Given the Sass file style.scss compiled with source maps, what will you see in browser DevTools when inspecting an element styled by Sass?

medium

A. The original Sass file and line number where the style is defined

B. Only the compiled CSS file with no reference to Sass

C. An error message about missing source maps

D. The JavaScript file controlling styles

Solution

1. Step 1: Understand source map effect in DevTools

   Source maps allow DevTools to show the original Sass file and exact line for styles.

2. Step 2: Identify what is displayed when source maps exist

   With source maps, DevTools shows Sass source, not just compiled CSS, helping debugging.

3. Final Answer:

   The original Sass file and line number where the style is defined -> Option A

4. Quick Check:

   DevTools shows Sass source with source maps [OK]

Hint: Source maps show Sass file and line in DevTools [OK]

Common Mistakes:

• Expecting only CSS without Sass info
• Thinking source maps cause errors in DevTools
• Confusing styles with JavaScript files

4. You compiled Sass with sass input.scss output.css but cannot see Sass source in browser DevTools. What is the likely problem?

medium

A. Your Sass file has syntax errors

B. You forgot to add the --source-map flag during compilation

C. Browser DevTools do not support source maps

D. You need to refresh the Sass compiler

Solution

1. Step 1: Check compilation command for source map flag

   The command lacks --source-map, so no source maps were generated.

2. Step 2: Understand impact on DevTools

   Without source maps, DevTools cannot link CSS back to Sass source files.

3. Final Answer:

   You forgot to add the --source-map flag during compilation -> Option B

4. Quick Check:

   Missing --source-map means no source maps [OK]

Hint: Always add --source-map to see Sass in DevTools [OK]

Common Mistakes:

• Assuming syntax errors cause missing source maps
• Believing DevTools lack source map support
• Thinking refreshing compiler fixes missing source maps

5. You want to debug a complex Sass project with multiple partials and nested imports. How should you configure source maps to best help debugging?

hard

A. Compile Sass with --source-map enabled and use browser DevTools to trace styles back to original partial files

B. Disable source maps to speed up compilation and debug only compiled CSS

C. Manually copy Sass code into CSS comments for debugging

D. Use JavaScript to log Sass variables during runtime

Solution

1. Step 1: Enable source maps during compilation

   Using --source-map generates maps linking CSS to all Sass partials and nested files.

2. Step 2: Use browser DevTools for tracing

   DevTools can then show exact Sass partial and line for each style, simplifying debugging.

3. Final Answer:

   Compile Sass with --source-map enabled and use browser DevTools to trace styles back to original partial files -> Option A

4. Quick Check:

   Enable source maps + DevTools = best debugging [OK]

Hint: Enable source maps and use DevTools for multi-file Sass debugging [OK]

Common Mistakes:

• Disabling source maps thinking it speeds debugging
• Trying to debug by copying Sass into CSS comments
• Using JavaScript logging for Sass variables