12 |
31 |
32 |
33 | ## Requirements
34 |
35 | `webpack-nano` is an evergreen module. 🌲 This module requires an [Active LTS](https://github.com/nodejs/Release) Node version (v10.0.0+).
36 |
37 | ## Benefits
38 |
39 | - Holy bananas 🍌 it's itsy bitsy
40 | - Doesn't hit you over the head with an avalanche of flags and options
41 | - Allows any number of user-defined flags
42 | - It does one thing: tells webpack to start a build
43 | - ~90% smaller than webpack-cli and webpack-command
44 |
45 | ## Usage
46 |
47 | ```console
48 | $ npx wp --help
49 |
50 | Usage
51 | $ wp [...options]
52 |
53 | Options
54 | --config A path to a webpack config file
55 | --config.{name} A path to a webpack config file, and the config name to run
56 | --json Emit bundle information as JSON
57 | --help Displays this message
58 | --silent Instruct the CLI to produce no console output
59 | --version Displays webpack-nano and webpack versions
60 |
61 | Examples
62 | $ wp
63 | $ wp --help
64 | $ wp --config webpack.config.js
65 | $ wp --config.serve webpack.config.js
66 | ```
67 |
68 | ## Custom Flags
69 |
70 | With `webpack-cli` users are limited as to the flags they can use on with the `$ webpack` binary, and are instructed to use the `--env` flag for custom data. Well that's just 🍌🍌. With `webpack-nano` users can specify an unlimited number of custom flags, _without restriction_.
71 |
72 | Say you have a bundle which can be built to use different asset locations from cloud data sources, like Amazon S3 or Google Cloud Storage. And in this scenario you prefer to specify that location using a command-line flag. If you were using `webpack-cli`, you'd have to use the `--env.source` flag (or you'd get a big 'ol error) and use a function for your `webpack.config.js` export. Using `webpack-nano`:
73 |
74 | ```console
75 | $ wp --config webpack.config.js --source s3
76 | ```
77 |
78 | ```js
79 | // webpack.config.js
80 | const argv = require('webpack-nano/argv');
81 |
82 | const { source } = argv;
83 |
84 | module.exports = {
85 | ...
86 | }
87 | ```
88 |
89 | ✨ Magic. The `webpack-nano/argv` export provides quick and easy access to parsed command-line arguments, allowing the user to define the CLI experience as they want to.
90 |
91 | ## Special Configuration File Types
92 |
93 | Webpack configuration files can be written using a variety of module loaders. e.g. Babel or TypeScript. `webpack-nano` allows users to use file types like `webpack.config.babel.js`, `webpack.config.es6`, `webpack.config.mjs`, and `webpack.config.ts`. Users are responsible for installing a compatible module loader when using these special file types. The table below represents the supported file types and their compatible loaders:
94 |
95 | | Extension | Compatible Loaders |
96 | | ------------| ------------------ |
97 | | `.babel.js` | `@babel/register`, `babel-register`, `babel-core/register`, `babel/register` |
98 | | `.babel.ts` | `@babel/register` |
99 | | `.es6` | `@babel/register` |
100 | | `.mjs` | `@babel/register` |
101 | | `.ts` | `ts-node/register`, `typescript-node/register`, `typescript-register`, `typescript-require` |
102 |
103 | ## Build Stats
104 |
105 | This project attempts not to make assumptions about how a build should behave, and that includes webpack [`stats`](https://webpack.js.org/configuration/stats/). By default, `webpack-nano` will apply two `stats` options: `colors` (based on [`supports-color`](https://github.com/chalk/supports-color) and `exclude: ['node_modules']`). These can be quickly overridden by including these key/values in your stats configuration.
106 |
107 | ## Meta
108 |
109 | [CONTRIBUTING](./.github/CONTRIBUTING.md)
110 |
111 | [LICENSE (Mozilla Public License)](./LICENSE)
112 |
--------------------------------------------------------------------------------
/argv.d.ts:
--------------------------------------------------------------------------------
1 | interface Arguments {
2 | /** Non-option arguments */
3 | _: string[];
4 |
5 | /** The script name or node command */
6 | $0: string;
7 |
8 | /** All remaining options */
9 | [argName: string]: unknown;
10 | }
11 |
12 | declare const argv: Arguments;
13 | export = argv;
14 |
--------------------------------------------------------------------------------
/argv.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright © 2018 Andrew Powell
3 |
4 | This Source Code Form is subject to the terms of the Mozilla Public
5 | License, v. 2.0. If a copy of the MPL was not distributed with this
6 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 |
8 | The above copyright notice and this permission notice shall be
9 | included in all copies or substantial portions of this Source Code Form.
10 | */
11 | const parse = require('yargs-parser');
12 |
13 | const argv = parse(process.argv.slice(2));
14 |
15 | module.exports = argv;
16 |
--------------------------------------------------------------------------------
/assets/nano.ai:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/shellscape/webpack-nano/6b6411046067f5192176cf805f735ca88cc479f1/assets/nano.ai
--------------------------------------------------------------------------------
/assets/nano.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
60 |
--------------------------------------------------------------------------------
/bin/wp.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | /*
4 | Copyright © 2018 Andrew Powell
5 |
6 | This Source Code Form is subject to the terms of the Mozilla Public
7 | License, v. 2.0. If a copy of the MPL was not distributed with this
8 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 |
10 | The above copyright notice and this permission notice shall be
11 | included in all copies or substantial portions of this Source Code Form.
12 | */
13 | const chalk = require('chalk');
14 | const importLocal = require('import-local');
15 | const parse = require('yargs-parser');
16 | const webpack = require('webpack');
17 |
18 | const pkg = require('../package.json');
19 | const { run } = require('../lib/compiler');
20 | const { loadConfig } = require('../lib/config');
21 |
22 | const { error: stderr } = console;
23 | const end = () => process.exit(0);
24 |
25 | const help = chalk`
26 | ${pkg.description}
27 |
28 | {underline Usage}
29 | $ wp [...options]
30 |
31 | {underline Options}
32 | --config A path to a webpack config file
33 | --config.\{name\} A path to a webpack config file, and the config name to run
34 | --json Emit bundle information as JSON
35 | --help Displays this message
36 | --silent Instruct the CLI to produce no console output
37 | --version Displays webpack-nano and webpack versions
38 |
39 | {underline Examples}
40 | $ wp
41 | $ wp --help
42 | $ wp --config webpack.config.js
43 | $ wp --config.serve webpack.config.js
44 | `;
45 |
46 | const doeet = async () => {
47 | process.on('SIGINT', end);
48 | process.on('SIGTERM', end);
49 |
50 | const argv = parse(process.argv.slice(2));
51 | const logPrefix = { ok: chalk.blue('⬡ webpack:'), whoops: chalk.red('⬢ webpack:') };
52 | const log = {
53 | error: (...args) => {
54 | if (argv.silent) return;
55 | args.unshift(logPrefix.whoops);
56 | stderr(...args);
57 | },
58 | info: (...args) => {
59 | if (argv.silent) return;
60 | args.unshift(logPrefix.ok);
61 | stderr(...args);
62 | }
63 | };
64 |
65 | if (argv.help) {
66 | stderr(help);
67 | return;
68 | }
69 |
70 | if (argv.version || argv.v) {
71 | stderr(`
72 | webpack-nano v${pkg.version}
73 | webpack v${webpack.version}
74 | `);
75 | return;
76 | }
77 |
78 | const config = await loadConfig(argv);
79 | run(config, log);
80 | };
81 |
82 | process.on('unhandledRejection', (err) => {
83 | stderr(err.stack);
84 | process.exitCode = 1;
85 | });
86 |
87 | // eslint-disable-next-line no-unused-expressions
88 | importLocal(__filename) || doeet();
89 |
--------------------------------------------------------------------------------
/codecov.yml:
--------------------------------------------------------------------------------
1 | codecov:
2 | branch: master
3 | coverage:
4 | precision: 2
5 | round: down
6 | range: 70...100
7 | status:
8 | project: 'no'
9 | patch: 'yes'
10 | comment: 'off'
11 |
--------------------------------------------------------------------------------
/commitlint.config.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | const Configuration = {
3 | extends: ['@commitlint/config-conventional'],
4 |
5 | rules: {
6 | 'body-leading-blank': [1, 'always'],
7 | 'footer-leading-blank': [1, 'always'],
8 | 'header-max-length': [2, 'always', 72],
9 | 'scope-case': [2, 'always', 'lower-case'],
10 | 'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
11 | 'subject-empty': [2, 'never'],
12 | 'subject-full-stop': [2, 'never', '.'],
13 | 'type-case': [2, 'always', 'lower-case'],
14 | 'type-empty': [2, 'never'],
15 | 'type-enum': [2, 'always', [
16 | 'build',
17 | 'chore',
18 | 'ci',
19 | 'docs',
20 | 'feat',
21 | 'fix',
22 | 'perf',
23 | 'refactor',
24 | 'revert',
25 | 'style',
26 | 'test',
27 | ],
28 | ],
29 | },
30 | };
31 |
32 | module.exports = Configuration;
--------------------------------------------------------------------------------
/lib/compiler.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright © 2018 Andrew Powell
3 |
4 | This Source Code Form is subject to the terms of the Mozilla Public
5 | License, v. 2.0. If a copy of the MPL was not distributed with this
6 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 |
8 | The above copyright notice and this permission notice shall be
9 | included in all copies or substantial portions of this Source Code Form.
10 | */
11 | const chalk = require('chalk');
12 | const webpack = require('webpack');
13 |
14 | const isWebpack5 = () => webpack.version.split('.')[0] === '5';
15 |
16 | const run = ({ config, emitJson, watchConfig }, log) => {
17 | // Delete possible watch flag from webpack configuration as that triggers a
18 | // faulty condition in webpack 5. #20
19 | if (isWebpack5()) {
20 | // eslint-disable-next-line no-param-reassign
21 | delete config.watch;
22 | }
23 |
24 | let lastHash;
25 | const compiler = webpack(config);
26 |
27 | const done = (fatal, stats) => {
28 | const hasErrors = stats && stats.hasErrors();
29 |
30 | process.exitCode = Number(!!fatal || (hasErrors && !watchConfig));
31 |
32 | if (fatal) {
33 | log.error(fatal);
34 | return;
35 | }
36 |
37 | // Skip duplicate hash check in webpack 5. #20
38 | if (!isWebpack5() && lastHash === stats.hash) {
39 | log.info(chalk`{dim ⁿᵃⁿᵒ} Duplicate build detected {dim (${lastHash})}\n`);
40 | return;
41 | }
42 |
43 | lastHash = stats.hash;
44 |
45 | const statsDefaults = { colors: chalk.supportsColor.hasBasic, exclude: ['node_modules'] };
46 | const { options = {} } =
47 | []
48 | .concat(compiler.compilers || compiler)
49 | .reduce((a, c) => c.options.stats && c.options.stats) || {};
50 | const statsOptions =
51 | !options.stats || typeof options.stats === 'object'
52 | ? Object.assign({}, statsDefaults, options.stats)
53 | : options.stats;
54 | const result = stats.toString(statsOptions);
55 |
56 | // indent the result slightly to visually set it apart from other output
57 | log.info(result.split('\n').join('\n '), '\n');
58 |
59 | if (emitJson) {
60 | process.stdout.write(`${JSON.stringify(stats.toJson(), null, 2)}\n`);
61 | }
62 | };
63 |
64 | if (watchConfig) {
65 | log.info('Watching Files');
66 | compiler.watch(watchConfig.watchOptions || {}, done);
67 | } else {
68 | compiler.hooks.done.tap('webpack-nano', () => log.info('Build Finished'));
69 | compiler.run(done);
70 | }
71 | };
72 |
73 | module.exports = { isWebpack5, run };
74 |
--------------------------------------------------------------------------------
/lib/config.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright © 2018 Andrew Powell
3 |
4 | This Source Code Form is subject to the terms of the Mozilla Public
5 | License, v. 2.0. If a copy of the MPL was not distributed with this
6 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 |
8 | The above copyright notice and this permission notice shall be
9 | included in all copies or substantial portions of this Source Code Form.
10 | */
11 | const { existsSync } = require('fs');
12 | const { resolve } = require('path');
13 |
14 | const rechoir = require('rechoir');
15 |
16 | const esmRegister = {
17 | module: 'esm',
18 | register(hook) {
19 | // register on .js extension due to https://github.com/joyent/node/blob/v0.12.0/lib/module.js#L353
20 | // which only captures the final extension (.babel.js -> .js)
21 | const esmLoader = hook(module);
22 | /* eslint-disable */
23 | require.extensions['.js'] = esmLoader('module')._extensions['.js'];
24 | /* eslint-enable */
25 | }
26 | };
27 | const fileTypes = {
28 | '.esm.js': [esmRegister],
29 | '.es6': ['@babel/register', esmRegister],
30 | '.mjs': ['@babel/register', esmRegister],
31 | '.babel.js': ['@babel/register', 'babel-register', 'babel-core/register', 'babel/register'],
32 | '.babel.ts': ['@babel/register'],
33 | '.ts': [
34 | 'ts-node/register',
35 | 'typescript-node/register',
36 | 'typescript-register',
37 | 'typescript-require'
38 | ]
39 | };
40 | const configTypes = {
41 | function: (c, argv) => Promise.resolve(c(argv.env || {}, argv)),
42 | object: (c) => Promise.resolve(c)
43 | };
44 | const cwd = process.cwd();
45 | const defaultConfigPath = resolve(cwd, 'webpack.config.js');
46 |
47 | const requireLoader = (extension) => {
48 | try {
49 | rechoir.prepare(fileTypes, `config${extension}`, cwd);
50 | } catch (e) {
51 | let message;
52 | if (/no module loader/i.test(e.message)) {
53 | const [, fileType] = e.message.match(/(".+").$/);
54 | message = `A loader could not be found for the ${fileType} file type`;
55 | } else {
56 | const modules = e.failures.map(({ moduleName }) => `\n ${moduleName}`);
57 | message = `${e.message.slice(0, -1)}:${modules}`;
58 | }
59 |
60 | const error = new RangeError(message);
61 | error.code = 'ERR_MODULE_LOADER';
62 | throw error;
63 | }
64 | };
65 |
66 | const loadConfig = async (argv) => {
67 | if (!argv.config && existsSync(defaultConfigPath)) {
68 | // eslint-disable-next-line no-param-reassign
69 | argv.config = defaultConfigPath;
70 | }
71 |
72 | // let's not process any config if the user hasn't specified any
73 | if (argv.config) {
74 | const configName = typeof argv.config !== 'string' ? Object.keys(argv.config)[0] : null;
75 | // e.g. --config.batman webpack.config.js
76 | const configPath = argv.config[configName] || argv.config;
77 | const resolvedPath = resolve(configPath);
78 |
79 | // only register a loader if the config file extension matches one we support
80 | const extension = Object.keys(fileTypes).find((t) => resolvedPath.endsWith(t));
81 |
82 | if (extension) {
83 | requireLoader(extension);
84 | }
85 |
86 | let configExport = require(resolvedPath); // eslint-disable-line global-require, import/no-dynamic-require
87 |
88 | if (configExport.default) {
89 | configExport = configExport.default;
90 | }
91 |
92 | if (configName) {
93 | if (!Array.isArray(configExport)) {
94 | throw new TypeError(
95 | `A config with name was specified, but the config ${configPath} does not export an Array.`
96 | );
97 | }
98 |
99 | configExport = configExport.find((c) => c.name === configName);
100 |
101 | if (!configExport) {
102 | throw new RangeError(`A config with name '${configName}' was not found in ${configPath}`);
103 | }
104 | }
105 |
106 | const configType = typeof configExport;
107 | const config = await configTypes[configType](configExport, argv);
108 | const watchConfig = [].concat(config).find((c) => !!c.watch);
109 |
110 | return { config, watchConfig, emitJson: argv.json };
111 | }
112 |
113 | return { config: {} };
114 | };
115 |
116 | module.exports = { loadConfig };
117 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "webpack-nano",
3 | "version": "1.1.1",
4 | "description": "A teensy, squeaky 🐤 clean Webpack CLI",
5 | "license": "MPL-2.0",
6 | "repository": "shellscape/webpack-nano",
7 | "author": "shellscape",
8 | "homepage": "https://github.com/shellscape/webpack-nano",
9 | "bugs": "https://github.com/shellscape/webpack-nano/issues",
10 | "bin": {
11 | "wp": "bin/wp.js"
12 | },
13 | "engines": {
14 | "node": ">= 10.0.0"
15 | },
16 | "scripts": {
17 | "ci:coverage": "nyc npm run ci:test && nyc report --reporter=text-lcov > coverage.lcov",
18 | "ci:lint": "npm run lint && npm run security",
19 | "ci:lint:commits": "commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}",
20 | "ci:test": "npm run test -- --verbose",
21 | "commitlint": "commitlint",
22 | "commitmsg": "commitlint -e $GIT_PARAMS",
23 | "lint": "eslint --fix --cache bin/* lib test argv.js",
24 | "lint-staged": "lint-staged",
25 | "security": "npm audit",
26 | "test": "npm run test:v4 && npm run test:v5 && npm run test:cleanup",
27 | "test:cleanup": "npm install webpack@^4.42.0 --no-save",
28 | "test:v4": "ava",
29 | "test:v5": "npm install webpack@^5.0.0 --no-save && ava"
30 | },
31 | "files": [
32 | "bin/",
33 | "lib/",
34 | "argv.js",
35 | "argv.d.ts",
36 | "README.md",
37 | "LICENSE"
38 | ],
39 | "peerDependencies": {
40 | "webpack": ">=4.46.0"
41 | },
42 | "dependencies": {
43 | "chalk": "^4.1.0",
44 | "import-local": "^3.0.2",
45 | "rechoir": "^0.7.0",
46 | "yargs-parser": "^20.2.1"
47 | },
48 | "devDependencies": {
49 | "@babel/preset-env": "^7.2.0",
50 | "@babel/register": "^7.0.0",
51 | "@commitlint/cli": "^11.0.0",
52 | "@commitlint/config-conventional": "^11.0.0",
53 | "ava": "^3.5.1",
54 | "eslint-config-shellscape": "^2.1.0",
55 | "esm": "^3.2.25",
56 | "execa": "^4.0.0",
57 | "lint-staged": "^10.0.8",
58 | "nyc": "^15.0.0",
59 | "p-defer": "^3.0.0",
60 | "pre-commit": "^1.2.2",
61 | "prettier": "^2.0.1",
62 | "webpack": "^4.46.0"
63 | },
64 | "keywords": [
65 | "cli",
66 | "cmd",
67 | "command",
68 | "light",
69 | "lightweight",
70 | "nano",
71 | "small",
72 | "teensy",
73 | "webpack"
74 | ],
75 | "ava": {
76 | "files": [
77 | "!**/fixtures/**",
78 | "!**/helpers/**"
79 | ]
80 | },
81 | "lint-staged": {
82 | "*.js": [
83 | "eslint --fix"
84 | ]
85 | },
86 | "nyc": {
87 | "include": [
88 | "lib/*.js"
89 | ],
90 | "exclude": [
91 | "lib/client*.js",
92 | "test/"
93 | ]
94 | },
95 | "pre-commit": "lint-staged"
96 | }
97 |
--------------------------------------------------------------------------------
/test/fixtures/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | [
4 | "@babel/preset-env",
5 | {
6 | "targets": {
7 | "esmodules": true
8 | }
9 | }
10 | ]
11 | ]
12 | }
13 |
--------------------------------------------------------------------------------
/test/fixtures/bad.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | nano: 'cli'
3 | };
4 |
--------------------------------------------------------------------------------
/test/fixtures/bail.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = {
4 | bail: true,
5 | entry: resolve(__dirname, 'bail.js'),
6 | mode: 'development'
7 | };
8 |
--------------------------------------------------------------------------------
/test/fixtures/bail.js:
--------------------------------------------------------------------------------
1 | // eslint-disable-next-line
2 | require('batman-module.js');
3 |
--------------------------------------------------------------------------------
/test/fixtures/entry.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | nano: 'cli'
3 | };
4 |
--------------------------------------------------------------------------------
/test/fixtures/fn.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = () => {
4 | return {
5 | context: __dirname,
6 | entry: resolve(__dirname, 'entry.js'),
7 | mode: 'development'
8 | };
9 | };
10 |
--------------------------------------------------------------------------------
/test/fixtures/multi.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = [
4 | {
5 | context: __dirname,
6 | entry: resolve(__dirname, 'entry.js'),
7 | mode: 'development',
8 | name: 'entry',
9 | output: {
10 | filename: 'nahmain.js'
11 | }
12 | },
13 | {
14 | context: __dirname,
15 | entry: resolve(__dirname, 'yrtne.js'),
16 | mode: 'production',
17 | name: 'yrtne'
18 | }
19 | ];
20 |
--------------------------------------------------------------------------------
/test/fixtures/stats.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = {
4 | context: __dirname,
5 | entry: resolve(__dirname, 'entry.js'),
6 | mode: 'development',
7 | stats: 'minimal'
8 | };
9 |
--------------------------------------------------------------------------------
/test/fixtures/watch.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = {
4 | context: __dirname,
5 | entry: resolve(__dirname, 'entry.js'),
6 | mode: 'development',
7 | watch: true
8 | };
9 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config-default.babel.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | const { error: sterr } = console;
4 |
5 | export default {
6 | context: __dirname,
7 | entry: resolve(__dirname, 'entry.js'),
8 | mode: 'development'
9 | };
10 |
11 | sterr('babel-default.js');
12 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config-default.esm.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | const { error: sterr } = console;
4 |
5 | export default {
6 | context: __dirname,
7 | entry: resolve(__dirname, 'entry.js'),
8 | mode: 'development'
9 | };
10 |
11 | sterr('esm-default.js');
12 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config.babel.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | const { error: sterr } = console;
4 |
5 | module.exports = {
6 | context: __dirname,
7 | entry: resolve(__dirname, 'entry.js'),
8 | mode: 'development'
9 | };
10 |
11 | sterr('babel.js');
12 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config.es6:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | const { error: sterr } = console;
4 |
5 | module.exports = {
6 | context: __dirname,
7 | entry: resolve(__dirname, 'entry.js'),
8 | mode: 'development'
9 | };
10 |
11 | sterr('es6');
12 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config.esm.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | const { error: sterr } = console;
4 |
5 | module.exports = {
6 | context: __dirname,
7 | entry: resolve(__dirname, 'entry.js'),
8 | mode: 'development'
9 | };
10 |
11 | sterr('esm.js');
12 |
--------------------------------------------------------------------------------
/test/fixtures/webpack.config.js:
--------------------------------------------------------------------------------
1 | const { resolve } = require('path');
2 |
3 | module.exports = {
4 | context: __dirname,
5 | entry: resolve(__dirname, 'entry.js'),
6 | mode: 'development'
7 | };
8 |
--------------------------------------------------------------------------------
/test/fixtures/yrtne.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | cli: 'nano'
3 | };
4 |
--------------------------------------------------------------------------------
/test/fixtures/zero/src/index.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | nano: 'cli'
3 | };
4 |
--------------------------------------------------------------------------------
/test/snapshots/test.js.md:
--------------------------------------------------------------------------------
1 | # Snapshot report for `test/test.js`
2 |
3 | The actual snapshot is saved in `test.js.snap`.
4 |
5 | Generated by [AVA](https://avajs.dev).
6 |
7 | ## --help
8 |
9 | > Snapshot 1
10 |
11 | `␊
12 | A teensy, squeaky 🐤 clean Webpack CLI␊
13 | ␊
14 | Usage␊
15 | $ wp [...options]␊
16 | ␊
17 | Options␊
18 | --config A path to a webpack config file␊
19 | --config.{name} A path to a webpack config file, and the config name to run␊
20 | --json Emit bundle information as JSON␊
21 | --help Displays this message␊
22 | --silent Instruct the CLI to produce no console output␊
23 | --version Displays webpack-nano and webpack versions␊
24 | ␊
25 | Examples␊
26 | $ wp␊
27 | $ wp --help␊
28 | $ wp --config webpack.config.js␊
29 | $ wp --config.serve webpack.config.js␊
30 | `
31 |
32 | ## argv export
33 |
34 | > Snapshot 1
35 |
36 | {
37 | _: [],
38 | }
39 |
40 | ## json - webpack 5
41 |
42 | > Snapshot 1
43 |
44 | {
45 | assets: [
46 | {
47 | auxiliaryChunkIdHints: [],
48 | auxiliaryChunkNames: [],
49 | auxiliaryChunks: [],
50 | cached: false,
51 | chunkIdHints: [],
52 | chunkNames: [
53 | 'main',
54 | ],
55 | chunks: [
56 | 'main',
57 | ],
58 | comparedForEmit: true,
59 | emitted: false,
60 | info: {
61 | javascriptModule: false,
62 | size: 2152,
63 | },
64 | isOverSizeLimit: false,
65 | name: 'main.js',
66 | related: {},
67 | size: 2152,
68 | type: 'asset',
69 | },
70 | ],
71 | assetsByChunkName: {
72 | main: [
73 | 'main.js',
74 | ],
75 | },
76 | children: [],
77 | entrypoints: {
78 | main: {
79 | assets: [
80 | {
81 | name: 'main.js',
82 | size: 2152,
83 | },
84 | ],
85 | assetsSize: 2152,
86 | auxiliaryAssets: [],
87 | auxiliaryAssetsSize: 0,
88 | childAssets: {},
89 | children: {},
90 | chunks: [
91 | 'main',
92 | ],
93 | filteredAssets: 0,
94 | filteredAuxiliaryAssets: 0,
95 | isOverSizeLimit: false,
96 | name: 'main',
97 | },
98 | },
99 | errors: [],
100 | errorsCount: 0,
101 | namedChunkGroups: {
102 | main: {
103 | assets: [
104 | {
105 | name: 'main.js',
106 | size: 2152,
107 | },
108 | ],
109 | assetsSize: 2152,
110 | auxiliaryAssets: [],
111 | auxiliaryAssetsSize: 0,
112 | childAssets: {},
113 | children: {},
114 | chunks: [
115 | 'main',
116 | ],
117 | filteredAssets: 0,
118 | filteredAuxiliaryAssets: 0,
119 | isOverSizeLimit: false,
120 | name: 'main',
121 | },
122 | },
123 | publicPath: 'auto',
124 | warnings: [],
125 | warningsCount: 0,
126 | }
127 |
--------------------------------------------------------------------------------
/test/snapshots/test.js.snap:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/shellscape/webpack-nano/6b6411046067f5192176cf805f735ca88cc479f1/test/snapshots/test.js.snap
--------------------------------------------------------------------------------
/test/test.js:
--------------------------------------------------------------------------------
1 | const { join, resolve } = require('path');
2 |
3 | const test = require('ava');
4 | const execa = require('execa');
5 | const deferred = require('p-defer');
6 |
7 | const { isWebpack5 } = require('../lib/compiler');
8 |
9 | const bin = resolve(__dirname, '../bin/wp.js');
10 | const cwd = resolve(__dirname, './fixtures');
11 |
12 | const run = (...args) => execa('node', [bin].concat(args), { cwd });
13 |
14 | test('no config', async (t) => {
15 | const { stderr } = await run();
16 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
17 | });
18 |
19 | test('--config', async (t) => {
20 | const { stderr } = await run('--config', 'webpack.config.js');
21 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
22 | });
23 |
24 | test('--config.name', async (t) => {
25 | const { stderr } = await run('--config.yrtne', 'multi.config.js');
26 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
27 | });
28 |
29 | test('esm', async (t) => {
30 | const { stderr } = await run('--config', 'webpack.config.esm.js');
31 | t.truthy(stderr.includes('esm'));
32 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
33 | });
34 |
35 | test('esm default export', async (t) => {
36 | const { stderr } = await run('--config', 'webpack.config-default.esm.js');
37 | t.truthy(stderr.includes('esm-default'));
38 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
39 | });
40 |
41 | test('babel', async (t) => {
42 | const { stderr } = await run('--config', 'webpack.config.babel.js');
43 | t.truthy(stderr.includes('babel'));
44 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
45 | });
46 |
47 | test('babel default export', async (t) => {
48 | const { stderr } = await run('--config', 'webpack.config-default.babel.js');
49 | t.truthy(stderr.includes('babel-default'));
50 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
51 | });
52 |
53 | test('bad', async (t) => {
54 | try {
55 | await run('--config', 'bad.config.js');
56 | } catch (err) {
57 | // Same subset for webpack 4 and 5
58 | t.truthy(err.stderr.includes('ValidationError'));
59 | }
60 | });
61 |
62 | test('bad --config.name', async (t) => {
63 | try {
64 | await run('--config.ye', 'multi.config.js');
65 | } catch (err) {
66 | t.truthy(err.stderr.includes('RangeError'));
67 | }
68 | });
69 |
70 | test('bad --config.name, non-Array', async (t) => {
71 | try {
72 | await run('--config.ye', 'webpack.config.js');
73 | } catch (err) {
74 | t.truthy(err.stderr.includes('TypeError'));
75 | }
76 | });
77 |
78 | test('bail', async (t) => {
79 | try {
80 | await run('--config', 'bail.config.js');
81 | } catch (err) {
82 | t.truthy(err.stderr.includes('⬢ webpack: ModuleNotFoundError'));
83 | }
84 | });
85 |
86 | test('es6', async (t) => {
87 | const { stderr } = await run('--config', 'webpack.config.es6');
88 | t.truthy(stderr.includes('es6'));
89 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
90 | });
91 |
92 | test('fn', async (t) => {
93 | const { stderr } = await run('--config', 'fn.config.js');
94 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
95 | });
96 |
97 | test('multi', async (t) => {
98 | const { stderr } = await run('--config', 'multi.config.js');
99 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
100 | });
101 |
102 | test('stats', async (t) => {
103 | const { stderr } = await run('--config', 'stats.config.js');
104 |
105 | if (isWebpack5()) {
106 | t.truthy(stderr.includes('webpack: 1 asset'));
107 | } else {
108 | // Webpack 4
109 | t.snapshot(stderr);
110 | }
111 | });
112 |
113 | test('json - webpack 4', async (t) => {
114 | const { stdout } = await run('--config', 'stats.config.js', '--json');
115 | const stats = JSON.parse(stdout);
116 |
117 | if (isWebpack5()) {
118 | t.truthy(true);
119 |
120 | return;
121 | }
122 |
123 | // Remove times since those are transient
124 | delete stats.time;
125 | delete stats.builtAt;
126 | delete stats.outputPath;
127 | delete stats.chunks;
128 | delete stats.modules;
129 |
130 | t.snapshot(stats);
131 | });
132 |
133 | test('json - webpack 5', async (t) => {
134 | const { stdout } = await run('--config', 'stats.config.js', '--json');
135 | const stats = JSON.parse(stdout);
136 |
137 | if (!isWebpack5()) {
138 | t.truthy(true);
139 |
140 | return;
141 | }
142 |
143 | // remove dynamic key/value pairs
144 | delete stats.builtAt;
145 | delete stats.chunks;
146 | delete stats.hash;
147 | delete stats.modules;
148 | delete stats.outputPath;
149 | delete stats.time;
150 | delete stats.version;
151 |
152 | t.snapshot(stats);
153 | });
154 |
155 | test.serial('watch', (t) => {
156 | t.timeout(5000);
157 | const defer = deferred();
158 | const proc = run('--config', 'watch.config.js');
159 |
160 | setTimeout(async () => {
161 | proc.kill();
162 | const { stderr } = await proc;
163 | t.truthy(stderr.includes('⬡ webpack: Watching Files'));
164 | defer.resolve();
165 | }, 2000);
166 |
167 | return defer.promise;
168 | });
169 |
170 | test('zero config', async (t) => {
171 | const { stderr } = await execa('node', [bin], { cwd: join(cwd, '/zero') });
172 | t.truthy(stderr.includes('⬡ webpack: Build Finished'));
173 | });
174 |
175 | test('--help', async (t) => {
176 | const { stderr } = await run('--help');
177 | t.snapshot(stderr);
178 | });
179 |
180 | test('--silent, info', async (t) => {
181 | const { stderr } = await run('--config', 'webpack.config.js', '--silent');
182 | t.falsy(stderr);
183 | });
184 |
185 | test('--silent, error', async (t) => {
186 | try {
187 | await run('--config', 'bail.config.js', '--silent');
188 | } catch (err) {
189 | t.falsy(err.stderr);
190 | }
191 | });
192 |
193 | test('--version', async (t) => {
194 | const { stderr } = await run('--version');
195 | t.regex(stderr, /v\d{1,2}\.\d{1,2}\.\d{1,2}/i);
196 | });
197 |
198 | test('argv export', (t) => {
199 | t.snapshot(require('../argv')); // eslint-disable-line global-require
200 | });
201 |
--------------------------------------------------------------------------------