Add scripts, update ci cmds

.circleci/config.yml

@@ -5,24 +5,21 @@ jobs:
             - image: circleci/node:12.6-browsers
         steps:
             - checkout
-            - restore_cache:
-                  keys:
-                      - v1-dependencies-{{ checksum "package.json" }}
-                      - v1-dependencies-
             - run:
                   name: Install Dependencies
                   command: |
                       yarn install
-            - save_cache:
-                  paths:
-                      - node_modules
-                  key: v1-dependencies-{{ checksum "package.json" }}
+                      cd symbols-mui && yarn install:dependencies
             - run:
                   name: Build Packages
-                  command: yarn build
+                  command: |
+                      yarn build
+                      cd symbols-mui && yarn build
             - run:
                   name: Verify SVG Build Artifacts
-                  command: yarn test:svg
+                  command: |
+                      yarn test:svg
+                      cd symbols-mui && yarn test
             - persist_to_workspace:
                   root: .
                   paths:
@@ -43,6 +40,9 @@ jobs:
         - run:
             name: Publish @pxblue/symbols
             command: cd symbols && yarn publish:package -b $CIRCLE_BRANCH
+        - run:
+            name: Publish @pxblue/symbols-mui
+            command: cd symbols-mui && yarn publish:package -b $CIRCLE_BRANCH
 workflows:
   version: 2
   symbols:

.gitignore

@@ -26,3 +26,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 /.idea/
+
+symbols-mui/symbols

PUBLISHING.md

@@ -17,6 +17,12 @@ cd symbols
 yarn publish:package
 ```
 
+### @pxblue/symbols-mui
+```
+cd symbols-mui
+yarn publish:package
+```
+
 The publishing script will look at the version in the `package.json` and automatically determine whether to publish an alpha, beta, or latest package.
 
 For this command to work, you must have an NPM token configured in your environment variables or you can perform a login prior to executing the publish command via:

package.json

@@ -9,7 +9,7 @@
     "license": "BSD-3-Clause",
     "scripts": {
       "test:svg": "./scripts/svgBuildTest.sh",
-      "build": "create-svg-sprite --optimize --input './symbols/svg' --output './symbols' --name 'symbols'"
+      "build": "create-svg-sprite --optimize --input './symbols' --output './symbols' --name 'symbols'"
  },
     "files": [
         "iconfont",
@@ -24,9 +24,7 @@
     "homepage": "https://github.com/pxblue/icons#readme",
     "prettier": "@pxblue/prettier-config",
     "devDependencies": {
-        "@pxblue/prettier-config": "^1.0.3",
         "create-svg-sprite": "~1.0.4",
-        "prettier": "^2.2.1",
         "yarn-audit-fix": "^3.2.7"
     },
     "keywords": [

symbols-mui/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Recent Changes
+
+## v1.1.1 (July 2, 2020)
+
+### Fixed
+
+-   Fixes viewbox issues with some symbols.
+
+## v1.1.0 (February 13, 2020)
+
+### Added
+
+-   Added type definitions for use in TypeScript projects.
+
+## v1.0.0 (October 25, 2018)
+
+Initial Release

symbols-mui/CODEOWNERS

@@ -0,0 +1 @@
+* @emclaug2 @joebochill @daileytj

symbols-mui/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Eaton
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

symbols-mui/PUBLISHING.md

@@ -0,0 +1,28 @@
+# Publishing Instructions
+
+## Automatic Publishing
+
+This package is published to NPM automatically by CircleCI when code is merged into the `dev` or `master` branches. To publish a new version, simply update the version in `package.json` and merge your code into the appropriate branch.
+- The `dev` branch will publish versions marked as `alpha` or `beta`.
+- The `master` branch will publish any version (`alpha`, `beta`, or `latest`).
+  In both cases, the code will only be published if the version number differs from the current version published under the respective dist tag.
+
+## Manually Publishing
+
+If you need to publish a package manually, you can run the following commands from the root folder:
+
+```sh
+yarn build 
+yarn publish:package
+```
+
+The publishing script will look at the version in the `package.json` and automatically determine whether to publish an alpha, beta, or latest package.
+
+For this command to work, you must have an NPM token configured in your environment variables or you can perform a login prior to executing the publish command via:
+
+```sh
+yarn build 
+npm adduser && yarn publish:package
+```
+
+> Publishing manually should only be done for `alpha` or `beta` packages. The command will work for `latest` packages, but this should be avoided except in rare situations where the automatic publishing functionality is not working in CircleCI.

symbols-mui/README.md

@@ -0,0 +1,49 @@
+[![](https://img.shields.io/circleci/project/github/pxblue/symbols-mui/master.svg?style=flat)](https://circleci.com/gh/pxblue/symbols-mui/tree/master)
+![npm](https://img.shields.io/npm/v/@pxblue/symbols-mui?label=%40pxblue/symbols-mui)
+
+# PX Blue Symbols for Material-UI
+This library contains componentized svg symbols from [@pxblue/symbols](https://github.com/pxblue/symbols) for use in React applications using Material UI. The symbols are made available in the same way that Material UI exposes the [Material Icons](https://material-ui.com/style/icons/#svg-material-icons). 
+
+## Installation
+To install the PX Blue mui symbols from NPM as a dependency for your project, you can run one of the following commands in your project root:
+```
+npm install --save @pxblue/symbols-mui
+or
+yarn add @pxblue/symbols-mui
+```
+
+>**NOTE (Peer Dependencies):** Using this package requires you to have @material-ui/core and @material-ui/icons defined as dependencies in your project's package.json file.
+
+
+## Usage
+
+### Angular
+This package is intended for use only in React applications. For a way to link svg symbols for use in Angular applications, see [@pxblue/symbols](https://github.com/pxblue/symbols).
+
+
+### React
+Once you have installed the npm module, you can import the symbol components into your application as follows:
+```
+import mySymbol from '@pxblue/symbols-mui/MySymbol;
+...
+<mySymbol></mySymbol>
+```
+If you are importing multiple symbols, you can save some space by using named imports from the package root:
+```
+import {FirstSymbol, SecondSymbol, ThirdSymbol} from '@pxblue/symbols-mui';
+```
+
+Symbol names are in TitleCase - for a list of available symbols, refer to [@pxblue/symbols](https://github.com/pxblue/symbols/blob/master/README.md) or look at our live [demo](http://pxblue.github.io/style/iconography).
+
+## Building Symbol Set (for contributors)
+To build the symbols set, e.g. when new symbols are added:
+
+```
+yarn install
+yarn run svgr
+```
+or
+```
+yarn install
+yarn run mui
+```

symbols-mui/demos/showcase/.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports =  {
+        root: true,
+        parser:  '@typescript-eslint/parser',
+        extends:  [ '@pxblue/eslint-config/tsx' ],
+        parserOptions:  {
+            project: "./tsconfig.json",
+        },
+        env: {
+            browser: true
+        }
+    };

symbols-mui/demos/showcase/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `yarn build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

symbols-mui/demos/showcase/package.json

@@ -0,0 +1,73 @@
+{
+    "name": "showcase",
+    "version": "0.1.0",
+    "private": true,
+    "dependencies": {
+        "@material-ui/core": "^4.11.0",
+        "@material-ui/icons": "^4.9.1",
+        "@pxblue/colors": "^3.0.0",
+        "@pxblue/icons-mui": "^2.2.1",
+        "@pxblue/react-components": "^5.1.0",
+        "@pxblue/react-themes": "^6.0.0",
+        "@pxblue/symbols-mui": "^1.1.1",
+        "@testing-library/jest-dom": "^5.11.4",
+        "@testing-library/react": "^11.1.0",
+        "@testing-library/user-event": "^12.1.10",
+        "react": "^17.0.2",
+        "react-app-polyfill": "^2.0.0",
+        "react-dom": "^17.0.2",
+        "react-scripts": "4.0.3",
+        "typeface-open-sans": "^1.1.13",
+        "typescript": "^4.0.3",
+        "web-vitals": "^0.2.4"
+    },
+    "scripts": {
+        "start": "react-scripts start",
+        "build": "react-scripts build",
+        "test": "react-scripts test",
+        "eject": "react-scripts eject",
+        "lint": "eslint \"src/**/**.{ts,tsx}\"",
+        "lint:fix": "eslint \"src/**/**.{ts,tsx}\" --fix",
+        "prettier": "prettier \"src/**/**.{ts,tsx,js,jsx,json,css,scss,html}\" --write",
+        "prettier:check": "prettier \"src/**/**.{ts,tsx,js,jsx,json,css,scss,html}\" --check"
+    },
+    "eslintConfig": {
+        "extends": [
+            "react-app",
+            "react-app/jest"
+        ]
+    },
+    "browserslist": {
+        "production": [
+            ">0.2%",
+            "not dead",
+            "not op_mini all",
+            "IE 11",
+            "not IE 9-10"
+        ],
+        "development": [
+            "last 1 chrome version",
+            "last 1 firefox version",
+            "last 1 safari version",
+            "ie 11",
+            "not ie 9-10"
+        ]
+    },
+    "devDependencies": {
+        "@pxblue/eslint-config": "^2.0.2",
+        "@pxblue/prettier-config": "^1.0.2",
+        "@types/jest": "^26.0.15",
+        "@types/node": "^12.0.0",
+        "@types/react": "^16.9.53",
+        "@types/react-dom": "^16.9.8",
+        "@typescript-eslint/eslint-plugin": "^4.5.0",
+        "@typescript-eslint/parser": "^4.5.0",
+        "enzyme": "^3.11.0",
+        "enzyme-adapter-react-16": "^1.15.0",
+        "eslint": "^7.11.0",
+        "eslint-config-prettier": "^6.13.0",
+        "eslint-plugin-react": "^7.0.0",
+        "prettier": "^2.1.2"
+    },
+    "prettier": "@pxblue/prettier-config"
+}