|
| 1 | +# GrapesJS CLI |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/grapesjs-cli) |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +A simple CLI library for helping in GrapesJS plugin development. |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +- Fast project scaffolding |
| 12 | +- No need to touch Babel and Webpack configurations |
| 13 | + |
| 14 | +## Plugin from 0 to 100 |
| 15 | + |
| 16 | +Create a production-ready plugin in a few simple steps. |
| 17 | + |
| 18 | +- Create a folder for your plugin and init some preliminary steps |
| 19 | + |
| 20 | +```sh |
| 21 | +mkdir grapesjs-my-plugin |
| 22 | +cd grapesjs-my-plugin |
| 23 | +npm init -y |
| 24 | +git init |
| 25 | +``` |
| 26 | + |
| 27 | +- Install the package |
| 28 | + |
| 29 | +```sh |
| 30 | +npm i -D grapesjs-cli |
| 31 | +``` |
| 32 | + |
| 33 | +- Init your plugin project by following few steps |
| 34 | + |
| 35 | +```sh |
| 36 | +npx grapesjs-cli init |
| 37 | +``` |
| 38 | + |
| 39 | +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`) |
| 40 | + |
| 41 | +```sh |
| 42 | +npx grapesjs-cli init -y --user=YOUR-GITHUB-USERNAME |
| 43 | +``` |
| 44 | + |
| 45 | +- 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) |
| 46 | + |
| 47 | +```sh |
| 48 | +npx grapesjs-cli serve |
| 49 | +``` |
| 50 | + |
| 51 | +If you need a custom port use the `-p` option |
| 52 | + |
| 53 | +```sh |
| 54 | +npx grapesjs-cli serve -p 8081 |
| 55 | +``` |
| 56 | + |
| 57 | +Under the hood we use `webpack-dev-server` and you can pass its option via CLI in this way |
| 58 | + |
| 59 | +```sh |
| 60 | +npx grapesjs-cli serve --devServer='{"https": true}' |
| 61 | +``` |
| 62 | + |
| 63 | +- Once the development is finished you can build your plugin and generate the minified file ready for production |
| 64 | + |
| 65 | +```sh |
| 66 | +npx grapesjs-cli build |
| 67 | +``` |
| 68 | + |
| 69 | +- Before publishing your package remember to complete your README.md file with all the available options, components, blocks and so on. |
| 70 | + For a better user engagement create a simple live demo by using services like [JSFiddle](https://jsfiddle.net) [CodeSandbox](https://codesandbox.io) [CodePen](https://codepen.io) 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. |
| 71 | + |
| 72 | +## Customization |
| 73 | + |
| 74 | +### Customize webpack config |
| 75 | + |
| 76 | +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. |
| 77 | + |
| 78 | +```js |
| 79 | +// YOUR-PROJECT-DIR/webpack.config.js |
| 80 | + |
| 81 | +// config is the default configuration |
| 82 | +export default ({ config }) => { |
| 83 | + // This is how you can distinguish the `build` command from the `serve` |
| 84 | + const isBuild = config.mode === 'production'; |
| 85 | + |
| 86 | + return { |
| 87 | + ...config, |
| 88 | + module: { |
| 89 | + rules: [ |
| 90 | + { |
| 91 | + /* extra rule */ |
| 92 | + }, |
| 93 | + ...config.module.rules, |
| 94 | + ], |
| 95 | + }, |
| 96 | + }; |
| 97 | +}; |
| 98 | +``` |
| 99 | + |
| 100 | +## Generic CLI usage |
| 101 | + |
| 102 | +Show all available commands |
| 103 | + |
| 104 | +```sh |
| 105 | +grapesjs-cli |
| 106 | +``` |
| 107 | + |
| 108 | +Show available options for a command |
| 109 | + |
| 110 | +```sh |
| 111 | +grapesjs-cli COMMAND --help |
| 112 | +``` |
| 113 | + |
| 114 | +Run the command |
| 115 | + |
| 116 | +```sh |
| 117 | +grapesjs-cli COMMAND --OPT1 --OPT2=VALUE |
| 118 | +``` |
| 119 | + |
| 120 | +## License |
| 121 | + |
| 122 | +MIT |
0 commit comments