refactor: 'from' option (#450)

BREAKING CHANGE: the 'from' option now can only be a string, if you use `{ from: { glob: 'directory/**', dot: false } }` changed it to `{ from: 'directory/**', globOptions: { dot: false } }`

Author: evilebottnawi

src/options.json

@@ -4,15 +4,8 @@
  "type": "object",
  "properties": {
  "from": {
- "anyOf": [
- {
- "type": "string",
- "minLength": 1
- },
- {
- "type": "object"
- }
- ]
+ "type": "string",
+ "minLength": 1
  },
  "to": {
  "type": "string"

src/preProcessPattern.js

@@ -5,7 +5,6 @@ import globParent from 'glob-parent';
 
 import normalize from './utils/normalize';
 import isTemplateLike from './utils/isTemplateLike';
-import isObject from './utils/isObject';
 import { stat } from './utils/promisify';
 
 /* eslint-disable no-param-reassign */
@@ -32,8 +31,7 @@ export default function preProcessPattern(globalRef, pattern) {
  pattern.context = path.join(context, pattern.context);
  }
 
- const isFromGlobPatten =
- (isObject(pattern.from) && pattern.from.glob) || pattern.globOptions;
+ const isFromGlobPatten = pattern.globOptions;
  // Todo remove this in next major
  const isToDirectory =
  path.extname(pattern.to) === '' || pattern.to.slice(-1) === path.sep;
@@ -67,21 +65,9 @@ export default function preProcessPattern(globalRef, pattern) {
 
  pattern.fromType = 'glob';
 
- const globOptions = Object.assign(
- {},
- pattern.globOptions ? pattern.globOptions : pattern.from
- );
- delete globOptions.glob;
-
- pattern.absoluteFrom = path.resolve(
- pattern.context,
- pattern.globOptions ? pattern.from : pattern.from.glob
- );
- pattern.glob = normalize(
- pattern.context,
- pattern.globOptions ? pattern.from : pattern.from.glob
- );
- pattern.globOptions = globOptions;
+ pattern.absoluteFrom = path.resolve(pattern.context, pattern.from);
+ pattern.glob = normalize(pattern.context, pattern.from);
+ pattern.globOptions = pattern.globOptions || {};
 
  return Promise.resolve(pattern);
  }

test/CopyPlugin.test.js

@@ -240,9 +240,7 @@ describe('apply function', () => {
  expectedAssetKeys: ['directory/nested/nestedfile.txt'],
  patterns: [
  {
- from: {
- glob: 'directory\\nested\\*',
- },
+ from: 'directory\\nested\\*',
  },
  ],
  })
@@ -255,9 +253,7 @@ describe('apply function', () => {
  expectedAssetKeys: ['directory/nested/nestedfile.txt'],
  patterns: [
  {
- from: {
- glob: 'directory/nested\\*',
- },
+ from: 'directory/nested\\*',
  },
  ],
  })
@@ -370,9 +366,7 @@ describe('apply function', () => {
  run({
  patterns: [
  {
- from: {
- glob: 'directory/directoryfile.txt',
- },
+ from: 'directory/directoryfile.txt',
  },
  ],
  })

test/__snapshots__/validate-options.test.js.snap

@@ -109,23 +109,20 @@ exports[`validate options should throw an error on the "patterns" option with "[
  - options.patterns[0].to should be a string."
 `;
 
+exports[`validate options should throw an error on the "patterns" option with "[{"from":{"glob":"**/*","dot":false},"to":"dir","context":"context"}]" value 1`] = `
+"Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
+ - options.patterns[0].from should be a non-empty string."
+`;
+
 exports[`validate options should throw an error on the "patterns" option with "[{"from":true,"to":"dir","context":"context"}]" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
- - options.patterns[0] should be one of these:
- non-empty string | object { from, to?, context?, toType?, test?, force?, ignore?, flatten?, cache?, transform?, transformPath?, … }
- Details:
- * options.patterns[0].from should be one of these:
- non-empty string | object { … }
- Details:
- * options.patterns[0].from should be a non-empty string.
- * options.patterns[0].from should be an object:
- object { … }"
+ - options.patterns[0].from should be a non-empty string."
 `;
 
 exports[`validate options should throw an error on the "patterns" option with "[{}]" value 1`] = `
 "Invalid options object. Copy Plugin has been initialized using an options object that does not match the API schema.
  - options.patterns[0] misses the property 'from'. Should be:
- non-empty string | object { … }"
+ non-empty string"
 `;
 
 exports[`validate options should throw an error on the "patterns" option with "{}" value 1`] = `

test/from-option.test.js

@@ -470,85 +470,4 @@ describe('from option', () => {
  .catch(done);
  });
  });
-
- describe('is a object with glob and glob options', () => {
- it('should move files', (done) => {
- runEmit({
- expectedAssetKeys: ['file.txt'],
- patterns: [
- {
- from: {
- glob: '*.txt',
- },
- },
- ],
- })
- .then(done)
- .catch(done);
- });
-
- it('should move files exclude dot files', (done) => {
- runEmit({
- expectedAssetKeys: ['file.txt'],
- patterns: [
- {
- from: {
- glob: '*.txt',
- dot: false,
- },
- },
- ],
- })
- .then(done)
- .catch(done);
- });
-
- it('should move files with dot files', (done) => {
- runEmit({
- expectedAssetKeys: ['file.txt', '.file.txt'],
- patterns: [
- {
- from: {
- glob: '*.txt',
- dot: true,
- },
- },
- ],
- })
- .then(done)
- .catch(done);
- });
-
- it('should move files with the "globOptions" option', (done) => {
- runEmit({
- expectedAssetKeys: ['.file.txt', 'file.txt'],
- patterns: [
- {
- from: '*.txt',
- globOptions: {
- dot: true,
- },
- },
- ],
- })
- .then(done)
- .catch(done);
- });
-
- it('should move files with the "globOptions" option #2', (done) => {
- runEmit({
- expectedAssetKeys: ['file.txt'],
- patterns: [
- {
- from: '*.txt',
- globOptions: {
- dot: false,
- },
- },
- ],
- })
- .then(done)
- .catch(done);
- });
- });
 });

test/validate-options.test.js

@@ -70,19 +70,6 @@ describe('validate options', () => {
  transformPath: () => {},
  },
  ],
- [
- {
- from: {
- glob: '**/*',
- dot: false,
- },
- to: 'dir',
- context: 'context',
- globOptions: {
- dot: false,
- },
- },
- ],
  [
  {
  from: 'test.txt',
@@ -235,6 +222,16 @@ describe('validate options', () => {
  transformPath: true,
  },
  ],
+ [
+ {
+ from: {
+ glob: '**/*',
+ dot: false,
+ },
+ to: 'dir',
+ context: 'context',
+ },
+ ],
  ],
  },
  };