@iconify/tools 1.3.17 → 2.0.0-dev.2

package/src/export/svg.js

@@ -1,55 +0,0 @@
-/**
- * This file is part of the @iconify/tools package.
- *
- * (c) Vjacheslav Trushkin <cyberalien@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const helpers = require('../helpers');
-
-const defaults = {
-	reject: true,
-};
-
-/**
- * Export to .svg file
- *
- * @returns {Promise}
- */
-module.exports = (svg, target, options) => {
-	options = options === void 0 ? Object.create(null) : options;
-	Object.keys(defaults).forEach(key => {
-		if (options[key] === void 0) {
-			options[key] = defaults[key];
-		}
-	});
-
-	return new Promise((fulfill, reject) => {
-		fs.writeFile(target, svg.toString(), 'utf8', err => {
-			if (err) {
-				// Attempt to create directories
-				helpers.mkdir(path.dirname(target));
-
-				fs.writeFile(target, svg.toString(), 'utf8', err => {
-					if (err) {
-						if (options.reject) {
-							reject(err);
-						} else {
-							fulfill(null);
-						}
-					} else {
-						fulfill(svg);
-					}
-				});
-			} else {
-				fulfill(svg);
-			}
-		});
-	});
-};

package/src/export/templates/component.md

@@ -1,79 +0,0 @@
-# iconSetName
-
-This package includes individual files for each icon, ready to be imported into a project.
-
-Each icon is in its own file, so you can bundle several icons from different icon sets without bundling entire icon sets.
-
-## Installation
-
-If you are using NPM:
-
-```bash
-npm install packageName --save-dev
-```
-
-If you are using Yarn:
-
-```bash
-yarn add --dev packageName
-```
-
-## Usage with React
-
-First you need to install [Iconify for React](https://github.com/iconify/iconify/packages/react).
-
-If you are using NPM:
-
-```bash
-npm install --save-dev @iconify/react
-```
-
-If you are using Yarn:
-
-```bash
-yarn add --dev @iconify/react
-```
-
-`samples.react`
-
-See https://github.com/iconify/iconify/packages/react for details.
-
-## Usage with Vue
-
-First you need to install [Iconify for Vue](https://github.com/iconify/iconify/packages/vue).
-
-If you are using NPM:
-
-```bash
-npm install --save-dev @iconify/vue
-```
-
-If you are using Yarn:
-
-```bash
-yarn add --dev @iconify/vue
-```
-
-`samples.vue`
-
-See https://github.com/iconify/iconify/packages/vue for details.
-
-## Usage with Svelte
-
-First you need to install [Iconify for Svelte](https://github.com/iconify/iconify/packages/svelte).
-
-If you are using NPM:
-
-```bash
-npm install --save-dev @iconify/svelte
-```
-
-If you are using Yarn:
-
-```bash
-yarn add --dev @iconify/svelte
-```
-
-`samples.svelte`
-
-See https://github.com/iconify/iconify/packages/svelte for details.

package/src/export/templates/info.md

@@ -1,3 +0,0 @@
-## About iconSetName
-
-iconSetInfo

package/src/export/templates/sample-react-1.md

@@ -1,21 +0,0 @@
-### Example using icon 'sampleFilename' with React
-
-This example is using string syntax that is available since Iconify for React 2.0
-
-This example will not work with Iconify for React 1.x
-
-```jsx
-import React from 'react';
-import { Icon, addIcon } from '@iconify/react';
-import sampleIconName from 'packageName/sampleFilename';
-
-addIcon('sampleIconShortName', sampleIconName);
-
-export function MyComponent() {
-	return (
-		<div>
-			<Icon icon="sampleIconShortName" />
-		</div>
-	);
-}
-```

package/src/export/templates/sample-react-2.md

@@ -1,15 +0,0 @@
-### Example using icon 'sampleFilename' with React
-
-```jsx
-import React from 'react';
-import { InlineIcon } from '@iconify/react';
-import sampleIconName from 'packageName/sampleFilename';
-
-export function MyComponent() {
-	return (
-		<p>
-			<InlineIcon icon={sampleIconName} /> Sample text with an icon.
-		</p>
-	);
-}
-```

package/src/export/templates/sample-react.md

@@ -1,11 +0,0 @@
-### Example using icon 'sampleFilename' with React
-
-```js
-import { Icon, InlineIcon } from '@iconify/react';
-import sampleIconName from 'packageName/sampleFilename';
-```
-
-```jsx
-<Icon icon={sampleIconName} />
-<p>This is some text with icon adjusted for baseline: <InlineIcon icon={sampleIconName} /></p>
-```

package/src/export/templates/sample-svelte.md

@@ -1,11 +0,0 @@
-### Example using icon 'sampleFilename' with Svelte
-
-```svelte
-<script>
-    // npm install --save-dev @iconify/svelte packageName
-    import IconifyIcon from '@iconify/svelte';
-    import sampleIconName from 'packageName/sampleFilename';
-</script>
-
-<IconifyIcon icon={sampleIconName} />
-```

package/src/export/templates/sample-svelte1.md

@@ -1,22 +0,0 @@
-### Example using icon 'sampleFilename' with Svelte
-
-This example shows how to use stylesheet with Svelte component.
-
-```svelte
-<script>
-    // npm install --save-dev @iconify/svelte packageName
-    import IconifyIcon from '@iconify/svelte';
-    import sampleIconName from 'packageName/sampleFilename';
-</script>
-<style>
-   /*
-       Cannot target component in CSS, target SVG
-       instead using Svelte's :global() function
-   */
-   div :global(svg) {
-       vertical-align: -0.125em;
-   }
-</style>
-
-<IconifyIcon icon={sampleIconName} />
-```

package/src/export/templates/sample-svelte2.md

@@ -1,13 +0,0 @@
-### Example using icon 'sampleFilename' with Svelte
-
-Most Markdown parsers do not highlight Svelte syntax, so this example splits script and template into 2 sections to highlight syntax.
-
-```js
-import IconifyIcon from '@iconify/svelte';
-import sampleIconName from 'packageName/sampleFilename';
-```
-
-```jsx
-<IconifyIcon icon={sampleIconName} />
-<p>This is some text with icon adjusted for baseline: <IconifyIcon icon={sampleIconName} inline={true} /></p>
-```

package/src/export/templates/sample-vue-0.md

@@ -1,30 +0,0 @@
-### Example using icon 'sampleFilename' with Vue
-
-This example is using object syntax with TypeScript.
-
-```vue
-<template>
-	<p>
-		<iconify-icon :icon="icons.sampleIconShortName" />
-	</p>
-</template>
-
-<script lang="ts">
-import { Component, Prop, Vue } from 'vue-property-decorator';
-import IconifyIcon from '@iconify/vue';
-import sampleIconName from 'packageName/sampleFilename';
-
-export default Vue.extend({
-	components: {
-		IconifyIcon,
-	},
-	data() {
-		return {
-			icons: {
-				sampleIconShortName: sampleIconName,
-			},
-		};
-	},
-});
-</script>
-```

package/src/export/templates/sample-vue-1.md

@@ -1,25 +0,0 @@
-### Example using icon 'sampleFilename' with Vue
-
-This example is using string syntax.
-
-```vue
-<template>
-	<p>
-		Example of 'sampleFilename' icon:
-		<iconify-icon icon="sampleIconShortName" :inline="true" />!
-	</p>
-</template>
-
-<script>
-import IconifyIcon from '@iconify/vue';
-import sampleIconName from 'packageName/sampleFilename';
-
-IconifyIcon.addIcon('sampleIconShortName', sampleIconName);
-
-export default {
-	components: {
-		IconifyIcon,
-	},
-};
-</script>
-```

package/src/export/templates/sample-vue-2.md

@@ -1,27 +0,0 @@
-### Example using icon 'sampleFilename' with Vue
-
-This example is using object syntax.
-
-```vue
-<template>
-	<iconify-icon :icon="icons.sampleIconName" />
-</template>
-
-<script>
-import IconifyIcon from '@iconify/vue';
-import sampleIconName from 'packageName/sampleFilename';
-
-export default {
-	components: {
-		IconifyIcon,
-	},
-	data() {
-		return {
-			icons: {
-				sampleIconName,
-			},
-		};
-	},
-};
-</script>
-```

package/src/export/templates/sample-vue.md

@@ -1,28 +0,0 @@
-### Example using icon 'sampleFilename' with Vue
-
-```vue
-<template>
-	<p>
-		<iconify-icon :icon="icons.sampleIconShortName" />
-	</p>
-</template>
-
-<script lang="ts">
-import { Component, Prop, Vue } from 'vue-property-decorator';
-import IconifyIcon from '@iconify/vue';
-import sampleIconName from 'packageName/sampleFilename';
-
-export default Vue.extend({
-	components: {
-		IconifyIcon,
-	},
-	data() {
-		return {
-			icons: {
-				sampleIconShortName: sampleIconName,
-			},
-		};
-	},
-});
-</script>
-```

package/src/helpers.js

@@ -1,43 +0,0 @@
-/**
- * This file is part of the @iconify/tools package.
- *
- * (c) Vjacheslav Trushkin <cyberalien@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-'use strict';
-
-const fs = require('fs');
-
-const functions = {
-	/**
-	 * Recursively create directory
-	 *
-	 * @param path
-	 */
-	mkdir: path => {
-		if (typeof path === 'string' && path === '.') {
-			return;
-		}
-
-		let dirs = typeof path === 'string' ? path.split('/') : path,
-			dir;
-
-		if (dirs.length) {
-			dir = '';
-			dirs.forEach(part => {
-				dir += part;
-				if (dir.length) {
-					try {
-						fs.mkdirSync(dir, 0o755);
-					} catch (err) {}
-				}
-				dir += '/';
-			});
-		}
-	},
-};
-
-module.exports = functions;

package/src/import/dir.js

@@ -1,234 +0,0 @@
-/**
- * This file is part of the @iconify/tools package.
- *
- * (c) Vjacheslav Trushkin <cyberalien@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-'use strict';
-
-const fs = require('fs');
-const Importer = require('./svg');
-const Collection = require('../collection');
-
-const defaults = {
-	// Prefix for icons
-	prefix: null,
-
-	// Check sub-directories
-	includeSubDirs: true,
-
-	// Treat subdirectory as prefix: "fa-pro/icon.svg" -> prefix = "fa-pro"
-	directoryAsPrefix: false,
-
-	// If filename includes prefix, such as "fa-pro/fa-pro-home"
-	// this option will remove duplicate prefix
-	removePrefix: false,
-
-	// Function to create keyword from filename
-	keywordCallback: keyword,
-
-	// If false, error will be logged when files with duplicate names are found. See "log" option
-	ignoreDuplicates: false,
-
-	// Array of files to ignore. Each entry is keyword or full file name
-	// It could also be function(name) that should return true if file is ignored, false if not
-	ignoreFiles: false,
-
-	// Options for SVG importer. See "svg.js" in this directory
-	contentCallback: null, // callback to call to test content
-	minify: true,
-	headless: true,
-
-	// Function to log errors. function(message)
-	log: null,
-
-	// Functions to overwrite for custom importer or scanner (used for unit testing)
-	scan: scan,
-	importer: Importer,
-};
-
-/**
- * Scan directory. Returns array of svg files
- *
- * @param {string} dir
- * @param {string} prefix
- * @param {object} options
- * @return {Array}
- */
-function scan(dir, prefix, options) {
-	let results = [];
-
-	fs.readdirSync(dir).forEach(file => {
-		let filename = dir + '/' + file;
-		if (fs.lstatSync(filename).isDirectory()) {
-			if (options.includeSubDirs) {
-				results = results.concat(scan(filename, prefix + file + '/', options));
-			}
-		} else {
-			if (file.toLowerCase().slice(-4) === '.svg') {
-				results.push(prefix + file);
-			}
-		}
-	});
-
-	return results;
-}
-
-/**
- * Get keyword from file
- *
- * @param {string} key
- * @param {string} file
- * @param {object} options
- * @returns {string}
- */
-function keyword(key, file, options) {
-	let result = key
-		.toLowerCase()
-		.replace(/_/g, '-')
-		.replace(/[^a-zA-Z0-9\-_:]/g, '')
-		.replace(/--*/, '-');
-	if (
-		options.prefix &&
-		options.removePrefix &&
-		result.slice(0, options.prefix.length + 1) === options.prefix + '-'
-	) {
-		result = result.slice(options.prefix.length + 1);
-	}
-	return result;
-}
-
-/**
- * Import files from directory
- *
- * @param {string} source Source directory
- * @param {object} [options] List of options
- */
-module.exports = (source, options) => {
-	options = options === void 0 ? Object.create(null) : options;
-	Object.keys(defaults).forEach(key => {
-		if (options[key] === void 0) {
-			options[key] = defaults[key];
-		}
-	});
-
-	// Check if name (filename or keyword) is ignored
-	let isIgnored = name => {
-		if (options.ignoreFiles === false) {
-			return false;
-		}
-		if (typeof options.ignoreFiles === 'function') {
-			return option.ignoreFiles(name);
-		}
-		return (
-			typeof options.ignoreFiles === 'object' &&
-			options.ignoreFiles.indexOf(name) !== -1
-		);
-	};
-
-	// Return promise
-	return new Promise((fulfill, reject) => {
-		let promises = [],
-			keywords = [],
-			filenames = [],
-			collection = new Collection(options.prefix);
-
-		// Remove trailing slash and find all files
-		if (source.slice(-1) === '/') {
-			source = source.slice(0, source.length - 1);
-		}
-		let files = options.scan(source, '', options);
-
-		// Get promise for each file
-		files.forEach(file => {
-			// Check if keyword is ignored
-			if (isIgnored(file)) {
-				return;
-			}
-
-			// Get keyword
-			let fileSplit = file.split('/'),
-				keyword = fileSplit.pop().split('.')[0];
-
-			if (options.directoryAsPrefix) {
-				let dir;
-				if (fileSplit.length) {
-					dir = fileSplit.pop();
-				} else {
-					dir = source.split('/').pop();
-				}
-				if (
-					options.removeDirectoryPrefix &&
-					keyword.slice(0, dir.length + 1) === dir + '-'
-				) {
-					keyword = keyword.slice(dir.length + 1);
-				}
-				keyword = dir + ':' + keyword;
-			}
-
-			keyword = options.keywordCallback(keyword, file, options);
-
-			if (typeof keyword !== 'string') {
-				return;
-			}
-
-			if (!keyword.length) {
-				if (options.log) {
-					options.log('Cannot extract keyword from file: ' + file);
-				}
-				return;
-			}
-
-			if (keywords.indexOf(keyword) !== -1) {
-				if (options.log && !options.ignoreDuplicates) {
-					options.log('Duplicate keyword: ' + keyword);
-				}
-				return;
-			}
-
-			// Check if keyword is ignored
-			if (isIgnored(keyword)) {
-				return;
-			}
-
-			// Load file
-			filenames.push(file);
-			keywords.push(keyword);
-			promises.push(
-				options.importer(source + '/' + file, {
-					reject: false,
-					contentCallback: options.contentCallback,
-					headless: options.headless,
-					minify: options.minify,
-				})
-			);
-		});
-
-		// Load all files
-		Promise.all(promises)
-			.then(results => {
-				keywords.forEach((keyword, index) => {
-					if (results[index] === null) {
-						if (options.log) {
-							options.log('Failed to load: ' + filenames[index]);
-						}
-						return;
-					}
-					collection.add(keyword, results[index]);
-				});
-
-				// Detect prefix
-				if (options.prefix === null) {
-					collection.findCommonPrefix(true);
-				}
-
-				fulfill(collection);
-			})
-			.catch(err => {
-				reject(err);
-			});
-	});
-};