@harlem/plugin-devtools - npm Package Compare versions

Comparing version 2.0.0-beta.10 to 2.0.0

dist/esm/index.js

@@ -12,5 +12,9 @@ // src/constants.ts
 import {
-  EVENTS
+  EVENTS,
+  INTERNAL
 } from "@harlem/core";
 import {
+  omit
+} from "@harlem/utilities";
+import {
   setupDevtoolsPlugin
@@ -56,3 +60,3 @@ } from "@vue/devtools-api";
         key: store.name,
-        value: store.state,
+        value: omit(store.state, INTERNAL.pattern),
         editable: true,
@@ -59,0 +63,0 @@ objectType: "reactive"

dist/iife/index.js

@@ -48,2 +48,3 @@ var HarlemDevtoolsPlugin = (() => {
   var import_core = __toModule(__require("@harlem/core"));
+  var import_utilities = __toModule(__require("@harlem/utilities"));
   var import_devtools_api = __toModule(__require("@vue/devtools-api"));
@@ -88,3 +89,3 @@ function stringComparitor(valueA, valueB) {
           key: store.name,
-          value: store.state,
+          value: (0, import_utilities.omit)(store.state, import_core.INTERNAL.pattern),
           editable: true,
@@ -91,0 +92,0 @@ objectType: "reactive"

dist/index.js

@@ -13,5 +13,9 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/constants.ts
 
+
 var _core = require('@harlem/core');
 
 
+var _utilities = require('@harlem/utilities');
+
+
 var _devtoolsapi = require('@vue/devtools-api');
@@ -56,3 +60,3 @@ function stringComparitor(valueA, valueB) {
         key: store.name,
-        value: store.state,
+        value: _utilities.omit.call(void 0, store.state, _core.INTERNAL.pattern),
         editable: true,
@@ -59,0 +63,0 @@ objectType: "reactive"

package.json

 {
     "name": "@harlem/plugin-devtools",
     "amdName": "harlemDevtools",
-    "version": "2.0.0-beta.10",
+    "version": "2.0.0",
     "license": "MIT",
@@ -42,11 +42,12 @@ "author": "Andrew Courtice <[e-mail]>",
     "peerDependencies": {
-        "@harlem/core": "^2.0.0-alpha.0"
+        "@harlem/core": "^2.0.0"
     },
     "dependencies": {
+        "@harlem/utilities": "^2.0.0",
         "@vue/devtools-api": "^6.0.0-beta.15"
     },
     "devDependencies": {
-        "@harlem/core": "^2.0.0-beta.10"
+        "@harlem/core": "^2.0.0"
     },
-    "gitHead": "b27b1b46a3464593edbfb9dc15c1a9b142c6862c"
+    "gitHead": "08c19b9a416c273807b488884af1d8cc35ff5969"
 }

README.md

@@ -1,7 +0,1 @@
-<p align="center">
-    <a href="https://harlemjs.com">
-        <img src="https://raw.githubusercontent.com/andrewcourtice/harlem/main/docs/src/.vuepress/public/assets/images/logo-192.svg" alt="Harlem"/>
-    </a>
-</p>
-
 # Harlem Devtools Plugin
@@ -15,26 +9,17 @@
 
-<!-- TOC -->
-
-- [Getting started](#getting-started)
-- [Options](#options)
-- [Known issues](#known-issues)
-
-<!-- /TOC -->
-
 ![Harlem Devtools](https://user-images.githubusercontent.com/11718453/95668309-aa5ade00-0bb5-11eb-99f5-1fea4d2061ff.gif)
 
-## Getting started
+## Installation
 
 Before installing the devtools plugin make sure you installed `@harlem/core`.
 
-1. Install `@harlem/plugin-devtools`:
-```
+```bash
+yarn add @harlem/plugin-devtools
+# or
 npm install @harlem/plugin-devtools
 ```
-Or if you're using Yarn:
-```
-yarn add @harlem/plugin-devtools
-```
 
-2. Create an instance of the plugin and register it with Harlem:
+## Usage
+
+Create an instance of the plugin and register it with Harlem:
 ```typescript
@@ -44,11 +29,11 @@ import App from './app.vue';
 import harlem from '@harlem/core';
-import createDevtoolsPlugin from '@harlem/plugin-devtools';
+import devtoolsPlugin from '@harlem/plugin-devtools';
 
-const devtoolsPlugin = createDevtoolsPlugin({
-    label: 'My State'
-});
-
 createApp(App)
     .use(harlem, {
-        plugins: [devtoolsPlugin]
+        plugins: [
+            devtoolsPlugin({
+                label: 'My State'
+            })
+        ]
     })
@@ -61,11 +46,7 @@ .mount('#app');
 
-## Options
+### Options
 
-- **label** (string?): The name that will appear in the Vue devtools pane. The default is 'Harlem'.
-- **color** (number?): A Hexadecimal number indicating the color to be used on the timeline for Harlem events. The default is `0x40c48d`.
+- **label**: `string?` - the name that will appear in the Vue devtools pane. The default is 'Harlem'.
+- **color**: `number?` - a Hexadecimal number indicating the color to be used on the timeline for Harlem events. The default is `0x40c48d`.
 
-*(?) indicates an optional field*
-
-
-## Known issues
-There is currently an issue where the devtools may not show your stores the first time they are opened. Simply hit the refresh button in the top right of the devtools to force it to show your stores/state.
+*(?) indicates an optional field*

src/index.ts

@@ -10,5 +10,10 @@ import {
     EVENTS,
+    INTERNAL,
 } from '@harlem/core';
 
 import {
+    omit,
+} from '@harlem/utilities';
+
+import {
     PluginDescriptor,
@@ -88,3 +93,3 @@ setupDevtoolsPlugin,
                 key: store.name,
-                value: store.state,
+                value: omit(store.state, INTERNAL.pattern),
                 editable: true,
@@ -91,0 +96,0 @@ objectType: 'reactive',

Fixed alerts

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

60408

increased by0.27%

Lines of code

862

increased by1.17%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Dependency count

3

increased by50%

Number of lines in readme file

49

decreased by-28.99%

Dependency changes

• + Added@harlem/utilities@^2.0.0