@vivareal/lina-icons - npm Package Compare versions

Comparing version 0.1.1-alpha.2 to 0.2.0-alpha.1

package.json

 {
   "name": "@vivareal/lina-icons",
-  "version": "0.1.1-alpha.2+7abd83d",
-  "description": "Icons of Lina design system",
-  "author": "Bruno Santos <[e-mail]>",
+  "version": "0.2.0-alpha.1",
+  "description": "> TODO: description",
+  "author": "Grupo ZAP Frontend team <[e-mail]>",
   "homepage": "",
   "license": "ISC",
-  "main": "main.js",
+  "main": "dist/main.js",
+  "module": "dist/main.esm.js",
   "files": [
-    "*.svg"
+    "dist/"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1",
-    "build": "rimraf dist/* && webpack",
-    "clean": "rimraf *.svg main.js",
-    "prepare": "lerna run build",
-    "prepublishOnly": "cp -r ./dist/* .",
-    "postpublish": "lerna run clean"
+    "build:svg": "svgo --config svgo.config.json -f ./src/images -o ./dist/images -q",
+    "build:generate-index-file": "node scripts/generate-index-file.js",
+    "prebuild": "rm -rf dist && yarn run build:generate-index-file && yarn run build:svg",
+    "build": "rollup -c ./rollup.config.js",
+    "docs:copy-svg": "cp -r ./dist/images ./docs/.vuepress/dist/",
+    "docs:zip-icons": "cd ./dist/images/ && bestzip ../../docs/.vuepress/dist/icons.zip *.svg",
+    "docs:dev": "yarn run build && vuepress dev docs",
+    "docs:build": "yarn run build && vuepress build docs && yarn run docs:copy-svg && yarn run docs:zip-icons",
+    "docs:deploy": "bash scripts/deploy-docs.sh lina-icons.grupozap.com"
   },
-  "gitHead": "7abd83d98cccd814603853300b6bfbd5202d2308"
+  "devDependencies": {
+    "bestzip": "^2.1.5",
+    "rollup": "^2.0.6",
+    "rollup-plugin-svgo": "^1.1.0",
+    "svgo": "^1.3.2",
+    "vuepress": "^1.4.0"
+  },
+  "gitHead": "bb4926bc49094b348ddf368dda9b3cde834f69ca"
 }

README.md

@@ -1,11 +0,32 @@
-# `@vivareal/lina-icons`
+# @vivareal/lina-icons
 
-> Icons of Lina design system
+The design system iconography
 
-## Usage
+### Installing
 
 ```
-const linaIcons = require('@vivareal/lina-icons');
+lerna bootstrap
+```
 
-// TODO: DEMONSTRATE API
+### Usage
+
+With `add` being one of the available icons:
+
 ```
+import { add } from "@vivareal/lina-icons"
+```
+
+`add` will be the svg markup.
+
+### Add a new icon
+
+Add the svg file to `src/images` folder.
+
+### Build the project
+
+```
+yarn run build
+```
+
+This will run `svgo` to optimize the icons and write them to `dist/images` folder.
+Also, it will use `rollup` to bundle the icons together and export them as `cjs` and `esm` to be later imported and tree shook by the consumer project.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

208029

increased by9949.71%

Number of package files

117

increased by2825%

Lines of code

703

increased byInfinity%

Number of lines in readme file

33

increased by175%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

5

increased byInfinity%

No dependency changes