Skip to content

Enhance sourceMapIncludeSources option #2097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ntkme wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance sourceMapIncludeSources option #2097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions js-api-spec/compile.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
import {compileString, compileStringAsync} from 'sass';
import type {OutputStyle} from 'sass';

import {URL} from './utils';

describe('compileString', () => {
describe('success', () => {
describe('input', () => {
Expand Down Expand Up @@ -67,6 +69,98 @@ describe('compileString', () => {
expect(sourceMap.sourcesContent!).toBeArray();
expect(sourceMap.sourcesContent!.length).toBeGreaterThanOrEqual(1);
});

it('includes source content for stylesheet without explictly defined sourceMapUrl if sourceMapIncludeSources is "auto"', () => {
const result = compileString('@use "u:explict"; @use "u:implict";', {
sourceMap: true,
sourceMapIncludeSources: 'auto',
importers: [
{
canonicalize: (url: string) => new URL(url),
load(url: typeof URL) {
const path = url.pathname;
return {
contents: `.${path} {content: ${path}}`,
syntax: 'scss',
sourceMapUrl: path === 'explict' ? url : undefined,
};
},
},
],
});
expect(result).toHaveMember('sourceMap');

const sourceMap = result.sourceMap!;
expect(sourceMap).toHaveMember('sources');
expect(sourceMap.sources!).toBeArray();
expect(sourceMap).toHaveMember('sourcesContent');
expect(sourceMap.sourcesContent!).toBeArray();
expect(
sourceMap.sourcesContent![sourceMap.sources!.indexOf('u:explict')],
).toBeNull();
expect(
sourceMap.sourcesContent![sourceMap.sources!.indexOf('u:implict')],
).toBeString();
});

it('includes all source content if sourceMapIncludeSources is "always"', () => {
const result = compileString('@use "u:explict"; @use "u:implict";', {
sourceMap: true,
sourceMapIncludeSources: 'always',
importers: [
{
canonicalize: (url: string) => new URL(url),
load(url: typeof URL) {
const path = url.pathname;
return {
contents: `.${path} {content: ${path}}`,
syntax: 'scss',
sourceMapUrl: path === 'explict' ? url : undefined,
};
},
},
],
});
expect(result).toHaveMember('sourceMap');

const sourceMap = result.sourceMap!;
expect(sourceMap).toHaveMember('sources');
expect(sourceMap.sources!).toBeArray();
expect(sourceMap).toHaveMember('sourcesContent');
expect(sourceMap.sourcesContent!).toBeArray();
expect(
sourceMap.sourcesContent![sourceMap.sources!.indexOf('u:explict')],
).toBeString();
expect(
sourceMap.sourcesContent![sourceMap.sources!.indexOf('u:implict')],
).toBeString();
});

it('includes no source content if sourceMapIncludeSources is "never"', () => {
const result = compileString('@use "u:explict"; @use "u:implict";', {
sourceMap: true,
sourceMapIncludeSources: 'never',
importers: [
{
canonicalize: (url: string) => new URL(url),
load(url: typeof URL) {
const path = url.pathname;
return {
contents: `.${path} {content: ${path}}`,
syntax: 'scss',
sourceMapUrl: path === 'explict' ? url : undefined,
};
},
},
],
});
expect(result).toHaveMember('sourceMap');

const sourceMap = result.sourceMap!;
expect(sourceMap).toHaveMember('sources');
expect(sourceMap.sources!).toBeArray();
expect(sourceMap).not.toHaveMember('sourcesContent');
});
});

describe('charset', () => {
Expand Down
Loading