Merge pull request #1 from stplasim/master

Add material icon component generator for react

Author: alexlanz

.eslintrc.json

@@ -0,0 +1,49 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "env": {
+        "browser": true,
+        "node": true
+    },
+    "plugins": [
+        "prettier",
+        "@typescript-eslint",
+        "jest",
+        "import"
+    ],
+    "extends": [
+        "prettier",
+        "plugin:prettier/recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:import/typescript"
+    ],
+    "parserOptions": {
+        "sourceType": "module",
+        "ecmaVersion": 2018
+    },
+    "rules": {
+        "import/namespace": "off",
+        "import/order": [
+            "error"
+        ],
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": "error",
+        "@typescript-eslint/member-delimiter-style": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/no-extra-semi": "off"
+    },
+    "overrides": [
+        {
+            // enable the rule specifically for TypeScript files
+            "files": [
+                "*.ts",
+                "*.tsx"
+            ],
+            "rules": {
+                "@typescript-eslint/explicit-function-return-type": [
+                    "error"
+                ]
+            }
+        }
+    ]
+}

.gitignore

@@ -0,0 +1,11 @@
+# Basic
+.DS_Store
+
+# IDE
+/.idea
+/.vscode
+
+# Project
+/package-lock.json
+/node_modules
+/dist

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "semi": false
+}

generator.js

@@ -0,0 +1,125 @@
+const fs = require('fs')
+const path = require('path')
+const axios = require('axios')
+
+// Base url for icons
+const iconURL = 'https://fonts.google.com/metadata/icons'
+
+function setup() {
+  // Create components folder
+  fs.mkdirSync(path.join(__dirname, 'src', 'components'))
+
+  // Create types file
+  fs.writeFileSync(
+    path.join(__dirname, 'src', 'components', 'types.ts'),
+    'import React from "react" \nexport type IconProps = React.SVGProps<SVGSVGElement>'
+  )
+}
+
+/**
+ * Format name.
+ * Covert from snake case to camel case and prevent numbers at the beginning
+ *
+ * @param string - String to format
+ * @returns {string} - Formatted string
+ */
+function formatName(string) {
+  const formattedString = string
+    .replace(/_/g, ' ')
+    .replace(/\w\S*/g, (txt) => {
+      return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase()
+    })
+    .replace(/ /g, '')
+  return 'Icon' + formattedString
+}
+
+/**
+ * Component template for functional react icon component
+ *
+ * @param name - Component name
+ * @param svg - Icon SVG
+ * @returns {string} - Component
+ */
+function componentTemplate(name, svg) {
+  let component = "import React from 'react'\n"
+  component += "import { IconProps } from './types'\n"
+  component += `const ${name}: React.FC<IconProps> = (props) => (`
+  component += svg + ')\n\n'
+  component += `export { ${name} }`
+
+  return component
+}
+
+/**
+ * Generate React Icon components
+ *
+ * @param icon - Icon object
+ */
+function generateComponent(icon) {
+  icon.forEach(async (c) => {
+    const name = formatName(c.name)
+    const svg = await getSVGFile(c.name, c.version)
+
+    fs.writeFileSync(
+      path.join(__dirname, 'src', 'components', `${name}.tsx`),
+      componentTemplate(name, svg)
+    )
+  })
+}
+
+/**
+ * Generate index tsx file for easy import
+ *
+ * @param icons - Array of icons
+ */
+function generateIndex(icons) {
+  let imports = ''
+  let exports = 'export {\n'
+
+  icons.forEach((icon) => {
+    const name = formatName(icon.name)
+    imports += `import { ${name} } from './components/${name}'\n`
+    exports += `  ${name},\n`
+  })
+  exports += '}'
+
+  fs.writeFileSync(
+    path.join(__dirname, 'src', 'index.ts'),
+    imports + '\n' + exports
+  )
+}
+
+/**
+ * Get SVG data form google static fonts api
+ *
+ * @param icon - Icon name
+ * @param version - Icon Version
+ * @returns {Promise<any>} - SVG Data
+ */
+async function getSVGFile(icon, version) {
+  const svg = await axios.get(
+    `https://fonts.gstatic.com/s/i/materialicons/${icon}/v${version}/24px.svg`
+  )
+
+  return svg.data.replace('height="24"', '').replace('width="24"', '{...props}')
+}
+
+/**
+ * Main function
+ */
+;(async () => {
+  // Setup source folder
+  setup()
+
+  // Get icon information from google fonts
+  const res = await axios.get(iconURL)
+  // remove )]}' from the response
+  const data = res.data.substring(4)
+
+  // Parse response from json to js object
+  const icons = await JSON.parse(data)
+
+  // Generate icon components and Index
+  await generateComponent(icons.icons)
+  await generateIndex(icons.icons)
+})()

jestconfig.json

@@ -0,0 +1,7 @@
+{
+  "transform": {
+    "^.+\\.(t|j)sx?$": "ts-jest"
+  },
+  "testRegex": "(/__tests?__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+}

license.md

@@ -0,0 +1,9 @@
+
+
+Copyright About Bits GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.