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

feat: allow customize mainFields and extensions #710

Merged
merged 1 commit into from Aug 8, 2019
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/loader.js
Expand Up @@ -40,8 +40,8 @@ function sassLoader(content) {
// Supported since v4.27.0
if (this.getResolve) {
resolve = this.getResolve({
mainFields: ['sass', 'main'],
extensions: ['.scss', '.sass', '.css'],
mainFields: ['sass', 'style', '...'],
extensions: ['.scss', '.sass', '.css', '...'],
});
}

Expand Down
30 changes: 27 additions & 3 deletions test/index.test.js
Expand Up @@ -61,7 +61,7 @@ implementations.forEach((implementation) => {
.replace(CR, '');
}

function runWebpack(baseConfig, loaderOptions, done) {
function runWebpack(baseConfig, loaderOptions, resolveOptions = {}, done) {
const webpackConfig = merge(
{
mode: 'development',
Expand All @@ -74,6 +74,7 @@ implementations.forEach((implementation) => {
rules: [
{
test: /\.s[ac]ss$/,
resolve: resolveOptions,
use: [
{ loader: 'raw-loader' },
{
Expand All @@ -100,7 +101,7 @@ implementations.forEach((implementation) => {

describe(implementationName, () => {
syntaxStyles.forEach((ext) => {
function execTest(testId, loaderOptions, webpackOptions) {
function execTest(testId, loaderOptions, webpackOptions, resolveOptions) {
const bundleName = `bundle.${ext}.${implementationName}.js`;

return new Promise((resolve, reject) => {
Expand All @@ -114,7 +115,7 @@ implementations.forEach((implementation) => {
webpackOptions
);

runWebpack(baseConfig, loaderOptions, (err) =>
runWebpack(baseConfig, loaderOptions, resolveOptions, (err) =>
err ? reject(err) : resolve()
);
}).then(() => {
Expand Down Expand Up @@ -173,6 +174,17 @@ implementations.forEach((implementation) => {
));
it('should resolve sass field correctly', () =>
execTest(`import-sass-field`));
it('should resolve style field correctly', () =>
execTest(`import-style-field`));
it('should resolve main field correctly', () =>
execTest(`import-main-field`));
it('should resolve custom-sass field correctly', () =>
execTest(
`import-custom-sass-field`,
{},
{},
{ mainFields: ['custom-sass', '...'] }
));
// Works only in dart-sass implementation
if (implementation === dartSass) {
it('should resolve index file in module correctly', () =>
Expand Down Expand Up @@ -280,6 +292,7 @@ implementations.forEach((implementation) => {
},
},
{},
{},
(err) => (err ? reject(err) : resolve())
);
}).then(() => {
Expand Down Expand Up @@ -392,6 +405,7 @@ implementations.forEach((implementation) => {
entry: pathToErrorFile,
},
{},
{},
(err) => {
if (implementation === nodeSass) {
err.message.should.match(
Expand All @@ -413,6 +427,7 @@ implementations.forEach((implementation) => {
entry: pathToErrorImport,
},
{},
{},
(err) => {
// check for file excerpt
if (implementation === nodeSass) {
Expand All @@ -435,6 +450,7 @@ implementations.forEach((implementation) => {
entry: pathToErrorFileNotFound,
},
{},
{},
(err) => {
err.message.should.match(/@import "does-not-exist";/);
if (implementation === nodeSass) {
Expand All @@ -457,6 +473,7 @@ implementations.forEach((implementation) => {
entry: pathToErrorFileNotFound2,
},
{},
{},
(err) => {
err.message.should.match(/@import "\.\/another\/_module\.scss";/);
if (implementation === nodeSass) {
Expand Down Expand Up @@ -500,6 +517,7 @@ implementations.forEach((implementation) => {
entry: `${pathToSassLoader}!${pathToErrorFile}`,
},
{ implementation: null },
{},
(err) => {
// eslint-disable-next-line no-underscore-dangle
module._resolveFilename = originalResolve;
Expand All @@ -518,6 +536,7 @@ implementations.forEach((implementation) => {
{
implementation: merge(nodeSass, { info: 'asdfj' }),
},
{},
(err) => {
err.message.should.match(/Unknown Sass implementation "asdfj"\./);
done();
Expand All @@ -533,6 +552,7 @@ implementations.forEach((implementation) => {
{
implementation: merge(nodeSass, { info: 'node-sass\t1' }),
},
{},
(err) => {
err.message.should.match(/Invalid Sass version "1"\./);
done();
Expand All @@ -548,6 +568,7 @@ implementations.forEach((implementation) => {
{
implementation: merge(nodeSass, { info: 'node-sass\t3.0.0' }),
},
{},
(err) => {
err.message.should.match(
/Node Sass version 3\.0\.0 is incompatible with \^4\.0\.0\./
Expand All @@ -565,6 +586,7 @@ implementations.forEach((implementation) => {
{
implementation: merge(nodeSass, { info: 'dart-sass\t1.2.0' }),
},
{},
(err) => {
err.message.should.match(
/Dart Sass version 1\.2\.0 is incompatible with \^1\.3\.0\./
Expand All @@ -582,6 +604,7 @@ implementations.forEach((implementation) => {
{
implementation: merge(nodeSass, { info: 'strange-sass\t1.0.0' }),
},
{},
(err) => {
err.message.should.match(
/Unknown Sass implementation "strange-sass"\./
Expand Down Expand Up @@ -629,6 +652,7 @@ implementations.forEach((implementation) => {
entry: pathToFile,
},
{ implementation: null },
{},
(err) => {
// eslint-disable-next-line no-underscore-dangle
module._resolveFilename = originalResolve;
Expand Down
2 changes: 2 additions & 0 deletions test/node_modules/sass-custom-sass-field/nested/style.sass

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions test/node_modules/sass-custom-sass-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions test/node_modules/sass-main-field/nested/style.sass

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions test/node_modules/sass-main-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions test/node_modules/sass-style-field/nested/style.sass

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions test/node_modules/sass-style-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions test/node_modules/scss-custom-sass-field/nested/style.scss

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions test/node_modules/scss-custom-sass-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions test/node_modules/scss-main-field/nested/style.scss

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions test/node_modules/scss-main-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions test/node_modules/scss-style-field/nested/style.scss

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions test/node_modules/scss-style-field/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions test/sass/import-custom-sass-field.sass
@@ -0,0 +1 @@
@import "~sass-custom-sass-field"
1 change: 1 addition & 0 deletions test/sass/import-main-field.sass
@@ -0,0 +1 @@
@import "~sass-main-field"
1 change: 1 addition & 0 deletions test/sass/import-style-field.sass
@@ -0,0 +1 @@
@import "~sass-style-field"
1 change: 1 addition & 0 deletions test/scss/import-custom-sass-field.scss
@@ -0,0 +1 @@
@import "~scss-custom-sass-field";
1 change: 1 addition & 0 deletions test/scss/import-main-field.scss
@@ -0,0 +1 @@
@import "~scss-main-field";
1 change: 1 addition & 0 deletions test/scss/import-style-field.scss
@@ -0,0 +1 @@
@import "~scss-style-field";
66 changes: 66 additions & 0 deletions test/tools/createSpec.js
Expand Up @@ -48,6 +48,36 @@ function createSpec(ext) {
'style.scss'
)
);
const pathToScssStyleField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'scss-style-field',
'nested',
'style.scss'
)
);
const pathToScssCustomSassField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'scss-custom-sass-field',
'nested',
'style.scss'
)
);
const pathToScssMainField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'scss-main-field',
'nested',
'style.scss'
)
);
const pathToSASSSassField = path.relative(
basePath,
path.resolve(
Expand All @@ -58,6 +88,36 @@ function createSpec(ext) {
'style.sass'
)
);
const pathToSASSStyleField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'sass-style-field',
'nested',
'style.sass'
)
);
const pathToSASSCustomSassField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'sass-custom-sass-field',
'nested',
'style.sass'
)
);
const pathToSASSMainField = path.relative(
basePath,
path.resolve(
testFolder,
'node_modules',
'sass-main-field',
'nested',
'style.sass'
)
);

fs.readdirSync(path.join(testFolder, ext))
.filter(
Expand All @@ -78,7 +138,13 @@ function createSpec(ext) {
// eslint-disable-next-line no-param-reassign
url = url
.replace(/^~scss-sass-field/, pathToScssSassField)
.replace(/^~scss-style-field/, pathToScssStyleField)
.replace(/^~scss-custom-sass-field/, pathToScssCustomSassField)
.replace(/^~scss-main-field/, pathToScssMainField)
.replace(/^~sass-sass-field/, pathToSASSSassField)
.replace(/^~sass-style-field/, pathToSASSStyleField)
.replace(/^~sass-custom-sass-field/, pathToSASSCustomSassField)
.replace(/^~sass-main-field/, pathToSASSMainField)
.replace(/^~bootstrap-sass/, pathToBootstrap)
.replace(/^~@org\/pkg/, pathToScopedNpmPkg)
.replace(/^~module/, pathToModule)
Expand Down