bootstrap-mireco - npm Package Compare versions

Comparing version 0.0.3 to 1.0.0

package.json

 {
   "name": "bootstrap-mireco",
-  "version": "0.0.3",
+  "version": "1.0.0",
   "description": "Mireco wrapped in bootstrap styles",
-  "main": "main.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": "[e-mail]:bor3ham/bootstrap-mireco.git",
@@ -11,36 +12,35 @@ "author": "Michael Boreham <[e-mail]>",
   "scripts": {
-    "publish:demo": "git branch -D gh-pages && git push origin --delete gh-pages; git checkout -b gh-pages && cd demo && yarn && yarn build && cd .. && git add . && git add -f demo/dist && git add -f demo/node_modules/uptick-demo-site/dist && git commit -m \"Demo site build\" && git push origin gh-pages && git checkout master && git push origin `git subtree split --prefix demo gh-pages`:gh-pages --force",
-    "build:js": "./node_modules/.bin/webpack --config webpack.build.js",
-    "watch:js": "./node_modules/.bin/webpack --config webpack.dev.js --watch",
-    "build:css": "./node_modules/.bin/stylus src/index.styl -o dist/bootstrap-mireco.css",
-    "watch:css": "./node_modules/.bin/stylus src/index.styl -o dist/bootstrap-mireco.css --watch",
-    "watch": "./node_modules/.bin/concurrently \"npm run watch:js\" \"npm run watch:css\"",
-    "build": "npm run build:js && npm run build:css",
+    "lint": "./node_modules/.bin/eslint \"src/**/*.ts*\"",
+    "build": "node scripts/build.js",
+    "watch": "node scripts/watch.js",
+    "publish:demo": "git branch -D gh-pages && git push origin --delete gh-pages; git checkout -b gh-pages && cd demo && npm install && npm run build && cd .. && git add . && git add -f demo/dist && git add -f demo/node_modules/uptick-demo-site/dist && git commit -m \"Demo site build\" && git push origin gh-pages && git checkout master && git push origin `git subtree split --prefix demo gh-pages`:gh-pages --force",
     "prepare": "npm run build"
   },
-  "dependencies": {
-    "mireco": "^0.1.2"
-  },
   "peerDependencies": {
-    "react": "~16.8.6",
-    "react-dom": "~16.8.6"
+    "react": "^16.8.0 || ^17.0.2 || ^18.2.0",
+    "react-dom": "^16.8.0 || ^17.0.2 || ^18.2.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.6.2",
-    "@babel/plugin-proposal-class-properties": "^7.5.5",
-    "@babel/plugin-proposal-export-default-from": "^7.5.2",
-    "@babel/preset-env": "^7.6.2",
-    "@babel/preset-react": "^7.0.0",
-    "babel-eslint": "^10.0.3",
-    "babel-loader": "^8.0.6",
-    "circular-dependency-plugin": "^5.2.0",
+    "@types/react": "^18.2.7",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
     "concurrently": "^5.2.0",
-    "eslint": "^6.4.0",
-    "eslint-plugin-react": "^7.14.3",
-    "peer-deps-externals-webpack-plugin": "^1.0.4",
-    "stylus": "^0.54.7",
-    "webpack": "^4.41.6",
-    "webpack-bundle-analyzer": "^3.6.0",
-    "webpack-cli": "^3.3.11"
+    "deep-equal": "^2.2.1",
+    "esbuild": "^0.17.19",
+    "esbuild-stylus-loader": "^0.4.2",
+    "eslint": "^8.42.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "classnames": "^2.3.2",
+    "mireco": "^1.0.5"
   }
 }

README.md

@@ -1,2 +0,34 @@
-# bootstrap-mireco
-Mireco wrapped in bootstrap styles
+# Bootstrap Mireco
+
+Mireco pre-wrapped in bootstrap styles for your convenience.
+
+Check out the [live demo demo page here][1].
+
+For more information on Mireco, head over to its [project page here][2].
+
+## Installation
+
+- Install bootstrap in your project, ensuring that the bootstrap css is loaded
+- Install this package using your package manager of choice eg: `npm install bootstrap-mireco`
+- Load the release css file `node_modules/bootstrap-mireco/dist/index.css` in your project
+- Use like you would mireco:
+
+```
+import React, { useState } from 'react'
+import { Text } from 'bootstrap-mireco'
+
+export const Form = () => {
+  const [name, setName] = useState('')
+  return (
+    <Text
+      value={name}
+      onChange={setName}
+      placeholder="Enter your name"
+      block
+    />
+  )
+}
+```
+
+[1]: https://bor3ham.github.io/bootstrap-mireco/
+[2]: https://github.com/bor3ham/mireco/

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

940857

increased by510.18%

Number of package files

67

increased by737.5%

Lines of code

982

increased by414.14%

Number of low quality alerts

1

decreased by-66.67%

Number of lines in readme file

35

increased by1066.67%

Worsened metrics

Dependency count

4

increased by33.33%

Dev dependency count

17

increased by6.25%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedclassnames@^2.3.2

• + Addedmireco@1.1.0(transitive)

• + Addedparse-duration@1.1.1(transitive)

• + Addedreact@18.3.1(transitive)

• + Addedreact-dom@18.3.1(transitive)

• + Addedscheduler@0.23.2(transitive)

• - Removedmireco@0.1.2(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedparse-duration@0.1.3(transitive)

• - Removedprop-types@15.8.1(transitive)

• - Removedreact@16.8.6(transitive)

• - Removedreact-dom@16.8.6(transitive)

• - Removedreact-is@16.13.1(transitive)

• - Removedscheduler@0.13.6(transitive)

• Updatedmireco@^1.0.5