grapesjs-preset-webpage - npm Package Compare versions

Comparing version 0.1.11 to 1.0.1

package.json

 {
   "name": "grapesjs-preset-webpage",
-  "version": "0.1.11",
+  "version": "1.0.1",
   "description": "GrapesJS Plugin Webpage Preset",
-  "main": "dist/grapesjs-preset-webpage.min.js",
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
   "scripts": {
-    "lint": "eslint src",
-    "v:patch": "npm version --no-git-tag-version patch",
-    "build": "npm run v:patch && webpack --env.production && npm run build:css",
-    "start": "webpack-dev-server --open --progress --colors & npm run build:css -- -w",
-    "build:css": "node-sass src/style/main.scss dist/grapesjs-preset-webpage.min.css --output-style compressed"
+    "build": "grapesjs-cli build",
+    "start": "grapesjs-cli serve"
   },
@@ -26,33 +26,6 @@ "repository": {
   "license": "BSD-3-Clause",
-  "babel": {
-    "presets": [
-      "env"
-    ],
-    "plugins": [
-      "transform-object-rest-spread"
-    ]
-  },
-  "peerDependencies": {
-    "grapesjs": "0.x"
-  },
   "devDependencies": {
-    "babel-core": "^6.26.0",
-    "babel-loader": "^7.1.4",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-preset-env": "^1.6.1",
-    "eslint": "^4.19.1",
-    "html-webpack-plugin": "^2.30.1",
-    "node-sass": "^4.8.3",
-    "webpack": "^3.11.0",
-    "webpack-dev-server": "^2.11.2"
-  },
-  "dependencies": {
-    "grapesjs-aviary": "^0.1.2",
-    "grapesjs-blocks-basic": "^0.1.7",
-    "grapesjs-component-countdown": "^0.1.2",
-    "grapesjs-navbar": "^0.1.5",
-    "grapesjs-plugin-export": "^0.1.5",
-    "grapesjs-plugin-filestack": "^0.1.1",
-    "grapesjs-plugin-forms": "^0.3.5"
+    "grapesjs": "^0.19.5",
+    "grapesjs-cli": "^3.0.1"
   }
 }

README.md

 # GrapesJS Preset Webpage
 
+[Demo](http://grapesjs.com/demo.html)
+
+> From the v1.* we don't include other plugins in this one anymore, so if you need them, you have to include them manually in your project. If you want to replicate the editor from the demo, please check the source of the demo [here](https://github.com/artf/grapesjs/blob/gh-pages/demo.html)
+
 ## Summary
 
-* Plugin name: **`gjs-preset-webpage`**
-* Includes:
-  * `grapesjs-blocks-basic` Basic set of blocks
-  * `grapesjs-navbar` Simple navbar component
-  * `grapesjs-component-countdown` Simple countdown component
-  * `grapesjs-plugin-forms` Set of form components and blocks
-  * `grapesjs-aviary` Add the Aviary Image Editor
-  * `grapesjs-plugin-filestack` Add Filestack uploader in Asset Manager
-  * `grapesjs-plugin-export` Export GrapesJS templates in a zip archive
+* Plugin name: **`grapesjs-preset-webpage`**
 * Commands:
@@ -30,2 +26,3 @@ * `gjs-open-import-webpage` Opens a modal for the import
 | `blocks` | Which blocks to add | `['link-block', 'quote', 'text-basic']` |
+|`block`| Add custom block options, based on block id|`(blockId) => ({})`|
 | `modalImportTitle` | Modal import title | `'Import'` |
@@ -38,27 +35,18 @@ | `modalImportButton` | Modal import button text | `'Import'` |
 | `showStylesOnChange` | Show the Style Manager on component change | `true` |
-| `textGeneral` | Text for General sector in Style Manager | `'General'` |
-| `textLayout` | Text for Layout sector in Style Manager | `'Layout'` |
-| `textTypography` | Text for Typography sector in Style Manager | `'Typography'` |
-| `textDecorations` | Text for Decorations sector in Style Manager | `'Decorations'` |
-| `textExtra` | Text for Extra sector in Style Manager | `'Extra'` |
-| `customStyleManager` | Use custom set of sectors for the Style Manager | `[]` |
-| `blocksBasicOpts` | `grapesjs-blocks-basic` plugin options. By setting this option to `false` will avoid loading the plugin | `{}` |
-| `navbarOpts` | `grapesjs-navbar` plugin options. By setting this option to `false` will avoid loading the plugin | `{}` |
-| `countdownOpts` | `grapesjs-component-countdown` plugin options. By setting this option to `false` will avoid loading the plugin | `{}` |
-| `formsOpts` | `grapesjs-plugin-forms` plugin options. By setting this option to `false` will avoid loading the plugin | `{}` |
-| `exportOpts` | `grapesjs-plugin-export` plugin options. By setting this option to `false` will avoid loading the plugin | `{}` |
-| `aviaryOpts` | `grapesjs-aviary` plugin options. Aviary library should be included manually. By setting this option to `false` will avoid loading the plugin | `false` |
-| `filestackOpts` | `grapesjs-plugin-filestack` plugin options. Filestack library should be included manually. By setting this option to `false` will avoid loading the plugin | `false` |
+| `useCustomTheme` | Load custom preset theme | `true` |
 
 ## Download
 
-```sh
-$ npm i grapesjs-preset-webpage
-```
+* CDN
+  * `https://unpkg.com/grapesjs-preset-webpage`
+* NPM
+  * `npm i grapesjs-preset-webpage`
+* GIT
+  * `git clone https://github.com/artf/grapesjs-preset-webpage.git`
 
 ## Usage
 
+Directly in the browser
 ```html
 <link href="path/to/grapes.min.css" rel="stylesheet"/>
-<link href="path/to/grapesjs-preset-webpage.min.css" rel="stylesheet"/>
 <script src="path/to/grapes.min.js"></script>
@@ -73,5 +61,5 @@ <script src="path/to/grapesjs-preset-webpage.min.js"></script>
       ...
-      plugins: ['gjs-preset-webpage'],
+      plugins: ['grapesjs-preset-webpage'],
       pluginsOpts: {
-        'gjs-preset-webpage': {
+        'grapesjs-preset-webpage': {
           // options
@@ -84,2 +72,21 @@ }
 
+Modern javascript
+```js
+import grapesjs from 'grapesjs';
+import plugin from 'grapesjs-preset-webpage';
+
+const editor = grapesjs.init({
+  container : '#gjs',
+  // ...
+  plugins: [plugin],
+  pluginsOpts: {
+    [plugin]: { /* options */ }
+  }
+  // or
+  plugins: [
+    editor => plugin(editor, { /* options */ }),
+  ],
+});
+```
+
 ## Development
@@ -90,6 +97,7 @@
 ```sh
-$ git clone [e-mail]:artf/grapesjs-preset-webpage.git && cd grapesjs-preset-webpage
+$ git clone https://github.com/artf/grapesjs-preset-webpage.git
+$ cd grapesjs-blocks-basic
 ```
 
-Install dependencies
+Install it
 
@@ -100,12 +108,12 @@ ```sh
 
-The plugin relies on GrapesJS via `peerDependencies`, so you have to install it manually (without adding it to package.json)
+Start the dev server
 
 ```sh
-$ npm i grapesjs --no-save
+$ npm start
 ```
 
-Start the dev server
+Build before the commit. This will also increase the patch level version of the package
 
 ```sh
-$ npm start
+$ npm run build
 ```
@@ -112,0 +120,0 @@

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

Fixed alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 2 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

Dependency count

0

-100%

Dev dependency count

2

-77.78%

Number of low quality alerts

1

-66.67%

Number of lines in readme file

118

7.27%

Number of low supply chain risk alerts

0

-100%

Number of medium supply chain risk alerts

1

-87.5%

Worsened metrics

Total package byte prevSize

41701

-81.7%

Number of package files

6

-64.71%

Lines of code

102

-91.2%

Dependency changes

• - Removed

  grapesjs-aviary@^0.1.2

• - Removed

  grapesjs-blocks-basic@^0.1.7

• - Removed

  grapesjs-component-countdown@^0.1.2

• - Removed

  grapesjs-navbar@^0.1.5

• - Removed

  grapesjs-plugin-export@^0.1.5

• - Removed

  grapesjs-plugin-filestack@^0.1.1

• - Removed

  grapesjs-plugin-forms@^0.3.5

• - Removed

  @types/backbone@1.4.15
  (transitive)

• - Removed

  @types/jquery@3.5.32
  (transitive)

• - Removed

  @types/sizzle@2.3.9
  (transitive)

• - Removed

  @types/underscore@1.13.0
  (transitive)

• - Removed

  backbone@1.4.1
  (transitive)

• - Removed

  backbone-undo@0.2.6
  (transitive)

• - Removed

  codemirror@5.63.0
  (transitive)

• - Removed

  codemirror-formatting@1.0.0
  (transitive)

• - Removed

  core-util-is@1.0.3
  (transitive)

• - Removed

  file-saver@1.3.8
  (transitive)

• - Removed

  grapesjs@0.22.6
  (transitive)

• - Removed

  grapesjs-aviary@0.1.2
  (transitive)

• - Removed

  grapesjs-blocks-basic@0.1.8
  (transitive)

• - Removed

  grapesjs-component-countdown@0.1.3
  (transitive)

• - Removed

  grapesjs-navbar@0.1.5
  (transitive)

• - Removed

  grapesjs-plugin-export@0.1.5
  (transitive)

• - Removed

  grapesjs-plugin-filestack@0.1.1
  (transitive)

• - Removed

  grapesjs-plugin-forms@0.3.6
  (transitive)

• - Removed

  html-entities@1.4.0
  (transitive)

• - Removed

  immediate@3.0.6
  (transitive)

• - Removed

  inherits@2.0.4
  (transitive)

• - Removed

  isarray@1.0.0
  (transitive)

• - Removed

  jszip@3.10.1
  (transitive)

• - Removed

  lie@3.3.0
  (transitive)

• - Removed

  pako@1.0.11
  (transitive)

• - Removed

  process-nextick-args@2.0.1
  (transitive)

• - Removed

  promise-polyfill@8.3.0
  (transitive)

• - Removed

  readable-stream@2.3.8
  (transitive)

• - Removed

  safe-buffer@5.1.2
  (transitive)

• - Removed

  setimmediate@1.0.5
  (transitive)

• - Removed

  string_decoder@1.1.1
  (transitive)

• - Removed

  underscore@1.13.1
  (transitive)

• - Removed

  util-deprecate@1.0.2
  (transitive)