Skip to content

feat: Add manifest functionality #48

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: Add manifest functionality #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff974c7
feat: adding manifest functionality
nickbrogna Feb 19, 2019
466127e
refactor: fix linting issues in spec file
nickbrogna Feb 19, 2019
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: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,11 @@ Set to `true` to ignore every module not actually required in your bundle.

##### `crossOrigin`:`string` (optional)

Allows you to specify a custom `crossorigin` attribute of either `"anonymous"` or `"use-credentials"`, to configure the CORS requests for the element's fetched data. Visit [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes) for more information.
Allows you to specify a custom `crossorigin` attribute of either `"anonymous"` or `"use-credentials"`, to configure the CORS requests for the element's fetched data. Visit [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes) for more information. This setting is ignored when writing to a manifest (`manifest: true`).

##### `manifest`:`boolean` | `false`

Instead of writing asset paths to an HTML template via `HtmlWebpackPlugin`, a `cdn-manifes.json` file will be created that contains the paths to your assets.

### Contribution

Expand Down
64 changes: 43 additions & 21 deletions module.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ class WebpackCdnPlugin {
publicPath,
optimize = false,
crossOrigin = false,
manifest = false,
}) {
this.modules = Array.isArray(modules) ? { [DEFAULT_MODULE_KEY]: modules } : modules;
this.prod = prod !== false;
this.prefix = publicPath;
this.url = this.prod ? prodUrl : devUrl;
this.optimize = optimize;
this.crossOrigin = crossOrigin;
this.manifest = manifest;
}

apply(compiler) {
Expand All @@ -41,28 +43,48 @@ class WebpackCdnPlugin {
const getArgs = [this.url, this.prefix, this.prod, output.publicPath];

compiler.hooks.compilation.tap('WebpackCdnPlugin', (compilation) => {
compilation.hooks.htmlWebpackPluginBeforeHtmlGeneration.tapAsync(
'WebpackCdnPlugin',
(data, callback) => {
const moduleId = data.plugin.options.cdnModule;
if (moduleId !== false) {
let modules = this.modules[moduleId || Reflect.ownKeys(this.modules)[0]];
if (modules) {
if (this.optimize) {
const usedModules = WebpackCdnPlugin._getUsedModules(compilation);
modules = modules.filter(p => usedModules[p.name]);
if (this.manifest) {
compiler.hooks.compilation.tap('done', () => {
const assets = {};
const modules = this.modules[Reflect.ownKeys(this.modules)[0]];
WebpackCdnPlugin._cleanModules(modules);
assets.js = WebpackCdnPlugin._getJs(modules, ...getArgs);
assets.css = WebpackCdnPlugin._getCss(modules, ...getArgs);
compilation.assets['cdn-manifest.json'] = {
source() {
return JSON.stringify(assets);
},
size() {
return assets.length;
},
};
});
} else {
compilation.hooks.htmlWebpackPluginBeforeHtmlGeneration.tapAsync(
'WebpackCdnPlugin',
(data, callback) => {
const moduleId = data.plugin.options.cdnModule;
if (moduleId !== false) {
let modules = this.modules[moduleId || Reflect.ownKeys(this.modules)[0]];
if (modules) {
if (this.optimize) {
const usedModules = WebpackCdnPlugin._getUsedModules(compilation);
modules = modules.filter(p => usedModules[p.name]);
}

WebpackCdnPlugin._cleanModules(modules);
data.assets.js = WebpackCdnPlugin._getJs(modules, ...getArgs).concat(
data.assets.js,
);
data.assets.css = WebpackCdnPlugin._getCss(modules, ...getArgs).concat(
data.assets.css,
);
}

WebpackCdnPlugin._cleanModules(modules);
data.assets.js = WebpackCdnPlugin._getJs(modules, ...getArgs).concat(data.assets.js);
data.assets.css = WebpackCdnPlugin._getCss(modules, ...getArgs).concat(
data.assets.css,
);
}
}
callback(null, data);
},
);
callback(null, data);
},
);
}
});
const externals = compiler.options.externals || {};

Expand All @@ -77,7 +99,7 @@ class WebpackCdnPlugin {

compiler.options.externals = externals;

if (this.prod && this.crossOrigin) {
if (this.prod && this.crossOrigin && !this.manifest) {
compiler.hooks.afterPlugins.tap('WebpackCdnPlugin', () => {
compiler.hooks.thisCompilation.tap('WebpackCdnPlugin', () => {
compiler.hooks.compilation.tap('HtmlWebpackPluginHooks', (compilation) => {
Expand Down
63 changes: 61 additions & 2 deletions spec/webpack.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ let cssCrossOrigin;
let jsCrossOrigin;
let cssCrossOrigin2;
let jsCrossOrigin2;
let manifestFile;

const versions = {
jasmine: WebpackCdnPlugin.getVersion('jasmine'),
Expand All @@ -34,6 +35,7 @@ function runWebpack(callback, config) {
jsCrossOrigin = [];
cssCrossOrigin2 = [];
jsCrossOrigin2 = [];
manifestFile = null;

const compiler = webpack(config);
compiler.outputFileSystem = fs;
Expand All @@ -60,7 +62,7 @@ function runWebpack(callback, config) {
jsAssets2.push(matches[1]);
jsCrossOrigin2.push(/crossorigin="anonymous"/.test(matches[2]));
}

manifestFile = stats.compilation.assets['cdn-manifest.json'] && JSON.parse(stats.compilation.assets['cdn-manifest.json'].source());
callback();
});
}
Expand All @@ -76,6 +78,7 @@ function getConfig({
multipleFiles,
optimize,
crossOrigin,
manifest,
}) {
const output = {
path: path.join(__dirname, 'dist/assets'),
Expand Down Expand Up @@ -141,6 +144,7 @@ function getConfig({
prodUrl,
optimize,
crossOrigin,
manifest,
};

if (publicPath) {
Expand Down Expand Up @@ -339,6 +343,34 @@ describe('Webpack Integration', () => {
expect(jsCrossOrigin).toEqual([false, true, true, true, false]);
});
});

describe('With `manifest`', () => {
beforeAll((done) => {
runWebpack(
done,
getConfig({
prod: true, manifest: true,
}),
);
});

it('should output the manifest json', () => {
expect(manifestFile).toEqual(jasmine.any(Object));
});

it('should output the manifest with right assets (js)', () => {
expect(manifestFile.js).toEqual(['/assets/local.js',
'https://unpkg.com/jasmine-spec-reporter@4.2.1/index.js',
'https://unpkg.com/nyc@13.3.0/index.js',
'https://unpkg.com/jasmine2@3.3.1/lib/jasmine.js']);
});

it('should output the manifest with right assets (css)', () => {
expect(manifestFile.css).toEqual(['/assets/local.css',
'https://unpkg.com/nyc@13.3.0/style.css',
'https://unpkg.com/jasmine2@3.3.1/style.css']);
});
});
});

describe('When `prod` is false', () => {
Expand Down Expand Up @@ -410,7 +442,7 @@ describe('Webpack Integration', () => {
beforeAll((done) => {
runWebpack(done, getConfig({
prod: false,
moduleDevUrl: ":name/dist/:path",
moduleDevUrl: ':name/dist/:path',
}));
});

Expand Down Expand Up @@ -517,5 +549,32 @@ describe('Webpack Integration', () => {
expect(jsAssets).toEqual(['/jasmine/lib/jasmine.js', '/app.js']);
});
});


describe('With `manifest`', () => {
beforeAll((done) => {
runWebpack(
done,
getConfig({
prod: false, publicPath: null, publicPath2: null, optimize: false, manifest: true,
}),
);
});

it('should output the manifest json', () => {
expect(manifestFile).toEqual(jasmine.any(Object));
});

it('should output the manifest with right assets (js)', () => {
expect(manifestFile.js).toEqual(['/local.js',
'/jasmine-spec-reporter/index.js',
'/nyc/index.js',
'/jasmine/lib/jasmine.js']);
});

it('should output the manifest with right assets (css)', () => {
expect(manifestFile.css).toEqual(['/local.css', '/nyc/style.css', '/jasmine/style.css']);
});
});
});
});