Skip to content

Commit 5654fa4

Browse files
bhollowaybholloway
committedJun 9, 2021
remove the engine option and related tests, use getOptions from loader where available
·
5.0.05.0.0-beta.1
1 parent 10f9cdb commit 5654fa4

File tree

7 files changed

+77
-251
lines changed

7 files changed

+77
-251
lines changed
 

‎packages/resolve-url-loader/index.js

+26-39
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@
44
*/
55
'use strict';
66

7-
var os = require('os'),
8-
path = require('path'),
9-
fs = require('fs'),
10-
util = require('util'),
11-
loaderUtils = require('loader-utils'),
12-
SourceMapConsumer = require('source-map').SourceMapConsumer;
7+
const os = require('os');
8+
const path = require('path');
9+
const fs = require('fs');
10+
const util = require('util');
11+
const loaderUtils = require('loader-utils');
12+
const SourceMapConsumer = require('source-map').SourceMapConsumer;
1313

14-
var adjustSourceMap = require('adjust-sourcemap-loader/lib/process');
14+
const adjustSourceMap = require('adjust-sourcemap-loader/lib/process');
1515

16-
var valueProcessor = require('./lib/value-processor'),
17-
joinFn = require('./lib/join-function'),
18-
logToTestHarness = require('./lib/log-to-test-harness');
16+
const valueProcessor = require('./lib/value-processor');
17+
const joinFn = require('./lib/join-function');
18+
const logToTestHarness = require('./lib/log-to-test-harness');
1919

2020
const DEPRECATED_OPTIONS = {
2121
engine: [
2222
'DEP_RESOLVE_URL_LOADER_OPTION_ENGINE',
23-
'the "engine" option is deprecated, "postcss" engine is the default, there are no other available engines'
23+
'the "engine" option has been removed, "postcss" is the only available parser'
2424
],
2525
keepQuery: [
2626
'DEP_RESOLVE_URL_LOADER_OPTION_KEEP_QUERY',
@@ -55,7 +55,7 @@ function resolveUrlLoader(content, sourceMap) {
5555
/* jshint validthis:true */
5656

5757
// details of the file being processed
58-
var loader = this;
58+
const loader = this;
5959

6060
// a relative loader.context is a problem
6161
if (/^\./.test(loader.context)) {
@@ -66,24 +66,20 @@ function resolveUrlLoader(content, sourceMap) {
6666
}
6767

6868
// infer webpack version from new loader features
69-
var isWebpackGte5 = 'getOptions' in loader && typeof loader.getOptions === 'function';
69+
const isWebpackGte5 = 'getOptions' in loader && typeof loader.getOptions === 'function';
7070

71-
// webpack 1: prefer loader query, else options object
72-
// webpack 2: prefer loader options
73-
// webpack 3: deprecate loader.options object
74-
// webpack 4: loader.options no longer defined
75-
var rawOptions = loaderUtils.getOptions(loader),
76-
options = Object.assign(
71+
// use loader.getOptions where available otherwise use loaderUtils
72+
const rawOptions = isWebpackGte5 ? loader.getOptions() : loaderUtils.getOptions(loader);
73+
const options = Object.assign(
7774
{
7875
sourceMap: loader.sourceMap,
79-
engine : 'postcss',
8076
silent : false,
8177
removeCR : os.EOL.includes('\r'),
8278
root : false,
8379
debug : false,
8480
join : joinFn.defaultJoin
8581
},
86-
rawOptions
82+
rawOptions,
8783
);
8884

8985
// maybe log options for the test harness
@@ -95,7 +91,7 @@ function resolveUrlLoader(content, sourceMap) {
9591
}
9692

9793
// deprecated options
98-
var deprecatedItems = Object.entries(DEPRECATED_OPTIONS).filter(([key]) => key in rawOptions);
94+
const deprecatedItems = Object.entries(DEPRECATED_OPTIONS).filter(([key]) => key in rawOptions);
9995
if (deprecatedItems.length) {
10096
deprecatedItems.forEach(([, value]) => handleAsDeprecated(...value));
10197
}
@@ -114,7 +110,7 @@ function resolveUrlLoader(content, sourceMap) {
114110
}
115111

116112
// validate the result of calling the join option
117-
var joinProper = options.join(options, loader);
113+
const joinProper = options.join(options, loader);
118114
if (typeof joinProper !== 'function') {
119115
return handleAsError(
120116
'loader misconfiguration',
@@ -129,7 +125,7 @@ function resolveUrlLoader(content, sourceMap) {
129125

130126
// validate root option
131127
if (typeof options.root === 'string') {
132-
var isValid = (options.root === '') ||
128+
const isValid = (options.root === '') ||
133129
(path.isAbsolute(options.root) && fs.existsSync(options.root) && fs.statSync(options.root).isDirectory());
134130

135131
if (!isValid) {
@@ -149,7 +145,8 @@ function resolveUrlLoader(content, sourceMap) {
149145
loader.cacheable();
150146

151147
// incoming source-map
152-
var sourceMapConsumer, absSourceMap;
148+
let absSourceMap = null;
149+
let sourceMapConsumer = null;
153150
if (sourceMap) {
154151

155152
// support non-standard string encoded source-map (per less-loader)
@@ -186,20 +183,10 @@ function resolveUrlLoader(content, sourceMap) {
186183
);
187184
}
188185

189-
// choose a CSS engine
190-
var enginePath = /^[\w-]+$/.test(options.engine) && path.join(__dirname, 'lib', 'engine', options.engine + '.js');
191-
var isValidEngine = fs.existsSync(enginePath);
192-
if (!isValidEngine) {
193-
return handleAsError(
194-
'loader misconfiguration',
195-
'"engine" option is not valid'
196-
);
197-
}
198-
199186
// allow engine to throw at initialisation
200-
var engine;
187+
let engine = null;
201188
try {
202-
engine = require(enginePath);
189+
engine = require('./lib/engine/postcss');
203190
} catch (error) {
204191
return handleAsError(
205192
'error initialising',
@@ -208,7 +195,7 @@ function resolveUrlLoader(content, sourceMap) {
208195
}
209196

210197
// process async
211-
var callback = loader.async();
198+
const callback = loader.async();
212199
Promise
213200
.resolve(engine(loader.resourcePath, content, {
214201
outputSourceMap : !!options.sourceMap,
@@ -234,7 +221,7 @@ function resolveUrlLoader(content, sourceMap) {
234221
// webpack4 and earlier: source-map sources are relative to the file being processed
235222
// webpack5: source-map sources are relative to the project root but without a leading slash
236223
if (options.sourceMap) {
237-
var finalMap = adjustSourceMap(loader, {
224+
const finalMap = adjustSourceMap(loader, {
238225
format: isWebpackGte5 ? 'projectRelative' : 'sourceRelative'
239226
}, result.map);
240227
callback(null, result.content, finalMap);

‎packages/resolve-url-loader/lib/engine/fail-initialisation.js

-7
This file was deleted.

‎packages/resolve-url-loader/lib/engine/fail-processing.js

-18
This file was deleted.

‎test/cases/common/test/invalid.js

-104
Original file line numberDiff line numberDiff line change
@@ -6,71 +6,6 @@ const {test, layer, env} = require('test-my-cli');
66
const {assertStderr} = require('../../../lib/assert');
77
const {escapeStr} = require('../../../lib/util');
88

9-
exports.testKeepQuery = (...rest) =>
10-
test(
11-
'keepQuery=true',
12-
layer()(
13-
env({
14-
LOADER_OPTIONS: {keepQuery: true},
15-
OUTPUT: 'keepQuery'
16-
}),
17-
...rest,
18-
test('validate', assertStderr('options.keepQuery')(1)`keepQuery: true`)
19-
)
20-
);
21-
22-
exports.testAbsolute = (...rest) =>
23-
test(
24-
'absolute=true',
25-
layer()(
26-
env({
27-
LOADER_OPTIONS: {absolute: true},
28-
OUTPUT: 'absolute'
29-
}),
30-
...rest,
31-
test('validate', assertStderr('options.absolute')(1)`absolute: true`)
32-
)
33-
);
34-
35-
exports.testAttempts = (...rest) =>
36-
test(
37-
'attempts=N',
38-
layer()(
39-
env({
40-
LOADER_OPTIONS: {attempts: 1},
41-
OUTPUT: 'attempts'
42-
}),
43-
...rest,
44-
test('validate', assertStderr('options.attempts')(1)`attempts: 1`)
45-
)
46-
);
47-
48-
exports.testIncludeRoot = (...rest) =>
49-
test(
50-
'includeRoot=true',
51-
layer()(
52-
env({
53-
LOADER_OPTIONS: {includeRoot: true},
54-
OUTPUT: 'includeRoot'
55-
}),
56-
...rest
57-
),
58-
test('validate', assertStderr('options.includeRoot')(1)`includeRoot: true`)
59-
);
60-
61-
exports.testFail = (...rest) =>
62-
test(
63-
'fail=true',
64-
layer()(
65-
env({
66-
LOADER_OPTIONS: {fail: true},
67-
OUTPUT: 'fail'
68-
}),
69-
...rest,
70-
test('validate', assertStderr('options.fail')(1)`fail: true`)
71-
)
72-
);
73-
749
exports.testNonFunctionJoin1 = (...rest) =>
7510
test(
7611
'join1=!function',
@@ -148,42 +83,3 @@ exports.testNonExistentRoot = (...rest) =>
14883
test('validate', assertStderr('options.root')(1)`root: "${escapeStr(process.cwd())}[^"]+foo"`)
14984
)
15085
);
151-
152-
exports.testSilent = (...rest) =>
153-
test(
154-
'silent=true',
155-
layer()(
156-
env({
157-
LOADER_OPTIONS: {silent: true},
158-
OUTPUT: 'silent'
159-
}),
160-
...rest,
161-
test('validate', assertStderr('options.silent')(1)`silent: true`)
162-
)
163-
);
164-
165-
exports.testEngineFailInitialisation = (...rest) =>
166-
test(
167-
'engine=fail-initialisation',
168-
layer()(
169-
env({
170-
LOADER_OPTIONS: {engine: 'fail-initialisation'},
171-
OUTPUT: 'engine-fail-initialisation'
172-
}),
173-
...rest,
174-
test('validate', assertStderr('options.engine')(1)`engine: "fail-initialisation"`)
175-
)
176-
);
177-
178-
exports.testEngineFailProcessing = (...rest) =>
179-
test(
180-
'engine=fail-processing',
181-
layer()(
182-
env({
183-
LOADER_OPTIONS: {engine: 'fail-processing'},
184-
OUTPUT: 'engine-fail-processing'
185-
}),
186-
...rest,
187-
test('validate', assertStderr('options.engine')(1)`engine: "fail-processing"`)
188-
)
189-
);

‎test/cases/common/test/valid.js

+31-20
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,23 @@
11
'use strict';
22

33
const sequence = require('promise-compose');
4-
const {test, layer, meta, env} = require('test-my-cli');
4+
const {test, layer, env} = require('test-my-cli');
55

66
const {assertStderr} = require('../../../lib/assert');
77
const {escapeStr} = require('../../../lib/util');
88

9-
exports.testBase = (engine) => (...elements) =>
10-
test(
11-
`engine=${engine}`,
12-
layer(engine)(
13-
meta({
14-
engine
15-
}),
16-
env({
17-
DEVTOOL: true,
18-
LOADER_OPTIONS: (engine === 'postcss') ? {sourceMap: true} : {sourceMap: true, engine},
19-
LOADER_JOIN: '',
20-
CSS_OPTIONS: {sourceMap: true}
21-
}),
22-
...elements,
23-
test('validate', sequence(
24-
assertStderr('options.sourceMap')(1)`sourceMap: true`,
25-
assertStderr('options.engine')(1)`engine: "${engine}"`
26-
))
27-
)
9+
exports.testBase = (...elements) =>
10+
layer()(
11+
env({
12+
DEVTOOL: true,
13+
LOADER_OPTIONS: {sourceMap: true},
14+
LOADER_JOIN: '',
15+
CSS_OPTIONS: {sourceMap: true}
16+
}),
17+
...elements,
18+
test('validate', sequence(
19+
assertStderr('options.sourceMap')(1)`sourceMap: true`,
20+
))
2821
);
2922

3023
exports.testWithLabel = (label) => (...elements) =>
@@ -38,7 +31,25 @@ exports.testWithLabel = (label) => (...elements) =>
3831
)
3932
);
4033

34+
exports.testWithOption = (option) => {
35+
const [key] = Object.keys(option);
36+
const value = option[key];
37+
return (...rest) =>
38+
test(
39+
`${key}=${JSON.stringify(value)}`,
40+
layer()(
41+
env({
42+
LOADER_OPTIONS: {[key]: value},
43+
OUTPUT: key
44+
}),
45+
...rest,
46+
test('validate', assertStderr(`options.${key}`)(1)`${key}: ${JSON.stringify(value)}`)
47+
)
48+
);
49+
};
50+
4151
exports.testDefault = exports.testWithLabel('default');
52+
exports.testSilent = exports.testWithOption({ silent: true });
4253

4354
exports.testDebug = (...elements) =>
4455
test(

‎test/cases/misconfiguration.js

+6-42
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22

33
const {join} = require('path');
44
const outdent = require('outdent');
5-
const sequence = require('promise-compose');
65
const compose = require('compose-function');
76
const {test, layer, fs, env, cwd} = require('test-my-cli');
87

98
const {trim} = require('../lib/util');
109
const {rebaseToCache} = require('../lib/higher-order');
1110
const {
12-
all, testDefault, testSilent, testKeepQuery, testAbsolute, testAttempts, testEngineFailInitialisation,
13-
testEngineFailProcessing, testIncludeRoot, testFail, testNonFunctionJoin1, testWrongArityJoin1, testNonFunctionJoin2,
11+
all, testWithOption, testDefault, testSilent, testNonFunctionJoin1, testWrongArityJoin1, testNonFunctionJoin2,
1412
testWrongArityJoin2, testNonStringRoot, testNonExistentRoot
1513
} = require('./common/test');
1614
const {buildDevNormal, buildProdNormal} = require('./common/exec');
@@ -38,24 +36,6 @@ const assertMisconfigError = (message) => assertStdout('error')([1, 4])`
3836
[ ]+${message}
3937
`;
4038

41-
// Allow 1-4 errors
42-
// - known-issue in extract-text-plugin, failed loaders will rerun webpack>=2
43-
// - webpack may repeat errors with a header line taken from the parent loader
44-
const assertInitialisationError = assertStdout('error')([1, 4])`
45-
^[ ]*ERROR[^\n]*
46-
([^\n]+\n){0,2}[^\n]*resolve-url-loader:[ ]*error initialising
47-
[ ]+This "engine" is designed to fail at require time, for testing purposes only
48-
`;
49-
50-
// Allow 1-4 errors
51-
// - known-issue in extract-text-plugin, failed loaders will rerun webpack>=2
52-
// - webpack may repeat errors with a header line taken from the parent loader
53-
const assertProcessingError = assertStdout('error')([1, 4])`
54-
^[ ]*ERROR[^\n]*
55-
([^\n]+\n){0,2}[^\n]*resolve-url-loader:[ ]*error processing CSS
56-
[ ]+This "engine" is designed to fail at processing time, for testing purposes only
57-
`;
58-
5939
module.exports = test(
6040
'misconfiguration',
6141
layer('misconfiguration')(
@@ -73,23 +53,7 @@ module.exports = test(
7353
env({
7454
ENTRY: join('src', 'index.scss')
7555
}),
76-
testEngineFailInitialisation(
77-
all(testDefault, testSilent)(
78-
all(buildDevNormal, buildProdNormal)(
79-
assertWebpackNotOk,
80-
assertInitialisationError
81-
)
82-
)
83-
),
84-
testEngineFailProcessing(
85-
all(testDefault, testSilent)(
86-
all(buildDevNormal, buildProdNormal)(
87-
assertWebpackNotOk,
88-
assertProcessingError
89-
)
90-
)
91-
),
92-
testAttempts(
56+
testWithOption({ attempts: 1 })(
9357
testDefault(
9458
buildDevNormal(
9559
assertWebpackOk,
@@ -119,7 +83,7 @@ module.exports = test(
11983
)
12084
)
12185
),
122-
testKeepQuery(
86+
testWithOption({ keepQuery: true })(
12387
testDefault(
12488
buildDevNormal(
12589
assertWebpackOk,
@@ -149,7 +113,7 @@ module.exports = test(
149113
)
150114
)
151115
),
152-
testAbsolute(
116+
testWithOption({ absolute: true })(
153117
testDefault(
154118
buildDevNormal(
155119
assertWebpackOk,
@@ -179,7 +143,7 @@ module.exports = test(
179143
)
180144
)
181145
),
182-
testIncludeRoot(
146+
testWithOption({ includeRoot: true })(
183147
testDefault(
184148
buildDevNormal(
185149
assertWebpackOk,
@@ -209,7 +173,7 @@ module.exports = test(
209173
)
210174
)
211175
),
212-
testFail(
176+
testWithOption({ fail: true })(
213177
testDefault(
214178
buildDevNormal(
215179
assertWebpackOk,

‎test/index.js

+14-21
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ const {testBase} = require('./cases/common/test');
1717
const PLATFORMS_DIR = compose(normalize, join)(__dirname, '..', 'packages', 'resolve-url-loader', 'test');
1818
const CASES_DIR = join(__dirname, 'cases');
1919

20-
const testCaseVsEngine = ([_, engineName, caseName]) => {
21-
const split = caseName.split('.');
22-
return (split.length === 1) || (split[1] === engineName);
23-
};
24-
2520
const testIncluded = process.env.ONLY ?
2621
(arr) => {
2722
const patterns = process.env.ONLY.split(' ').map(v => v.trim());
@@ -45,13 +40,13 @@ const getVersionHash = platform =>
4540
const epoch = Math.round(Date.now() / 1000).toString().padStart(10, 0);
4641
console.log(`timestamp: ${epoch}`);
4742

48-
// platforms, engines, cases
43+
// platforms, cases
4944
const tests = permute(
5045
readdirSync(PLATFORMS_DIR),
51-
['postcss'],
52-
readdirSync(CASES_DIR).filter((v) => v.endsWith('.js')).map((v) => v.split('.').slice(0, -1).join('.'))
46+
readdirSync(CASES_DIR)
47+
.filter((v) => v.endsWith('.js'))
48+
.map((v) => v.split('.').slice(0, -1).join('.'))
5349
)
54-
.filter(testCaseVsEngine)
5550
.filter(testIncluded);
5651

5752
const filterTests = (...terms) =>
@@ -128,18 +123,16 @@ filterTests()
128123
debug: (process.env.DEBUG === 'exec')
129124
}
130125
}),
131-
...filterTests(platform).map(engine =>
132-
testBase(engine)(
133-
env({
134-
PATH: dirname(process.execPath),
135-
RESOLVE_URL_LOADER_TEST_HARNESS: 'stderr'
136-
}),
137-
meta({
138-
cacheDir: join(process.cwd(), 'tmp', '.cache', platform),
139-
version: getVersionHash(platform)
140-
}),
141-
...filterTests(platform, engine).map(caseName => require(join(CASES_DIR, caseName)))
142-
)
126+
testBase(
127+
env({
128+
PATH: dirname(process.execPath),
129+
RESOLVE_URL_LOADER_TEST_HARNESS: 'stderr'
130+
}),
131+
meta({
132+
cacheDir: join(process.cwd(), 'tmp', '.cache', platform),
133+
version: getVersionHash(platform)
134+
}),
135+
...filterTests(platform).map(caseName => require(join(CASES_DIR, caseName)))
143136
)
144137
)
145138
);

0 commit comments

Comments
 (0)
Please sign in to comment.