@sourcesync/quasar-app-extension-sharing - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@sourcesync/quasar-app-extension-sharing",
-  "version": "1.0.0",
-  "description": "Social sharing extension for quasar",
-  "main": "ui/index.js\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D\u001b[D./ui.index.js",
+  "version": "1.0.1",
+  "author": "[e-mail]",
+  "description": "Quasar extension for social media links",
+  "license": "MIT",
+  "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "cd dev && yarn dev && cd ..",
+    "dev:umd": "yarn build && node build/script.open-umd.js",
+    "dev:ssr": "cd dev && yarn 'dev:ssr' && cd ..",
+    "dev:ios": "cd dev && yarn 'dev:ios' && cd ..",
+    "dev:android": "cd dev && yarn 'dev:android' && cd ..",
+    "dev:electron": "cd dev && yarn 'dev:electron' && cd ..",
+    "build": "node build/index.js",
+    "build:js": "node build/script.javascript.js",
+    "build:css": "node build/script.css.js",
+    "lint": "eslint --ext .js,.vue src",
+    "lint-fix": "eslint --ext .js,.vue src --fix"
   },
@@ -13,14 +25,38 @@ "repository": {
   },
-  "keywords": [
-    "social",
-    "share",
-    "quasar",
-    "extension"
-  ],
-  "author": "[e-mail]",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/Source-Digital/quasar-app-extension-sharing/issues"
   },
-  "homepage": "https://github.com/Source-Digital/quasar-app-extension-sharing#readme"
+  "homepage": "https://github.com/Source-Digital/quasar-app-extension-sharing",
+  "devDependencies": {
+    "@rollup/plugin-buble": "^0.20.0",
+    "@rollup/plugin-json": "^4.0.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
+    "autoprefixer": "^10.0.2",
+    "@vue/eslint-config-standard": "^5.1.2",
+    "babel-eslint": "^10.1.0",
+    "chalk": "^4.1.0",
+    "cssnano": "^4.1.10",
+    "eslint": "^7.15.0",
+    "eslint-loader": "^4.0.2",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.1.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-quasar": "^1.0.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "eslint-plugin-vue": "^7.2.0",
+    "fs-extra": "^8.1.0",
+    "open": "^7.3.0",
+    "postcss": "^8.1.9",
+    "quasar": "^1.0.0",
+    "rimraf": "^3.0.0",
+    "rollup": "^2.33.3",
+    "rtlcss": "^2.6.1",
+    "sass": "^1.29.0",
+    "uglify-es": "^3.3.9",
+    "zlib": "^1.0.5"
+  },
+  "browserslist": [
+    "last 1 version, not dead, ie >= 11"
+  ]
 }

README.md

@@ -1,12 +0,132 @@
-<img src="https://img.shields.io/npm/v/@sourcesync/quasar-ui-sharing.svg?label=@sourcesync/quasar-ui-sharing">
-<img src="https://img.shields.io/npm/v/@sourcesync/quasar-app-extension-sharing.svg?label=@sourcesync/quasar-app-extension-sharing">
+# Component Sharing
 
-# Structure
-* [/ui](ui) - standalone npm package
-* [/app-extension](app-extension) - Quasar app extension
+[![npm](https://img.shields.io/npm/v/@sourcesync/quasar-ui-quasar-ui-sharing.svg?label=@sourcesync/quasar-ui-quasar-ui-sharing)](https://www.npmjs.com/package/@sourcesync/quasar-ui-quasar-ui-sharing)
+[![npm](https://img.shields.io/npm/dt/@sourcesync/quasar-ui-quasar-ui-sharing.svg)](https://www.npmjs.com/package/@sourcesync/quasar-ui-quasar-ui-sharing)
 
+# Component Sharing
+> Short description of the component
+
+
+# Usage
+
+## Quasar CLI project
+
+Install the [App Extension](../app-extension).
+
+**OR**:
+
+Create and register a boot file:
+
+```js
+import Vue from 'vue'
+import Plugin from '@sourcesync/quasar-ui-sharing'
+import '@sourcesync/quasar-ui-sharing/dist/index.css'
+
+Vue.use(Plugin)
+```
+
+**OR**:
+
+```html
+<style src="@sourcesync/quasar-ui-sharing/dist/index.css"></style>
+
+<script>
+import { Component as Sharing } from '@sourcesync/-quasar-ui-sharing'
+
+export default {
+  components: {
+    Sharing
+  }
+}
+</script>
+```
+
+## Vue CLI project
+
+```js
+import Vue from 'vue'
+import Plugin from '@sourcesync/quasar-ui-sharing'
+import '@sourcesync/-quasar-ui-sharing/dist/index.css'
+
+Vue.use(Plugin)
+```
+
+**OR**:
+
+```html
+<style src="@sourcesync/quasar-ui-sharing/dist/index.css"></style>
+
+<script>
+import { Component as Sharing } from '@sourcesync/quasar-ui-sharing'
+
+export default {
+  components: {
+    Sharing
+  }
+}
+</script>
+```
+
+## UMD variant
+
+Exports `window.sharing`.
+
+Add the following tag(s) after the Quasar ones:
+
+```html
+<head>
+  <!-- AFTER the Quasar stylesheet tags: -->
+  <link href="https://cdn.jsdelivr.net/npm/@sourcesync/quasar-ui-sharing/dist/index.min.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+  <!-- at end of body, AFTER Quasar script(s): -->
+  <script src="https://cdn.jsdelivr.net/npm/@sourcesync/quasar-ui-sharing/dist/index.umd.min.js"></script>
+</body>
+```
+If you need the RTL variant of the CSS, then go for the following (instead of the above stylesheet link):
+```html
+<link href="https://cdn.jsdelivr.net/npm/@sourcesync/quasar-ui-sharing/dist/index.rtl.min.css" rel="stylesheet" type="text/css">
+```
+
+# Setup
+```bash
+$ yarn
+```
+
+# Developing
+```bash
+# start dev in SPA mode
+$ yarn dev
+
+# start dev in UMD mode
+$ yarn dev:umd
+
+# start dev in SSR mode
+$ yarn dev:ssr
+
+# start dev in Cordova iOS mode
+$ yarn dev:ios
+
+# start dev in Cordova Android mode
+$ yarn dev:android
+
+# start dev in Electron mode
+$ yarn dev:electron
+```
+
+# Building package
+```bash
+$ yarn build
+```
+
+# Adding Testing Components
+in the `ui/dev/src/pages` you can add Vue files to test your component/directive. When using `yarn dev` to build the UI, any pages in that location will automatically be picked up by dynamic routing and added to the test page.
+
+# Adding Assets
+If you have a component that has assets, like language or icon-sets, you will need to provide these for UMD. In the `ui/build/script.javascript.js` file, you will find a couple of commented out commands that call `addAssets`. Uncomment what you need and add your assets to have them be built and put into the `ui/dist` folder.
+
 # Donate
-If you appreciate the work that went into this project, please consider [donating to Quasar](https://donate.quasar.dev).
+If you appreciate the work that went into this, please consider [donating to Quasar](https://donate.quasar.dev).
 
 # License
 MIT (c) 2020 Source Digital <[e-mail]>

New alerts

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

133

increased by923.08%

Worsened metrics

Total package byte prevSize

11976

decreased by-31.29%

Dev dependency count

27

increased byInfinity%

Number of package files

14

decreased by-30%

Lines of code

152

decreased by-12.14%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes