Initial commit

Author: kleingtm

.eslintignore

@@ -0,0 +1 @@
+**/node_modules

.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+    root: true,
+    env: {
+        browser: true,
+        node: true,
+        commonjs: true,
+        es6: true,
+        jest: true
+    },
+    extends: ["eslint:recommended", "eslint-config-prettier"],
+    parserOptions: {
+        ecmaVersion: 2017,
+        sourceType: "module"
+    },
+    plugins: ["eslint-plugin-prettier", "json"],
+    rules: {
+        "prettier/prettier": "error",
+        "no-console": "off",
+        "no-useless-escape": "off", // makes useless escapes warnings instead of errors
+        "prefer-const": "warn",
+        "prefer-template": "warn"
+    }
+};

.gitignore

@@ -0,0 +1,77 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+.npm-pack-all-tmp
+

.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+    tabWidth: 4,
+    endOfLine: "auto",
+    printWidth: 130
+};

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js: node
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version version-number
+  - export PATH="$HOME/.yarn/bin:$PATH"
+cache: yarn

README.md

@@ -1,2 +1,45 @@
 # npm-pack-all
+[![Build Status](https://travis-ci.org/kleingtm/npm-pack-all.svg?branch=master)](https://travis-ci.org/kleingtm/npm-pack-all)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 A simple utility to package all node_modules dependencies when running `npm pack` (not devDependencies)
+
+This can be useful when wanting to ship dependencies as part of the artifact -- side stepping the case
+
+npm-pack-all utility does the following:  
+
+1. Removes devDependencies from the local node_modules folder (only packs production dependencies)  
+
+    + npm: `npm prune --production`
+    + yarn: `yarn install --production` (yarn install prunes automatically)
+    
+2. Makes copies of the untouched package.json and lock files
+3. Adds all dependencies as `bundledDependencies` in the active package.json
+4. Calls `npm pack` (`yarn pack` does not work with bundledDependenies as of 6/21/19)
+
+    + The following will be packed into a .tgz archive:
+    
+        + Any files (via glob) called out in the package.json `files` field
+        + All node_modules that are production dependencies (not devDependencies)
+    
+5. Restores the untouched package.json and lock files
+
+
+
+## Install
+```bash
+npm install npm-pack-all
+
+```
+OR
+
+```bash
+yarn add npm-pack-all
+
+```
+
+## Use
+```bash
+
+
+```
+

__tests__/index.test.js

@@ -0,0 +1,39 @@
+/*
+ * no flags -- should pass and name the artifact with pj name and
+ * --output <nothing> --dev-deps (should fail due to output. check message)
+ * */
+
+const minimist = require(`minimist`);
+const fs = require(`fs`);
+const path = require(`path`);
+
+const TEST_SUITE = `npm-pack-all: ${__filename}`;
+
+beforeEach(() => {
+    jest.resetModules();
+});
+
+afterEach(() => {
+    jest.restoreAllMocks();
+});
+
+afterAll(() => {
+    console.info(`Success: ${TEST_SUITE}`);
+});
+
+describe(TEST_SUITE, () => {
+    test("Can run script without flags", () => {
+        const mockArg = minimist(``.split(` `));
+
+        //  mock input arguments
+        jest.mock(`minimist`, () => {
+            return jest.fn(() => mockArg);
+        });
+
+        // call script
+        require(`../index`);
+
+        const packageJson = require(path.join(process.cwd(), `package.json`));
+        expect(fs.existsSync(`${packageJson.name}-${packageJson.version}.tgz`)).toBeTruthy();
+    });
+});

index.js

@@ -0,0 +1,121 @@
+const fs = require(`fs`);
+const path = require(`path`);
+const shell = require(`shelljs`);
+
+const { CliError, safetyDecorator, shellExecDecorator } = require(path.join(__dirname, `./utils/utils.index`));
+
+const cp = safetyDecorator(shell.cp);
+const mv = safetyDecorator(shell.mv);
+const exec = shellExecDecorator(shell.exec);
+
+const packageManager = determinePackageManager();
+
+const FILES_TO_BACKUP = [`package.json`, `package-lock.json`, `yarn.lock`];
+const TMP_DIRECTORY = path.join(process.cwd(), `.npm-pack-all-tmp`);
+
+console.info(`
+.------..------..------..------..------..------..------..------..------..------..------..------.
+|N.--. ||P.--. ||M.--. ||-.--. ||P.--. ||A.--. ||C.--. ||K.--. ||-.--. ||A.--. ||L.--. ||L.--. |
+| :(): || :/\\: || (\\/) || (\\/) || :/\\: || (\\/) || :/\\: || :/\\: || (\\/) || (\\/) || :/\\: || :/\\: |
+| ()() || (__) || :\\/: || :\\/: || (__) || :\\/: || :\\/: || :\\/: || :\\/: || :\\/: || (__) || (__) |
+| '--'N|| '--'P|| '--'M|| '--'-|| '--'P|| '--'A|| '--'C|| '--'K|| '--'-|| '--'A|| '--'L|| '--'L|
+\`------'\`------'\`------'\`------'\`------'\`------'\`------'\`------'\`------'\`------'\`------'\`------'\n`);
+
+// parse cli args
+const cliArgs = require(`minimist`)(process.argv.slice(2));
+if (typeof cliArgs.output !== `string` && cliArgs.output) {
+    throw new CliError(`--output`, cliArgs.output, `The \`--output\` flag requires a string filename`);
+}
+
+const packageJson = require(path.join(process.cwd(), `package.json`));
+
+shell.config.fatal = true; // error out if a shell command errors out
+shell.config.silent = true;
+
+// create temp directory
+createTempDirectory(TMP_DIRECTORY);
+
+// copy existing package.json and lock files (keep linting, etc in tact)
+console.info(`Saving existing package.json and lock files`);
+copyFiles(process.cwd(), TMP_DIRECTORY, FILES_TO_BACKUP);
+
+// set bundledDependencies in package.json
+const CMDs = {
+    prune: {
+        npm: `npm prune --production && npm install --production`, // removes dev deps
+        yarn: `yarn install --production` // prunes automatically
+    },
+    install: {
+        npm: `npm install --force`,
+        yarn: `yarn install --force`
+    }
+};
+setBundledDependencies(packageJson, CMDs, packageManager);
+
+// pack with npm
+console.info(`\nPacking source code${!cliArgs[`dev-deps`] ? `` : `, development`} and production dependencies...`);
+exec(`npm -dd pack`, { silent: false, timeout: cliArgs.timeout || 3 * 60 * 1000 }); // 3 min timeout
+
+// restoring package.json and lock files back to project root
+console.info(`Restoring original package.json and lock files`);
+moveFiles(TMP_DIRECTORY, process.cwd(), FILES_TO_BACKUP);
+shell.rm(`-Rf`, TMP_DIRECTORY);
+
+setArtifactName(cliArgs);
+
+function createTempDirectory(dir) {
+    shell.rm(`-Rf`, dir);
+    shell.mkdir("-p", dir);
+}
+
+function determinePackageManager() {
+    const yarnLockExists = fs.existsSync(path.join(process.cwd(), `yarn.lock`));
+    const npmLockExists = fs.existsSync(path.join(process.cwd(), `package-lock.json`));
+
+    // if only yarn.lock exists, convert yarn.lock to package-lock.json (we'll use npm)
+    let result = `npm`;
+    if (yarnLockExists && !npmLockExists) {
+        result = `yarn`;
+    }
+    return result;
+}
+
+function setBundledDependencies(pj, cmds, packageManager) {
+    // prune - get rid of devDependencies
+    pj.bundledDependencies = Object.keys(pj.dependencies);
+    if (!cliArgs[`dev-deps`]) {
+        console.info(`Pruning node_modules for packing production dependencies only...`);
+        exec(cmds.prune[packageManager]); // cmd based on package manager. based on existing lockfile. npm takes precedence if both exist
+    } else {
+        console.info(`Detected --dev-deps\n\nInstalling all modules...`);
+        console.warn(`To save time and space, you may want to think about only packaging production dependencies`);
+        exec(cmds.install[packageManager]); // cmd based on package manager. based on existing lockfile. npm takes precedence if both exist
+        pj.bundledDependencies = pj.bundledDependencies.concat(Object.keys(pj.devDependencies));
+    }
+
+    // put dependencies into bundledDependencies in package.json
+    console.info(`Adding dependencies${cliArgs["dev-deps"] ? " and devDependencies" : ""} to bundledDependencies`);
+    fs.writeFileSync(path.join(process.cwd(), `package.json`), JSON.stringify(packageJson, null, 4));
+}
+
+function setArtifactName(args) {
+    if (args.output) {
+        shell.mv(
+            `-f`,
+            path.join(process.cwd(), `${packageJson.name}-${packageJson.version}.tgz`),
+            path.join(process.cwd(), cliArgs.output)
+        );
+    }
+}
+
+function copyFiles(from, to, files) {
+    files.forEach(file => {
+        cp(`-Rf`, path.join(from, file), path.join(to, file));
+    });
+}
+
+function moveFiles(from, to, files) {
+    files.forEach(file => {
+        mv(`-f`, path.join(from, file), path.join(to, file));
+    });
+}

jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+    testMatch: ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
+    collectCoverage: true,
+    coverageDirectory: "./coverage",
+    collectCoverageFrom: ["index.js"],
+    coveragePathIgnorePatterns: [],
+    coverageThreshold: {
+        global: {
+            functions: 100,
+            statements: 80
+        }
+    },
+    modulePathIgnorePatterns: [".npm-cache", ".npm-tmp", ".cache", ".tmp", ".nvm", ".yarn"],
+    reporters: ["default"]
+};

utils/__tests__/utils.index.test.js

@@ -0,0 +1,36 @@
+/*
+ * no flags -- should pass and name the artifact with pj name and
+ * --output <nothing> --dev-deps (should fail due to output. check message)
+ * */
+const path = require(`path`);
+
+const TEST_SUITE = `npm-pack-all: ${__filename}`;
+const { CliError /*, safetyDecorator, shellExecDecorator*/ } = require(path.join(__dirname, `../utils.index`));
+
+beforeEach(() => {
+    jest.resetModules();
+});
+
+afterEach(() => {
+    jest.restoreAllMocks();
+});
+
+afterAll(() => {
+    console.info(`Success: ${TEST_SUITE}`);
+});
+
+describe(TEST_SUITE, () => {
+    test("Test CliError", () => {
+        const flag = `--output`;
+        const flagValue = `artifact.tgz`;
+        const message = `The \`--output\` flag requires a string filename`;
+
+        const Error = new CliError(flag, flagValue, message);
+
+        expect(Error.name).toEqual(`CliInputError`);
+        expect(Error.cliFlag).toEqual(flag);
+        expect(Error.cliValue).toEqual(flagValue);
+        expect(Error.message).toEqual(message);
+        expect(Error.stack).toBeDefined();
+    });
+});