Skip to content
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.

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

Use Rollup for bundling dependencies #242

Merged
merged 16 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
build
yarn.lock
53 changes: 39 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@
"type": "module",
"exports": {
"types": "./index.d.ts",
"default": "./source/index.js"
"default": "./build/index.js"
},
"sideEffects": false,
"engines": {
"node": ">=16.10"
},
"scripts": {
"test": "xo && ava && tsd"
"prepare": "npm run build",
"build": "rollup --config",
"test": "xo && tsd && npm run build && ava"
},
"files": [
"source",
"build",
"index.d.ts"
],
"keywords": [
Expand All @@ -44,34 +47,56 @@
"cmd",
"console"
],
"dependencies": {
"_actualDependencies": [
"@types/minimist",
"camelcase-keys",
"decamelize",
"decamelize-keys",
"hard-rejection",
"minimist-options",
"normalize-package-data",
"read-pkg-up",
"redent",
"trim-newlines",
"type-fest",
"yargs-parser"
],
"devDependencies": {
"@rollup/plugin-commonjs": "^25.0.3",
"@rollup/plugin-json": "^6.0.0",
"@rollup/plugin-node-resolve": "^15.1.0",
"@types/minimist": "^1.2.2",
"ava": "^5.3.1",
"camelcase-keys": "^8.0.2",
"common-tags": "^2.0.0-alpha.1",
"decamelize": "^6.0.0",
"decamelize-keys": "^2.0.1",
"delete_comments": "^0.0.2",
"execa": "^7.2.0",
"globby": "^13.2.2",
"hard-rejection": "^2.1.0",
"indent-string": "^5.0.0",
"minimist-options": "4.1.0",
"normalize-package-data": "^5.0.0",
"read-pkg": "^8.0.0",
"read-pkg-up": "^10.0.0",
"redent": "^4.0.0",
"rollup": "^3.27.0",
"rollup-plugin-license": "^3.0.1",
"trim-newlines": "^5.0.0",
"tsd": "^0.28.1",
"type-fest": "^4.2.0",
"xo": "^0.56.0",
"yargs-parser": "^21.1.1"
},
"devDependencies": {
"ava": "^5.3.1",
"common-tags": "^1.8.2",
"execa": "^7.2.0",
"indent-string": "^5.0.0",
"read-pkg": "^8.0.0",
"tsd": "^0.28.1",
"xo": "^0.56.0"
},
"xo": {
"rules": {
"unicorn/no-process-exit": "off",
"unicorn/error-message": "off"
}
},
"ignores": [
"build"
]
},
"ava": {
"files": [
Expand Down
57 changes: 57 additions & 0 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import {nodeResolve} from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';
import json from '@rollup/plugin-json';
import license from 'rollup-plugin-license';
import {globby} from 'globby';
import {createTag, replaceResultTransformer} from 'common-tags';
import {delete_comments as deleteComments} from 'delete_comments';
import {defineConfig} from 'rollup';

/** Matches empty lines: https://stackoverflow.com/q/16369642/10292952 */
const emptyLineRegex = /^\s*[\r\n]/gm;

const stripComments = createTag(
{onEndResult: deleteComments},
replaceResultTransformer(emptyLineRegex, ''),
);

const outputDirectory = 'build';

export default defineConfig({
input: await globby('source/**/*.js'),
output: {
dir: outputDirectory,
interop: 'esModule',
generatedCode: {
preset: 'es2015',
},
chunkFileNames: '[name].js',
manualChunks(id) {
if (id.includes('node_modules')) {
return 'dependencies';
}
},
hoistTransitiveImports: false,
plugins: [{
name: 'strip-dependency-comments',
renderChunk(code, chunk) {
return chunk.name === 'dependencies' ? stripComments(code) : null;
},
}],
},
treeshake: {
moduleSideEffects: 'no-external',
},
plugins: [
nodeResolve(),
commonjs({
include: 'node_modules/**',
}),
json(),
license({
thirdParty: {
output: `${outputDirectory}/licenses.md`,
},
}),
],
});
7 changes: 7 additions & 0 deletions test/_utils.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import path from 'node:path';
import {fileURLToPath} from 'node:url';
import {execa} from 'execa';
import {createTag, stripIndentTransformer, trimResultTransformer} from 'common-tags';

export const __dirname = path.dirname(fileURLToPath(import.meta.url));

Expand All @@ -15,3 +16,9 @@ export const spawnFixture = async (fixture = 'fixture.js', args = []) => {

return execa(getFixture(fixture), args);
};

// Use old behavior prior to zspecza/common-tags#165
export const stripIndent = createTag(
stripIndentTransformer(),
trimResultTransformer(),
);
46 changes: 46 additions & 0 deletions test/build.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import test from 'ava';
import {readPackage} from 'read-pkg';
import meow from '../build/index.js';
import {spawnFixture} from './_utils.js';

test('main', t => {
const cli = meow(`
Usage
foo <input>
`, {
importMeta: import.meta,
argv: 'foo --foo-bar --u cat -- unicorn cake'.split(' '),
flags: {
unicorn: {
shortFlag: 'u',
},
meow: {
default: 'dog',
},
'--': true,
},
});

t.like(cli, {
input: ['foo'],
flags: {
fooBar: true,
meow: 'dog',
unicorn: 'cat',
'--': [
'unicorn',
'cake',
],
},
pkg: {
name: 'meow',
},
help: '\n CLI app helper\n\n Usage\n foo <input>\n',
});
});

test('spawn cli and show version', async t => {
const pkg = await readPackage();
const {stdout} = await spawnFixture(['--version']);
t.is(stdout, pkg.version);
});
2 changes: 1 addition & 1 deletion test/choices.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import test from 'ava';
import {stripIndent} from 'common-tags';
import meow from '../source/index.js';
import {stripIndent} from './_utils.js';

const importMeta = import.meta;

Expand Down
2 changes: 1 addition & 1 deletion test/errors.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import test from 'ava';
import {stripIndent} from 'common-tags';
import meow from '../source/index.js';
import {stripIndent} from './_utils.js';

const importMeta = import.meta;

Expand Down
32 changes: 32 additions & 0 deletions test/fixtures/build.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env node
tommy-mitchell marked this conversation as resolved.
Show resolved Hide resolved
import process from 'node:process';
import meow from '../../build/index.js';

const cli = meow(`
Usage
foo <input>
`, {
importMeta: import.meta,
description: 'Custom description',
autoVersion: !process.argv.includes('--no-auto-version'),
autoHelp: !process.argv.includes('--no-auto-help'),
flags: {
unicorn: {
shortFlag: 'u',
},
meow: {
default: 'dog',
},
camelCaseOption: {
default: 'foo',
},
},
});

if (cli.flags.camelCaseOption === 'foo') {
for (const flagKey of Object.keys(cli.flags)) {
console.log(flagKey);
}
} else {
console.log(cli.flags.camelCaseOption);
}