Skip to content
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.

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

add an option to render scss synchronously via renderSync #123

Merged
merged 2 commits into from
Mar 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,11 @@ const options = {
/** Disable a language by setting it to 'false' */
scss: false,

/** or pass an option to render synchronously and any other node-sass or sass options*/
scss: {
renderSync: true
},

/** Pass options to the default preprocessor method */
stylus: {
paths: ['node_modules'],
Expand Down
49 changes: 38 additions & 11 deletions src/transformers/scss.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,25 @@ let sass: {
options: SassOptions,
callback: (exception: SassException, result: Result) => void,
) => void;
renderSync: (
options: SassOptions
) => Result;
};

type ResolveResult = {
code: string;
map: string | undefined;
dependencies: string[];
};

function getResultForResolve(result: Result): ResolveResult {
return {
code: result.css.toString(),
map: result.map ? result.map.toString() : undefined,
dependencies: result.stats.includedFiles,
};
}

const transformer: Transformer<Options.Sass> = async ({
content,
filename,
Expand All @@ -19,12 +36,15 @@ const transformer: Transformer<Options.Sass> = async ({
({ default: sass } = await importAny('node-sass', 'sass'));
}

options = {
sourceMap: true,
...options,
includePaths: getIncludePaths(filename, options.includePaths),
outFile: filename + '.css',
};
let renderSync: boolean;
(
{renderSync, ...options} = {
sourceMap: true,
...options,
includePaths: getIncludePaths(filename, options.includePaths),
outFile: filename + '.css',
}
);

options.data = options.data ? options.data + content : content;

Expand All @@ -34,14 +54,21 @@ const transformer: Transformer<Options.Sass> = async ({
}

return new Promise<Processed>((resolve, reject) => {
if (renderSync){
try {
const result = sass.renderSync(options);

return resolve(getResultForResolve(result));
}
catch (err){
return reject(err as SassException);
}
}

sass.render(options, (err, result) => {
if (err) return reject(err);

resolve({
code: result.css.toString(),
map: result.map ? result.map.toString() : undefined,
dependencies: result.stats.includedFiles,
});
resolve(getResultForResolve(result));
});
});
};
Expand Down
2 changes: 1 addition & 1 deletion src/types/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export interface Babel extends BabelOptions {
}

export type Pug = PugOptions;
export type Sass = Omit<SassOptions, 'file'>;
export type Sass = Omit<SassOptions, 'file'> & { renderSync?: boolean };
// from /~https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/less/index.d.ts#L80
export interface Less {
paths?: string[];
Expand Down
29 changes: 27 additions & 2 deletions test/transformers/scss.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import getAutoPreprocess from '../../src';
import { preprocess } from '../utils';

describe('transformer - scss', () => {
it('should prepend scss content via `data` option property', async () => {
it('should prepend scss content via `data` option property - via defaul async render', async () => {
const template = `<style lang="scss"></style>`;
const opts = getAutoPreprocess({
scss: {
Expand All @@ -15,12 +15,37 @@ describe('transformer - scss', () => {
expect(preprocessed.toString()).toContain('red');
});

it('should return @imported files as dependencies', async () => {
it('should return @imported files as dependencies - via default async render', async () => {
const template = `<style lang="scss">@import "fixtures/style.scss";</style>`;
const opts = getAutoPreprocess();
const preprocessed = await preprocess(template, opts);
expect(preprocessed.dependencies).toContain(
resolve(__dirname, '..', 'fixtures', 'style.scss').replace(/[\\/]/g, '/'),
);
});

it('should prepend scss content via `data` option property - via renderSync', async () => {
const template = `<style lang="scss"></style>`;
const opts = getAutoPreprocess({
scss: {
data: '$color:blue;div{color:$color}',
renderSync: true,
},
});
const preprocessed = await preprocess(template, opts);
expect(preprocessed.toString()).toContain('blue');
});

it('should return @imported files as dependencies - via renderSync', async () => {
const template = `<style lang="scss">@import "fixtures/style.scss";</style>`;
const opts = getAutoPreprocess({
scss: {
renderSync: true,
},
});
const preprocessed = await preprocess(template, opts);
expect(preprocessed.dependencies).toContain(
resolve(__dirname, '..', 'fixtures', 'style.scss').replace(/[\\/]/g, '/'),
);
});
});