You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

grapesjs-cli

Package Overview
Dependencies
20
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

grapesjs-cli

GrapesJS CLI tool for the plugin development


Version published
Weekly downloads
626
increased by1.95%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

GrapesJS CLI

npm

grapesjs-cli

A simple CLI library for helping in GrapesJS plugin development.

The goal of this package is to avoid the hassle of setting up all the dependencies and configurations for the plugin development by centralizing and speeding up the necessary steps during the process.

  • Fast project scaffolding
  • No need to touch Babel and Webpack configurations

Plugin from 0 to 100

Create a production-ready plugin in a few simple steps.

  • Create a folder for your plugin and init some preliminary steps
mkdir grapesjs-my-plugin
cd grapesjs-my-plugin
npm init -y
git init
  • Install the package
npm i -D grapesjs-cli
  • Init your plugin project by following few steps
npx grapesjs-cli init

You can also skip all the questions with -y option or pass all the answers via options (to see all available options run npx grapesjs-cli init --help)

npx grapesjs-cli init -y --user=YOUR-GITHUB-USERNAME
  • The command will scaffold the src directory and a bunch of other files inside your project. The src/index.js will be the entry point of your plugin. Before starting developing your plugin run the development server and open the printed URL (eg. the default is http://localhost:8080)
npx grapesjs-cli serve

If you need a custom port use the -p option

npx grapesjs-cli serve -p 8081

Under the hood we use webpack-dev-server and you can pass its option via CLI in this way

npx grapesjs-cli serve --devServer='{"https": true}'
  • Once the development is finished you can build your plugin and generate the minified file ready for production
grapesjs-cli build
  • Before publishing your package remember to complete your README.md file with all the available options, components, blocks and so on. For a better user engagement create a simple live demo by using services like JSFiddle CodeSandbox CodePen and link it in your README. To help you in this process we'll print all the necessary HTML/CSS/JS in your README, so it will be just a matter of copy-pasting on some of those services.

Customization

Customize webpack config

If you need to customize the webpack configuration, you can create webpack.config.js file in the root dir of your project and export a function, which should return the new configuration object. Check the example below.

// YOUR-PROJECT-DIR/webpack.config.js

// config is the default configuration
export default ({ config }) => {
    // This is how you can distinguish the `build` command from the `serve`
    const isBuild = config.mode === 'production';

    return {
        ...config,
        module: {
            rules: [ { /* extra rule */ }, ...config.module.rules ],
        },
    };
}

Generic CLI usage

Show all available commands

grapesjs-cli

Show available options for a command

grapesjs-cli COMMAND --help

Run the command

grapesjs-cli COMMAND --OPT1 --OPT2=VALUE

License

MIT

Keywords

FAQs

Package last updated on 30 Aug 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc