Merge pull request #25 from scriptex/feature/optional-components

Make separate components optional

.npmignore

@@ -45,8 +45,10 @@ _.config.yml
 create-pwa.sketch
 
 # Tests
+favicons
 icons
 launch-screens
+config.xml
+*.appcache
 manifest.json
 service-worker.js
-*.appcache

README.md

@@ -440,6 +440,8 @@ const appIcon = require('fs').resolve(__dirname, './your_icon.png');
 setIcons(appIcon);
 ```
 
+**The generated icons are located in the `/icons` folder.**
+
 3. To create only the launch screens:
 
 ```javascript
@@ -449,6 +451,8 @@ const launchScreen = require('fs').resolve(__dirname, './your_launch_screen.png'
 setLaunchScreens(launchScreen);
 ```
 
+**The generated files are located in the `/launch-screens` folder.**
+
 4. To create only manifest file:
 
 ```javascript
@@ -460,31 +464,27 @@ setManifest(appName);
 
 **The generated `manifest.json` file contains references to the application icons. You must have these already generated otherwise you must edit your `manifest.json` file and remove them.**
 
-5. To create only service worker file:
+5. To create only favicon files:
 
 ```javascript
-const { setServiceWorker } = require('create-pwa');
-const appName = 'Your application name';
+const { setFavicons } = require('create-pwa');
+const appIcon = require('fs').resolve(__dirname, './your_icon.png');
 
-setServiceWorker(appName);
+setFavicons(appIcon);
 ```
 
-**The generated `service-worker.js` file contains references to the application icons and application launch screens. You must have these already generated otherwise you must edit your `service-worker.js` file and remove them.**
+**The generated files are located in the `/favicons` folder.**
 
-6. To create all files:
+6. To create only service worker file:
 
 ```javascript
-const createPWA = require('create-pwa');
-const icon = require('fs').resolve(__dirname, './your_icon.png');
-const launch = require('fs').resolve(__dirname, './your_launch_screen.png');
-
-createPWA({
-	icon,
-	launch
-});
+const { setServiceWorker } = require('create-pwa');
+const appName = 'Your application name';
+
+setServiceWorker(appName);
 ```
 
-**This command assumes that you have a `package.json` file in the folder you run the command from and this `package.json` file contains a non-empty `name` member.**
+**The generated `service-worker.js` file contains references to the application icons and application launch screens. You must have these already generated otherwise you must edit your `service-worker.js` file and remove them.**
 
 ## LICENSE
 

package.json

@@ -1,8 +1,9 @@
 {
 	"name": "create-pwa",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"description": "Easily create a progressive web app",
 	"scripts": {
+		"pwa": "src/index.js --icon=\"./icon.png\" --launch=\"./launch.png\" --icons=false --app-cache=false --manifest=false --favicons=false --service-worker=false --launch-screens=false",
 		"test": "tape test.js"
 	},
 	"bin": {

src/index.js

@@ -6,10 +6,51 @@
 const { resolve, sep } = require('path');
 const { existsSync, writeFileSync, mkdirSync } = require('fs');
 
+/**
+ * Default options
+ */
+const DEFAULTS = {
+	icon: './icon.png',
+	launch: './launch.png'
+};
+
 /**
  * External dependencies
  */
-const argv = require('yargs').argv;
+const argv = require('yargs').options({
+	icon: {
+		default: DEFAULTS.icon,
+		type: 'string'
+	},
+	launch: {
+		default: DEFAULTS.launch,
+		type: 'string'
+	},
+	icons: {
+		default: true,
+		type: 'boolean'
+	},
+	manifest: {
+		default: true,
+		type: 'boolean'
+	},
+	appCache: {
+		default: true,
+		type: 'boolean'
+	},
+	favicons: {
+		default: true,
+		type: 'boolean'
+	},
+	serviceWorker: {
+		default: true,
+		type: 'boolean'
+	},
+	launchScreens: {
+		default: true,
+		type: 'boolean'
+	}
+}).argv;
 
 /**
  * Internal dependencies
@@ -27,14 +68,6 @@ const serviceWorkerTemplate = require('./sw');
  */
 const pwd = process.env.PWD;
 
-/**
- * Default options
- */
-const DEFAULTS = {
-	icon: './icon.png',
-	launch: './launch.png'
-};
-
 /**
  * Get application's name
  */
@@ -122,23 +155,41 @@ const setFavicons = icon => generateImages(icon, 'favicons', generateFavicons);
  * Create all PWA required files
  * @param {Object} => { icon: File, launch: File}
  */
-const create = (options = DEFAULTS) => {
+const create = () => {
 	const name = getAppName();
 
-	let { icon, launch } = options;
+	const { icon, launch, icons, manifest, favicons, appCache, serviceWorker, launchScreens } = argv;
+	const iconToUse = icon || DEFAULTS.icon;
+	const launchToUse = launch || DEFAULTS.launch;
+
+	if (icons) {
+		setIcons(iconToUse);
+	}
+
+	if (manifest) {
+		setManifest(name);
+	}
+
+	if (appCache) {
+		setAppCache(name);
+	}
 
-	icon = argv.icon || icon;
-	launch = argv.launch || launch;
+	if (favicons) {
+		setFavicons(iconToUse);
+		setMsTileConfig();
+	}
 
-	setIcons(icon);
-	setAppCache(name);
-	setManifest(name);
-	setFavicons(icon);
-	setMsTileConfig();
-	setServiceWorker(name);
-	setLaunchScreens(launch);
+	if (serviceWorker) {
+		setServiceWorker(name);
+	}
+
+	if (launchScreens) {
+		setLaunchScreens(launchToUse);
+	}
 };
 
+create();
+
 module.exports = create;
 module.exports.setIcons = setIcons;
 module.exports.setAppCache = setAppCache;