@chainfuse/ui - npm Package Compare versions

Comparing version 0.0.11 to 0.0.12

package.json

 {
   "name": "@chainfuse/ui",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "packageManager": "yarn@4.0.0-rc.12",
   "description": "UI components for ChainFuse.io",
-  "license": "MIT",
-  "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gapon2401/my-react-typescript-package.git"
+  },
   "scripts": {
-    "clean": "rm -rf dist",
-    "build": "npm run clean && tsc && cp package.json README.md yarn.lock ./dist && yarn build:cjs",
+    "build": "yarn build:esm && yarn build:cjs",
+    "build:esm": "tsc",
     "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "lint": "eslint \"{**/*,*}.{js,ts,jsx,tsx}\"",
+    "prettier": "prettier --write \"{src,tests,example/src}/**/*.{js,ts,jsx,tsx}\"",
+    "test": "jest --config jestconfig.json",
     "prepare": "npm run build",
     "prepublishOnly": "npm test && npm run prettier && npm run lint"
   },
-  "devDependencies": {
-    "@jest/globals": "^28.1.3",
-    "@types/jest": "^28.1.6",
-    "@types/react": "^18",
-    "typescript": "^4.7.4"
+  "peerDependencies": {
+    "react": ">=16"
   },
-  "dependencies": {
-    "react": "^18.2.0"
-  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "keywords": [
     "react",
-    "chainfuse",
-    "web3",
-    "nft",
-    "nfts",
-    "blockchain",
-    "ethereum"
-  ]
+    "typescript",
+    "awesome-project"
+  ],
+  "author": "Igor Gaponov (gapon2401)",
+  "license": "MIT",
+  "devDependencies": {
+    "@testing-library/react": "^13.3.0",
+    "@types/jest": "^28.1.1",
+    "@types/react": "^18.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.27.1",
+    "@typescript-eslint/parser": "^5.27.1",
+    "eslint": "^8.17.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.30.0",
+    "eslint-plugin-react-hooks": "^4.5.0",
+    "jest": "^28.1.1",
+    "jest-canvas-mock": "^2.4.0",
+    "jest-environment-jsdom": "^28.1.1",
+    "prettier": "^2.6.2",
+    "react": "^18.1.0",
+    "react-dom": "^18.1.0",
+    "ts-jest": "^28.0.4",
+    "typescript": "^4.7.3"
+  }
 }

README.md

@@ -1,1 +0,60 @@
-# `@chainfuse/ui`
+# my-react-typescript-package
+
+[![NPM version][npm-image]][npm-url]
+[![Build][github-build]][github-build-url]
+![npm-typescript]
+[![License][github-license]][github-license-url]
+
+This repo is the example of the article ["How to create and publish React Typescript npm package with demo and automated build"](https://medium.com/@igaponov/how-to-create-and-publish-react-typescript-npm-package-with-demo-and-automated-build-80c40ec28aca).
+
+You can clone it and step by step create your own NPM package and publish it.
+
+It is simple React counter.
+
+[**Live Demo**](https://gapon2401.github.io/my-react-typescript-package/)
+
+## Installation:
+
+```bash
+npm install my-react-typescript-package --save-dev
+```
+
+or
+
+```bash
+yarn add -D my-react-typescript-package
+```
+
+## Usage :
+
+Add `MyCounter` to your component:
+
+```js
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import { MyCounter } from 'my-react-typescript-package'
+
+const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)
+root.render(
+    <React.StrictMode>
+        <div>
+            <h2>Default counter</h2>
+            <MyCounter />
+        </div>
+        <hr />
+        <div>
+            <h2>Counter with predefined value</h2>
+            <MyCounter value={5} />
+        </div>
+    </React.StrictMode>,
+)
+
+```
+
+[npm-url]: https://www.npmjs.com/package/my-react-typescript-package
+[npm-image]: https://img.shields.io/npm/v/my-react-typescript-package
+[github-license]: https://img.shields.io/github/license/gapon2401/my-react-typescript-package
+[github-license-url]: https://github.com/gapon2401/my-react-typescript-package/blob/master/LICENSE
+[github-build]: https://github.com/gapon2401/my-react-typescript-package/actions/workflows/publish.yml/badge.svg
+[github-build-url]: https://github.com/gapon2401/my-react-typescript-package/actions/workflows/publish.yml
+[npm-typescript]: https://img.shields.io/npm/types/my-react-typescript-package

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

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

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8931

increased by81.38%

Number of package files

16

increased by14.29%

Number of low maintenance alerts

1

decreased by-50%

Number of lines in readme file

60

increased by2900%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

18

increased by350%

Is type module

No

Dependency changes

• - Removedreact@^18.2.0