Add material icon component generator for react by stplasim · Pull Request #1 · aboutbits/react-material-icons

stplasim · 2020-10-02T06:58:01Z

Add material icon component generator for react

Checklist:

Get a list of all Material Icons
Get the svg data for all icons
Parse Icon name to fit Conventions
Generate individual react components
Generate index page for easy import

alexlanz · 2020-10-02T09:36:40Z

@@ -0,0 +1,6 @@
+# IDE Stuff
+.idea


I would add more files. Maybe you can adopt the structure from the other packages:

https://github.com/aboutbits/pagination/blob/master/.gitignore

I have added the required fields

alexlanz · 2020-10-02T09:38:38Z

 React Material Icons
 ====================
+
+This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable react components


I would write "react" as "React", because it's the right way to write it.

All names have been updated

alexlanz · 2020-10-02T09:42:05Z

+
+## Build & Publish
+
+To build the package, simply run the following command


I would extract the description of the build/clean command into it's own section. And keep the "Build & Publish" section equals to the other packages.

Build and clean have got an own section.

alexlanz · 2020-10-02T09:50:32Z

+  "description": "",
+  "main": "generator.js",
+  "scripts": {
+    "build": "node generator.js",


Attention, the build command is a reserved command that will be used when you execute "npm version patch/minor/major". That's why I would rename this command to something more explicitly named like "import".

In addition, in this file lots of required dependencies and scripts are missing. They are required for publishing the package. See: https://github.com/aboutbits/pagination/blob/master/package.json

All necessary fields have been added. Since tsc is not required for this package, the build command executes the bootstrapping command to create the icon components

alexlanz · 2020-10-02T09:51:30Z

+    await generateComponent(icons.icons);
+    await generateIndex(icons.icons);
+
+})();


I would add an empty line at the end of the file.

alexlanz · 2020-10-05T10:33:31Z

+    "postversion": "git push && git push --tags"
+  },
+  "keywords": [
+    "material design icons",


I would split "material design" and "icons" up into two different strings to optimize the search results.

alexlanz · 2020-10-05T10:34:22Z

+    "react"
+  ],
+  "private": false,
+  "author": "Aboutbits",


The "B" should be written in uppercase "AboutBits".

alexlanz · 2020-10-05T10:39:09Z

@@ -0,0 +1,166 @@
+const fs = require('fs')


I would move this file outside of the src directory. I could live at the top of the directory structure. And I would include the generated files in the PR. Because, the generated code is in fact the real package. This file is just a helper file, that facilitates the generation of the files.

alexlanz · 2020-10-05T10:41:19Z

 React Material Icons
 ====================
+
+This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable React components


I would finish all sentenses with a dot at the end.

alexlanz · 2020-10-05T10:42:14Z

+This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable React components
+
+## Table of content
+- [Usage](#usage)


Please add consistent empty lines before and after titles and paragraphs like in the other packages: https://raw.githubusercontent.com/aboutbits/pagination/master/readme.md

alexlanz · 2020-10-05T10:42:51Z

+
+## Usage
+
+In order to use this package you have to install it through npm


I would use here the same wording like in the other packages: First, ...

alexlanz · 2020-10-05T10:49:47Z

+npm version major
+```
+
+To remove all generated files run the clean script


Should the user be able to clean the generated files? Or should they be automatically be deleted as first step of the generation? For example, first delete the src folder and then regenerate the files in there.

The clean task that you mention here, is to delete the dist folder. And the dist folder is just required for publishing.

Simon Planinschek added 11 commits October 2, 2020 08:10

Add git ignore file

ee5d779

Add package files

fb5ac91

Add React SVG prop type

7ffbc05

Add component generator

20c982a

Updated readme.md

df815d6

Add license

a67a56b

Set axios as dev dependency

295a8b4

Add build instructor to readme.md

2e3757d

Add clean script to package.json

20f9e58

Add clean script description to readme.md

a8fc593

Add index generation to generator.js

bd2bf5a

stplasim changed the title ~~WIP: Add material icon component generator for react~~ Add material icon component generator for react Oct 2, 2020

alexlanz requested changes Oct 2, 2020

View reviewed changes

Simon Planinschek added 12 commits October 5, 2020 10:55

Add eslint config file to the project root

e87258f

Add prettier config file to project root

4d3513b

Add jest config file to project root

5232fb9

Add typescript config file to project root

497f760

Updated git ignore file

daac250

Renamed generator to bootstrapper.js and move it into source folder

e0f7e78

Update files in package.json

815ef0a

Updated readme.md with required changes

0dcdee2

Removed unused tsconfig.json

69c90f7

Removed static types.ts. Replaces with generated one

202fe22

Added additional build command to readme.md

4574a61

Fixed lint error

26205f5

alexlanz requested changes Oct 5, 2020

View reviewed changes

Simon Planinschek added 4 commits October 5, 2020 13:47

Renamed component generator from bootstrapper.js to generator.js

7b2369f

Add git ignore to keep src folder

b185076

Add typescript compiler config file

0cff09d

Cleanup readme.md

87e2b61

Simon Planinschek added 7 commits October 5, 2020 13:51

Add react as peer dependency and changed some scripts

f10c073

Exclude tests in ts compiler config

5fd82c9

Fixed typo in readme.md

291c9c6

Split keywords

89f8e52

Fixed typo in package.json

9607952

Fixed typo in readme.md

a1b412e

Fixed formatting issue in readme.md

87bfcfb

alexlanz merged commit 500d54b into aboutbits:master Oct 5, 2020


		## Build & Publish

		To build the package, simply run the following command


		## Usage

		In order to use this package you have to install it through npm

Uh oh!

Conversation

stplasim commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

stplasim commented Oct 2, 2020 •

edited

Loading