{"id":15810081,"url":"https://github.com/lukesheard/wp-configurator","last_synced_at":"2025-04-01T00:41:33.687Z","repository":{"id":57399517,"uuid":"78656056","full_name":"LukeSheard/wp-configurator","owner":"LukeSheard","description":null,"archived":false,"fork":false,"pushed_at":"2017-02-27T09:37:19.000Z","size":125,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-06T03:42:48.113Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LukeSheard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-11T16:13:40.000Z","updated_at":"2017-01-11T16:21:48.000Z","dependencies_parsed_at":"2022-09-16T16:12:18.717Z","dependency_job_id":null,"html_url":"https://github.com/LukeSheard/wp-configurator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeSheard%2Fwp-configurator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeSheard%2Fwp-configurator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeSheard%2Fwp-configurator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeSheard%2Fwp-configurator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukeSheard","download_url":"https://codeload.github.com/LukeSheard/wp-configurator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246563384,"owners_count":20797446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-05T03:42:56.733Z","updated_at":"2025-04-01T00:41:33.662Z","avatar_url":"https://github.com/LukeSheard.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Webpack Configurator\n\n## Install\n\n```\n$ npm install wp-configurator\n```\n\n## API\n\n* [Top-Level Exports](#top-level-exports)\n  * [loader](#loaderconfig)\n  * [loaders](#loadersconfigs)\n  * [plugin](#pluginconfig)\n  * [plugins](#pluginsconfigs)\n  * [merge](#mergeobject-source-customizer)\n  * [resolveAll](#resolveallwrappers)\n  * [helpers](#helpers)\n* [Loader](#loader)\n  * [merge](#loadermergeproperty-changes-customizer)\n  * [set](#loadersetproperty-changes)\n  * [get](#loaderget)\n  * [resolve](#loaderresolve)\n* [Plugin](#plugin)\n  * [merge](#pluginmergeindex-changes)\n  * [set](#pluginsetindex-changes)\n  * [get](#pluginget)\n  * [resolve](#pluginresolve)\n* [Helpers](#helpers-1)\n  * [concatMerge](#concatmerge)\n\n### Top-Level Exports\n\nBelow is a list of properties that are accessible at the top level of the module. Simply require the module into your script:\n\n```javascript\n// Note: I use Pascal case when referencing external modules.\nvar Config = require(\"webpack-configurator\");\n```\n\n#### loader(config)\n\nComplex configurations often modify the properties of loaders. This utility helps aid composabilty by providing a number of methods that cater to common use cases. The example below shows how to construct a loader:\n\n```javascript\n// The contents of 'babel' is a loader object wrapper.\nvar babel = Config.loader({\n    test: /\\.jsx?/,\n    loader: \"babel\",\n    query: {\n        presets: [\"es2015\"]\n    }\n});\n```\n\n#### loaders(configs)\n\nIt's common to find configurations with multiple loaders. This utility provides a way to define several loaders at once, returning an array of loader object wrappers. Below is an example of its usage:\n\n```javascript\nvar loaders = Config.loaders([\n    {\n        test: /\\.jsx?/,\n        loader: \"babel\",\n        query: {\n            presets: [\"es2015\"]\n        }\n    },\n    {\n        test: /\\.scss$/,\n        loaders: [\"style\", \"css\", \"sass\"]\n    }\n]);\n```\n\n#### plugin(config)\n\nIt's sometimes difficult to customise plugins because of the way they differ from loaders. This utility makes it easier by splitting out the parameters. The plugin isn't created until the `resolve` method is called. Below is an example of its usage:\n\n```javascript\nvar Webpack = require(\"webpack\");\n\nvar webpackDefine = Config.plugin({\n    plugin: Webpack.DefinePlugin,\n    parameters: [{\n        VERSION: JSON.stringify(\"1.0.1\"),\n    }]\n});\n```\n\n#### plugins(configs)\n\nYou may wish to define several plugins at once. This utility accepts an array of plugin configurations and returns an array of plugin object wrappers. Below is an example of its usage:\n\n```javascript\nvar Webpack = require(\"webpack\");\n\nvar plugins = Config.plugins([\n    {\n        plugin: Webpack.DefinePlugin,\n        parameters: [{\n            VERSION: JSON.stringify(\"1.0.1\")\n        }]\n    },\n    {\n        plugin: Webpack.UglifyJsPlugin,\n        parameters: [{\n            compress: {\n                warnings: false\n            }\n        }]\n    }\n]);\n```\n\n#### merge(object, source, [customizer])\n\nA generalised merge utility. It works in a similar way to loader.merge and plugin.merge, only this function has no validation on properties.\n\n```javascript\nvar base = {\n    entry: \"./base.entry.js\",\n    output: {\n        filename: \"bundle.js\"\n    }\n};\n\nmodule.exports = Config.merge(base, {\n    devtool: \"source-map\",\n    entry: \"./dev.entry.js\",\n});\n```\n\n#### resolveAll(wrappers)\n\nUseful when a configuration has several loaders or plugins. Each loader and plugin has a `resolve` method. This utility will call said method and return an array of resolved values.\n\n```javascript\nvar loaders = Config.loaders([\n    {\n        test: /\\.jsx?$/,\n        loader: \"babel\"\n    },\n    {\n        test: /\\.scss$/,\n        loaders: [\"style\", \"css\", \"sass\"]\n    }\n]);\n\nmodule.exports = {\n    entry: \"./base.entry.js\",\n    output: {\n        filename: \"bundle.js\"\n    },\n    module: {\n        loaders: Config.resolveAll(loaders)\n    }\n};\n```\n\n#### helpers\n\nThis object contains miscellaneous functions that help resolve common problems when creating Webpack configurations. Right now, there is only one helper available 'concatMerge'. However, this number will likely increase in the future.\n\n### Loader\n\n\u003c!---\nNote: all methods are chainable.\n--\u003e\n\n#### loader.merge([property], changes, [customizer])\n\n\u003c!---\nhttp://webpack.github.io/docs/configuration.html#module-loaders\nDefault valid properties:\n- test [Regex]\n- exclude [Regex]\n- include [Regex]\n- loader [String]\n- loaders [Array -\u003e String]\n\nAdditional valid properties:\n- query [Object]\n- queries [Object -\u003e Object]\n\nProperty constraints:\n- loader -\u003e query\n- loaders -\u003e queries\n--\u003e\n\nBasic example:\n```javascript\nbabel.merge({\n    query: {\n        presets: [\"es2015\", \"react\"]\n    }\n});\n```\n\nProperty specific example:\n```javascript\nbabel.merge(\"query\", {\n    presets: [\"es2015\", \"react\"]\n});\n```\n\nFunction example:\n```javascript\nbabel.merge(\"query\", function(config) {\n    var presets = config.query.presets;\n\n    return {\n        presets: presets.concat([\"react\"])\n    };\n});\n```\n\nResolve merge example:\n```javascript\nbabel.merge(\"loaders\", function(config, loader) {\n    var resolved = loader.resolve();\n\n    return ExtractTextPlugin.extract(resolved.loaders);\n});\n```\n\nDefine merge behaviour example:\n```javascript\nbabel.merge(\"query\", {\n    presets: [\"react\"]\n}, Config.helpers.concatMerge);\n```\n\n#### loader.set([property], changes)\n\n\u003c!---\nhttp://webpack.github.io/docs/configuration.html#module-loaders\nDefault valid properties:\n- test [Regex]\n- exclude [Regex]\n- include [Regex]\n- loader [String]\n- loaders [Array -\u003e String]\n\nAdditional valid properties:\n- query [Object]\n- queries [Object -\u003e Object]\n\nProperty constraints:\n- loader -\u003e query\n- loaders -\u003e queries\n--\u003e\n\nBasic example:\n```javascript\nbabel.set({\n    query: {\n        presets: [\"es2015\", \"react\"]\n    }\n});\n```\n\nProperty specific example:\n```javascript\nbabel.set(\"query\", {\n    presets: [\"es2015\", \"react\"]\n});\n```\n\nResolve set example:\n```javascript\nvar Config = require(\"webpack-configurator\");\nvar ExtractTextPlugin = require(\"extract-text-webpack-plugin\");\n\nvar sass = Config.loader({\n    test: /\\.scss$/,\n    loaders: [\"style\", \"css\", \"sass\"],\n    queries: {\n        css: {sourceMap: true},\n        sass: {sourceMap: true}\n    }\n});\n\nsass.set(\"loaders\", function(config, loader) {\n    var resolved = loader.resolve();\n\n    return ExtractTextPlugin.extract(resolved.loaders);\n});\n```\n\n#### loader.resolve()\n\n\u003c!---\nhttp://webpack.github.io/docs/configuration.html#module-loaders\nCan only return the following properties (note: either 'loader' and 'loaders'):\n- test [Regex]\n- exclude [Regex]\n- include [Regex]\n- loader [String]\n- loaders [Array -\u003e String]\n\nMinimum requirements for a loader:\n- test [Regex]\n- loader [String] | loaders [Array -\u003e String]\n--\u003e\n\n### Plugin\n\n\u003c!---\nNote: all methods are chainable.\n--\u003e\n\n#### plugin.merge([index], changes)\n\nBasic example:\n```javascript\nwebpackDefine.merge([{\n    TWO: \"1+1\"\n}]);\n```\n\nProperty specific example:\n```javascript\nwebpackDefine.merge(0, {\n    TWO: \"1+1\"\n});\n```\n\nAnother property specific example:\n```javascript\nwebpackDefine.merge({\n    0: {TWO: \"1+1\"}\n});\n```\n\n#### plugin.set([index], changes)\n\nBasic example:\n```javascript\nwebpackDefine.set([{\n    TWO: \"1+1\"\n}]);\n```\n\nProperty specific example:\n```javascript\nwebpackDefine.set(0, {\n    TWO: \"1+1\"\n});\n```\n\nAnother property specific example:\n```javascript\nwebpackDefine.set({\n    0: {TWO: \"1+1\"}\n});\n```\n\n#### plugin.resolve()\n\n\u003c!---\nEssentially does: return new Plugin(...parameters);\n--\u003e\n\n### Helpers\n\n#### concatMerge\n\nBy default, merges will overwrite arrays. This helper provides a simple implementation that overrides said behaviour.\n\nBasic example:\n\n```javascript\nvar Config = require(\"webpack-configurator\");\n\nvar helpers = Config.helpers;\nvar sass = Config.loader({\n    test: /\\.scss$/,\n    loaders: [\"style\", \"css\"]\n});\n\nsass.merge({\n    loaders: [\"sass\"]\n}, helpers.concatMerge());\n```\n\nPrepend example:\n\n```javascript\nvar Config = require(\"webpack-configurator\");\n\nvar helpers = Config.helpers;\nvar base = {\n    entry: [\n        \"./main.js\"\n    ],\n    output: {\n        filename: \"bundle.js\"\n    }\n};\n\nmodule.exports = Config.merge(base, {\n    entry: [\n        \"webpack-dev-server/client?http://localhost:8080\"\n    ]\n}, helpers.concatMerge(true));\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukesheard%2Fwp-configurator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukesheard%2Fwp-configurator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukesheard%2Fwp-configurator/lists"}