prepare-package 1.1.8 → 1.1.9

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg">
+  <a href="https://itwcreativeworks.com">
     <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
   </a>
 </p>
@@ -24,19 +24,19 @@
   <strong>Prepare Package</strong> is a helpful NPM module that prepares your package before distribution.
 </p>
 
-## Install Prepare Package
-### Install via npm
+## 📦 Install Prepare Package
+### Option 1: Install via npm
 Install with npm if you plan to use **Prepare Package** in a Node.js project.
 ```shell
 npm install prepare-package --save-dev
 ```
 
-## Features
+## 🦄 Features
 * Copy files from `src` to `dist`
 * Replace tags in your main file, `index.js`
   * `{version}` => `package.version`
 
-## Example Setup
+## 📘 Example Setup
 After installing via npm, simply put this in your `package.json`
 ```json
 ...
@@ -57,7 +57,7 @@ After installing via npm, simply put this in your `package.json`
 * `preparePackage.out`: The dir to copy **to**.
 * `main`: The file to copy and use as your main file. Tags like `{version}` are replaced in this file.
 
-## Usage
+## ⚡️ Usage
 ### Run Prepare Package
 ```shell
 # Run once
@@ -67,5 +67,5 @@ npm run prepare
 npm run prepare:watch
 ```
 
-## Final Words
+## 🗨️ Final Words
 If you are still having difficulty, we would love for you to post a question to [the Prepare Package issues page](https://github.com/itw-creative-works/prepare-package/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

package/dist/index.js

@@ -34,10 +34,12 @@ module.exports = async function (options) {
 
   // Add script
   theirPackageJSON.scripts = theirPackageJSON.scripts || {};
-  theirPackageJSON.scripts.prepare = theirPackageJSON.scripts.prepare
-    || 'node -e \'require(`prepare-package`)()\'';
-  theirPackageJSON.scripts['prepare:watch'] = theirPackageJSON.scripts['prepare:watch']
-    || `nodemon -w ./src -e '*' --exec 'npm run prepare'`
+  // theirPackageJSON.scripts.prepare = theirPackageJSON.scripts.prepare
+  //   || 'node -e \'require(`prepare-package`)()\'';
+  // theirPackageJSON.scripts['prepare:watch'] = theirPackageJSON.scripts['prepare:watch']
+  //   || `nodemon -w ./src -e '*' --exec 'npm run prepare'`
+  theirPackageJSON.scripts.prepare = `node -e \\"require('prepare-package')()\\"`;
+  theirPackageJSON.scripts['prepare:watch'] = `nodemon -w ./src -e '*' --exec 'npm run prepare'`
 
   // Log the options
   console.log(chalk.blue(`[prepare-package]: Options purge=${options.purge}`));

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "prepare-package",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "Prepare a Node.js package before being published",
   "main": "dist/index.js",
   "scripts": {
     "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
-    "start": "node -e 'require(`./src/index.js`)()'",
-    "prepare": "node -e 'require(`./src/index.js`)()'",
+    "start": "node -e \"require('./src/index.js')()\"",
+    "prepare": "node -e \"require('./src/index.js')()\"",
     "prepare:watch": "nodemon -w ./src -e '*' --exec 'npm run prepare'",
-    "postinstall": "node -e 'require(`./dist/index.js`)({cwd: process.env.INIT_CWD, isPostInstall: true})'"
+    "postinstall": "node -e \"require('./dist/index.js')({cwd: process.env.INIT_CWD, isPostInstall: true})\""
   },
   "preparePackage": {
     "input": "src",
@@ -42,4 +42,4 @@
   "devDependencies": {
     "mocha": "^8.4.0"
   }
-}
+}

package/src/index.js

@@ -1,111 +0,0 @@
-const jetpack = require('fs-jetpack');
-const fetch = require('wonderful-fetch');
-const path = require('path');
-const chalk = require('chalk');
-
-// const argv = require('yargs').argv;
-
-module.exports = async function (options) {
-  // Set the options
-  options = options || {};
-  options.purge = typeof options.purge === 'undefined' ? true : options.purge;
-  options.cwd = options.cwd || process.cwd();
-  options.isPostInstall = typeof options.isPostInstall === 'undefined' ? false : options.isPostInstall;
-
-  // Set the paths
-  const theirPackageJSONPath = path.resolve(options.cwd, 'package.json');
-  const theirPackageJSONExists = jetpack.exists(theirPackageJSONPath);
-
-  // Get the package.json files
-  const thisPackageJSON = require('../package.json');
-  const theirPackageJSON = theirPackageJSONExists ? require(theirPackageJSONPath) : {};
-  const isLivePreparation = theirPackageJSON.name !== 'prepare-package';
-
-  // const options = {
-  //   purge: argv['--purge'] || argv['-p'],
-  // };
-
-  // Fix their package.json
-  theirPackageJSON.main = theirPackageJSON.main || './dist/index.js';
-  theirPackageJSON.preparePackage = theirPackageJSON.preparePackage || {};
-  theirPackageJSON.preparePackage.input = theirPackageJSON.preparePackage.input || './src';
-  theirPackageJSON.preparePackage.output = theirPackageJSON.preparePackage.output || './dist';
-  theirPackageJSON.preparePackage.replace = theirPackageJSON.preparePackage.replace || {};
-
-  // Add script
-  theirPackageJSON.scripts = theirPackageJSON.scripts || {};
-  theirPackageJSON.scripts.prepare = theirPackageJSON.scripts.prepare
-    || 'node -e \'require(`prepare-package`)()\'';
-  theirPackageJSON.scripts['prepare:watch'] = theirPackageJSON.scripts['prepare:watch']
-    || `nodemon -w ./src -e '*' --exec 'npm run prepare'`
-
-  // Log the options
-  console.log(chalk.blue(`[prepare-package]: Options purge=${options.purge}`));
-  console.log(chalk.blue(`[prepare-package]: input=${theirPackageJSON.preparePackage.input}`));
-  console.log(chalk.blue(`[prepare-package]: output=${theirPackageJSON.preparePackage.output}`));
-  console.log(chalk.blue(`[prepare-package]: main=${theirPackageJSON.main}`));
-
-  // Set the paths relative to the cwd
-  const mainPath = path.resolve(options.cwd, theirPackageJSON.main);
-  const outputPath = path.resolve(options.cwd, theirPackageJSON.preparePackage.output);
-  const inputPath = path.resolve(options.cwd, theirPackageJSON.preparePackage.input);
-
-  // Check if paths exist
-  const mainPathExists = jetpack.exists(mainPath);
-  const outputPathExists = jetpack.exists(outputPath);
-  const inputPathExists = jetpack.exists(inputPath);
-
-  // Remove the output folder if it exists (input must exist too)
-  if (outputPathExists && inputPathExists) {
-    jetpack.remove(outputPath);
-  }
-
-  // Copy the input folder to the output folder if it exists
-  if (inputPathExists) {
-    jetpack.copy(inputPath, outputPath);
-  }
-
-  // Only do this part on the actual package that is using THIS package because we dont't want to replace THIS {version}
-  if (isLivePreparation) {
-    // Replace the main file
-    if (mainPathExists) {
-      jetpack.write(
-        mainPath,
-        jetpack.read(mainPath)
-          .replace(/{version}/igm, theirPackageJSON.version),
-      );
-    }
-
-    // Replace the package.json
-    if (theirPackageJSONExists) {
-      jetpack.write(
-        theirPackageJSONPath,
-        JSON.stringify(theirPackageJSON, null, 2)
-      );
-    }
-  }
-
-  // Handle post install
-  if (options.isPostInstall) {
-    // Send analytics
-    // ... moveed to another package
-  }
-
-  // If purge is disabled, then return
-  if (options.purge === false) {
-    return;
-  }
-
-  // Purge the CDN
-  return fetch(`https://purge.jsdelivr.net/npm/${theirPackageJSON.name}@latest`, {
-    response: 'json',
-    tries: 3,
-  })
-  .then(result => {
-    console.log(chalk.green(`[prepare-package]: Purged ${theirPackageJSON.name}`));
-  })
-  .catch(e => {
-    console.log(chalk.red(`[prepare-package]: Failed to purge ${theirPackageJSON.name}`, e));
-  })
-}
-