Skip to content

Directory structure

eWizard CLI creates the files and directories after you initialize a block.

The eWizard.js project has a robust directory structure. We strongly recommend sticking to it during the development process.

.
├─.ewizard/
|  └─settings.json
├─.gitignore
├─icon.png
├─index.vue
├─package-lock.json
├─package.json
└─settings.json

Let's take a closer look at the directories and files.

The project directory structure may differ depending on the selected project template and initialization options.

Source file or directoryDescription
.ewizard/settings.jsonThe .ewizard/settings.json specifies the project template type, the path configuration for all the directories, plugin settings, and the template repository.
.gitignoreSpecifies the files and directories that are not synced with Git.
index.vueContains the block markup.
package.jsonStores general information about the project and contains the list of project npm dependencies.
package-lock.jsonProvides the version information for all packages installed into node_modules by the npm client.
readme.mdStores useful development information and hints.
settings.jsonSpecifies the project settings depending on the template type. For more information, see Block settings.

Vue event handlers in the index.vue block files are not supported by eWizard Editor. For more information, see Vue event handlers are deleted from blocks in eWizard Editor.

*[Single File Component]: A style of application organization used by JavaScript UI libraries where each file represents a single component.

*[entry point]: An entry point indicates which module webpack should use to begin building out its internal dependency graph.