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.

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

Jump to bottom

Resolve loaders directly from Encore instead of using their names #739

Merged
merged 1 commit into from
May 6, 2020
Merged

Resolve loaders directly from Encore instead of using their names #739

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions lib/config-generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ class ConfigGenerator {

rules.push(applyRuleConfigurationCallback('images', {
test: /\.(png|jpg|jpeg|gif|ico|svg|webp)$/,
loader: loaderName,
loader: require.resolve(loaderName),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nit-pick, but I'm asking in case it's important. loaderName here may be file-loader or url-loader. file-loader is required by Encore, but url-loader is something that the user must have installed. What affect does require.resolve() have on a package that we know the user must have installed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's already what we do to check if those kind of packages are installed:

webpack-encore/lib/package-helper.js

Lines 61 to 68 in 134f47a

function isPackageInstalled(packageConfig) {
try {
require.resolve(packageConfig.name);
return true;
} catch (e) {
return false;
}
}

options: loaderOptions
}));
}
Expand Down Expand Up @@ -330,7 +330,7 @@ class ConfigGenerator {

rules.push(applyRuleConfigurationCallback('fonts', {
test: /\.(woff|woff2|ttf|eot|otf)$/,
loader: loaderName,
loader: require.resolve(loaderName),
options: loaderOptions
}));
}
Expand Down Expand Up @@ -394,7 +394,7 @@ class ConfigGenerator {
if (this.webpackConfig.useEslintLoader) {
rules.push(applyRuleConfigurationCallback('eslint', {
test: eslintLoaderUtil.getTest(this.webpackConfig),
loader: 'eslint-loader',
loader: require.resolve('eslint-loader'),
exclude: /node_modules/,
enforce: 'pre',
options: eslintLoaderUtil.getOptions(this.webpackConfig)
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/babel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ module.exports = {

return [
{
loader: 'babel-loader',
loader: require.resolve('babel-loader'),
options: babelConfig
}
];
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/css-extract.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module.exports = {
// If the CSS extraction is disabled, use the
// style-loader instead.
return [{
loader: 'style-loader',
loader: require.resolve('style-loader'),
options: applyOptionsCallback(webpackConfig.styleLoaderConfigurationCallback, options)

}, ...loaders];
Expand Down
4 changes: 2 additions & 2 deletions lib/loaders/css.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ module.exports = {

const cssLoaders = [
{
loader: 'css-loader',
loader: require.resolve('css-loader'),
options: applyOptionsCallback(webpackConfig.cssLoaderConfigurationCallback, options)
},
];
Expand All @@ -54,7 +54,7 @@ module.exports = {
};

cssLoaders.push({
loader: 'postcss-loader',
loader: require.resolve('postcss-loader'),
options: applyOptionsCallback(webpackConfig.postCssLoaderOptionsCallback, postCssLoaderOptions)
});
}
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/handlebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module.exports = {

return [
{
loader: 'handlebars-loader',
loader: require.resolve('handlebars-loader'),
options: applyOptionsCallback(webpackConfig.handlebarsConfigurationCallback, options)
}
];
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/less.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module.exports = {
return [
...cssLoader.getLoaders(webpackConfig, useCssModules),
{
loader: 'less-loader',
loader: require.resolve('less-loader'),
options: applyOptionsCallback(webpackConfig.lessLoaderOptionsCallback, config)
},
];
Expand Down
4 changes: 2 additions & 2 deletions lib/loaders/sass.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module.exports = {
// without this, all url() paths must be relative to the
// entry file, not the file that contains the url()
sassLoaders.push({
loader: 'resolve-url-loader',
loader: require.resolve('resolve-url-loader'),
options: Object.assign(
{
sourceMap: webpackConfig.useSourceMaps
Expand All @@ -47,7 +47,7 @@ module.exports = {
});

sassLoaders.push({
loader: 'sass-loader',
loader: require.resolve('sass-loader'),
options: applyOptionsCallback(webpackConfig.sassLoaderOptionsCallback, config)
});

Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/stylus.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module.exports = {
return [
...cssLoader.getLoaders(webpackConfig, useCssModules),
{
loader: 'stylus-loader',
loader: require.resolve('stylus-loader'),
options: applyOptionsCallback(webpackConfig.stylusLoaderOptionsCallback, config)
},
];
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/typescript.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ module.exports = {
let loaders = babelLoader.getLoaders(webpackConfig);
return loaders.concat([
{
loader: 'ts-loader',
loader: require.resolve('ts-loader'),
// @see https://github.com/TypeStrong/ts-loader/blob/master/README.md#available-options
options: config
}
Expand Down
2 changes: 1 addition & 1 deletion lib/loaders/vue.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module.exports = {

return [
{
loader: 'vue-loader',
loader: require.resolve('vue-loader'),
options: applyOptionsCallback(webpackConfig.vueLoaderOptionsCallback, options)
}
];
Expand Down
20 changes: 10 additions & 10 deletions test/config-generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,10 +861,10 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const imagesRule = findRule(/\.(png|jpg|jpeg|gif|ico|svg|webp)$/, actualConfig.module.rules);
expect(imagesRule.loader).to.equal('file-loader');
expect(imagesRule.loader).to.contain('file-loader');

const fontsRule = findRule(/\.(woff|woff2|ttf|eot|otf)$/, actualConfig.module.rules);
expect(fontsRule.loader).to.equal('file-loader');
expect(fontsRule.loader).to.contain('file-loader');
});

it('with configureUrlLoader() and missing keys', () => {
Expand All @@ -877,10 +877,10 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const imagesRule = findRule(/\.(png|jpg|jpeg|gif|ico|svg|webp)$/, actualConfig.module.rules);
expect(imagesRule.loader).to.equal('file-loader');
expect(imagesRule.loader).to.contain('file-loader');

const fontsRule = findRule(/\.(woff|woff2|ttf|eot|otf)$/, actualConfig.module.rules);
expect(fontsRule.loader).to.equal('file-loader');
expect(fontsRule.loader).to.contain('file-loader');
});

it('with configureUrlLoader()', () => {
Expand All @@ -900,12 +900,12 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const imagesRule = findRule(/\.(png|jpg|jpeg|gif|ico|svg|webp)$/, actualConfig.module.rules);
expect(imagesRule.loader).to.equal('url-loader');
expect(imagesRule.loader).to.contain('url-loader');
expect(imagesRule.options.name).to.equal('[name].foo.[ext]');
expect(imagesRule.options.limit).to.equal(8192);

const fontsRule = findRule(/\.(woff|woff2|ttf|eot|otf)$/, actualConfig.module.rules);
expect(fontsRule.loader).to.equal('url-loader');
expect(fontsRule.loader).to.contain('url-loader');
expect(fontsRule.options.limit).to.equal(4096);
expect(fontsRule.options.name).to.equal('[name].bar.[ext]');
});
Expand Down Expand Up @@ -951,7 +951,7 @@ describe('The config-generator function', () => {
const jsRule = findRule(/\.(jsx?)$/, actualConfig.module.rules);
expect(String(jsRule.exclude)).to.equal(String(/(node_modules|bower_components)/));

const babelLoader = jsRule.use.find(loader => loader.loader === 'babel-loader');
const babelLoader = jsRule.use.find(loader => /babel-loader/.test(loader.loader));
const babelEnvPreset = babelLoader.options.presets.find(([name]) => name === '@babel/preset-env');
expect(babelEnvPreset[1].useBuiltIns).to.equal(false);
});
Expand Down Expand Up @@ -1001,7 +1001,7 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const jsRule = findRule(/\.(jsx?)$/, actualConfig.module.rules);
const babelLoader = jsRule.use.find(loader => loader.loader === 'babel-loader');
const babelLoader = jsRule.use.find(loader => /babel-loader/.test(loader.loader));
const babelEnvPreset = babelLoader.options.presets.find(([name]) => name === '@babel/preset-env');
expect(babelEnvPreset[1].useBuiltIns).to.equal('usage');
expect(babelEnvPreset[1].corejs).to.equal(3);
Expand All @@ -1018,7 +1018,7 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const jsRule = findRule(/\.(jsx?)$/, actualConfig.module.rules);
const babelLoader = jsRule.use.find(loader => loader.loader === 'babel-loader');
const babelLoader = jsRule.use.find(loader => /babel-loader/.test(loader.loader));
const babelEnvPreset = babelLoader.options.presets.find(([name]) => name === '@babel/preset-env');
expect(babelEnvPreset[1].useBuiltIns).to.equal(false);
});
Expand All @@ -1035,7 +1035,7 @@ describe('The config-generator function', () => {
const actualConfig = configGenerator(config);

const jsRule = findRule(/\.(jsx?)$/, actualConfig.module.rules);
const babelLoader = jsRule.use.find(loader => loader.loader === 'babel-loader');
const babelLoader = jsRule.use.find(loader => /babel-loader/.test(loader.loader));
const babelEnvPreset = babelLoader.options.presets.find(([name]) => name === '@babel/preset-env');
expect(babelEnvPreset[1].useBuiltIns).to.equal('usage');
});
Expand Down
16 changes: 8 additions & 8 deletions test/loaders/sass.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ describe('loaders/sass', () => {

const actualLoaders = sassLoader.getLoaders(config);
expect(actualLoaders).to.have.lengthOf(2);
expect(actualLoaders[0].loader).to.equal('resolve-url-loader');
expect(actualLoaders[0].loader).to.contain('resolve-url-loader');
expect(actualLoaders[0].options.sourceMap).to.be.true;

expect(actualLoaders[1].loader).to.equal('sass-loader');
expect(actualLoaders[1].loader).to.contain('sass-loader');
expect(actualLoaders[1].options.sourceMap).to.be.true;
expect(cssLoaderStub.getCall(0).args[1]).to.be.false;

Expand All @@ -55,10 +55,10 @@ describe('loaders/sass', () => {

const actualLoaders = sassLoader.getLoaders(config);
expect(actualLoaders).to.have.lengthOf(2);
expect(actualLoaders[0].loader).to.equal('resolve-url-loader');
expect(actualLoaders[0].loader).to.contain('resolve-url-loader');
expect(actualLoaders[0].options.sourceMap).to.be.false;

expect(actualLoaders[1].loader).to.equal('sass-loader');
expect(actualLoaders[1].loader).to.contain('sass-loader');
// sourcemaps always enabled when resolve-url-loader is enabled
expect(actualLoaders[1].options.sourceMap).to.be.true;

Expand All @@ -79,7 +79,7 @@ describe('loaders/sass', () => {

const actualLoaders = sassLoader.getLoaders(config);
expect(actualLoaders).to.have.lengthOf(2);
expect(actualLoaders[0].loader).to.equal('resolve-url-loader');
expect(actualLoaders[0].loader).to.contain('resolve-url-loader');
expect(actualLoaders[0].options.removeCR).to.be.true;

cssLoader.getLoaders.restore();
Expand All @@ -98,7 +98,7 @@ describe('loaders/sass', () => {

const actualLoaders = sassLoader.getLoaders(config);
expect(actualLoaders).to.have.lengthOf(1);
expect(actualLoaders[0].loader).to.equal('sass-loader');
expect(actualLoaders[0].loader).to.contain('sass-loader');
expect(actualLoaders[0].options.sourceMap).to.be.false;

cssLoader.getLoaders.restore();
Expand Down Expand Up @@ -158,10 +158,10 @@ describe('loaders/sass', () => {

const actualLoaders = sassLoader.getLoaders(config, true);
expect(actualLoaders).to.have.lengthOf(2);
expect(actualLoaders[0].loader).to.equal('resolve-url-loader');
expect(actualLoaders[0].loader).to.contain('resolve-url-loader');
expect(actualLoaders[0].options.sourceMap).to.be.true;

expect(actualLoaders[1].loader).to.equal('sass-loader');
expect(actualLoaders[1].loader).to.contain('sass-loader');
expect(actualLoaders[1].options.sourceMap).to.be.true;
expect(cssLoaderStub.getCall(0).args[1]).to.be.true;

Expand Down