sb-mig 3.1.7 → 3.1.8

package/README.md

@@ -7,27 +7,20 @@ If you've found an issue or you have feature request - <a href="https://github.c
 [![npm](https://img.shields.io/npm/dt/sb-mig.svg)](ttps://img.shields.io/npm/dt/sb-mig.svg)
 [![GitHub issues](https://img.shields.io/github/issues/sb-mig/sb-mig.svg?style=flat-square&v=1)](https://github.com/sb-mig/sb-mig/issues?q=is%3Aopen+is%3Aissue)
 
-# 2.x.x version released!
+# 3.x.x version released!
 
-- completely rewritten to [Oclif](https://github.com/oclif/oclif) framework written in Typescript (with as little changes to usage as possible, check [migration guide](https://github.com/sb-mig/sb-mig/blob/oclif-research/MIGRATION-GUIDE.md))
-- support for Oclif plugin system
-- created [sb-mig](https://github.com/sb-mig) organization for better grouping related stuff
-- created npm `@sb-mig` scope aswell, for the same reason
+- completely rewritten to simple [Meow](https://github.com/sindresorhus/meow) lib with help of Typescript. Check [migration guide](https://github.com/sb-mig/sb-mig/blob/oclif-research/MIGRATION-GUIDE-v3.md)
+- support native es modules
+- thinner then Oclif framework, still with Typescript
+- decide to remove plugin support, cause it was not used enough
+- make all commands follow same standard (`backup` command, had some very weird syntax before, now it works like `sync`)
 
 ## Contents
 
 - [How to install and configure](#how-to-install-and-configure)
 - NEW [Adding Scoped Storyblok components](#adding-scoped-storyblok-components)
 - NEW [Overwriting schema files from scoped components](#overwriting-schema-files-from-scoped-components)
-- [Generate whole starter project](#generate-whole-starter-project)
 - [Usage](#usage)
-- [Commands](#commands)
-  - [`sb-mig backup`](#sb-mig-backup)
-  - [`sb-mig debug`](#sb-mig-debug)
-  - [`sb-mig help [COMMAND]`](#sb-mig-help-command)
-  - [`sb-mig plugins`](#sb-mig-plugins)
-  - [`sb-mig sync TYPE [LIST]`](#sb-mig-sync-type-list)
-- [Plugins](#plugins)
 - [Schema documentation:](#schema-documentation)
   - [Basics](#basics)
   - [Syncing components](#syncing-components)
@@ -57,10 +50,12 @@ You can also provide your custom config. To do that u have to create `storyblok.
 ```
 // storyblok.config.js
 module.exports = {
+  storyblokComponentsLocalDirectory: "src/@storyblok-components",
   sbmigWorkingDirectory: "sbmig",
-  componentDirectory: "sbmig/storyblok",
   componentsDirectories: ["src", "storyblok"],
   schemaFileExt: "sb.js",
+  datasourceExt: "sb.datasource.js",
+  rolesExt: "sb.roles.js",
   storyblokApiUrl: "https://api.storyblok.com/v1",
   oauthToken: process.env.STORYBLOK_OAUTH_TOKEN,
   spaceId: process.env.STORYBLOK_SPACE_ID,
@@ -73,516 +68,147 @@ You don't need to pass everything to the config file, just add what you need and
 ```
 // storyblok.config.js
 module.exports = {
-  componentDirectory: 'storyblok',
+  componentsDirectories: ["src", "storyblok", "@storyblok-components"],
 };
 ```
 
-## Adding scoped storyblok components
-** this feature is still experimental **
-
-For that feature to work you need to install [add-components-plugin](https://github.com/sb-mig/sb-mig/tree/master/%40sb-mig/plugin-add-components).
-
-To do that, run (from root of your project)
-```
-sb-mig plugins:install add-components
-```
-
-Now you have access to `sb-mig add components`.
-
-### Adding components and Lock file
-
-Let's say we want to add `@storyblok-components/text-block` and `@storyblok-components/heading` component. Lets run:
-```
-sb-mig add components @storyblok-components/text-block @storyblok-components/heading
-```
-
-This command, will install provided components from `npm` and will create special file called `storyblok.components.lock.js` in root of your project.
-This file is responsible for tracking where, and how your components end up being installed to your project, and is also tracking for any relations/links in your project. It is single source of truth for scoped components you installed with `sb-mig add components` command. 
-
-Example output of `storyblok.components.lock.js` file:
-
-```
-module.exports = {
-  "@storyblok-components/text-block": {
-    "name": "@storyblok-components/text-block",
-    "scope": "@storyblok-components",
-    "location": "node_modules",
-    "locationPath": "node_modules/@storyblok-components/text-block",
-    "links": {
-      "src/@storyblok-components/storyblok-components.componentList.js": {
-        "// --- sb-mig scoped component imports ---": "import * as ScopedTextBlock from '@storyblok-components/text-block';",
-        "// --- sb-mig scoped component list ---": "ScopedTextBlock.ComponentList"
-      },
-      "src/@storyblok-components/_storyblok-components.scss": {
-        "// --- sb-mig scoped component styles imports ---": "@import '@storyblok-components/text-block/src/text-block.scss';"
-      }
-    }
-  },
-  "@storyblok-components/heading": {
-    "name": "@storyblok-components/heading",
-    "scope": "@storyblok-components",
-    "location": "node_modules",
-    "locationPath": "node_modules/@storyblok-components/heading",
-    "links": {
-      "src/@storyblok-components/storyblok-components.componentList.js": {
-        "// --- sb-mig scoped component imports ---": "import * as ScopedHeading from '@storyblok-components/heading';",
-        "// --- sb-mig scoped component list ---": "ScopedHeading.ComponentList"
-      },
-      "src/@storyblok-components/_storyblok-components.scss": {
-        "// --- sb-mig scoped component styles imports ---": ""
-      }
-    }
-  }
-}
-```
-
-We can also install our components with `--copy` flag, which will copy all files of the component from `node_modules` to local file system, and will use them in needed imports.
-
-Command: 
-```
-sb-mig add components @storyblok-components/image --copy
-```
-
-Will add 
-```
-...
-"@storyblok-components/image": {
-    "name": "@storyblok-components/image",
-    "scope": "@storyblok-components",
-    "location": "local",
-    "locationPath": "src/@storyblok-components/image",
-    "links": {
-      "src/@storyblok-components/storyblok-components.componentList.js": {
-        "// --- sb-mig scoped component imports ---": "import * as ScopedImage from './image';",
-        "// --- sb-mig scoped component list ---": "ScopedImage.ComponentList"
-      },
-      "src/@storyblok-components/_storyblok-components.scss": {
-        "// --- sb-mig scoped component styles imports ---": ""
-      }
-    }
-  }
-...
-```
-
-to `storyblok.components.lock.js`
-
-As you can see, `location`, `locationPath` and also imports inside `links` are reffering now to local file system.
-
-After all this, you can easy schema part of components by running
-```
-sb-mig sync components --all --ext
-```
-
-This command will sync all your components, `local one`, those from `node_modules`. Command will always favor local schema components, that way you can also overwrites schema files, which will be shown in next section.
-
-## Overwriting schema files from scoped components
-So, you can install components with `sb-mig add components` command, but let's say you want to restrict something in schema of that components, or you want to change `description` of the component, or even a `component_group_name`. We have overwrites mechanism.
-
-Let's say you've installed `@storyblok-components/section` component which has following original schema:
-```
-module.exports = {
-  name: 'section',
-  schema: {
-    title: { 
-      type: 'text', 
-    },
-    content: {
-      type: 'bloks',
-      restrict_components: false,
-    },
-  },
-}
-```
-
-And your goal is to overwrite some of the schema properties: you want to give a proper description to it, you want to assign it to group, and you want to restrict that only `image` and `heading` component can be nested in it. Lets do that.
-
-1. We have to create schema file with the same name and extension, wherever in our project. So in that example, let's create `src/overwrites` folder and `section.sb.js` file.
-2. Now, we will import original schema file, and write our overwrites. Take a look at final overwrites for `section` component
-
-```
-const section = require("@storyblok-components/section)
-
-module.exports = {
-  ...section
-  name: 'section',
-  description: 'This is my awesome section component overwrites',
-  schema: {
-    ...section.schema,
-    content: {
-      restrict_components: true,
-      component_whitelist: [
-        'image',
-        'heading'
-      ],
-    },
-  },
-}
-```
-
-Now, if we run `sb-mig sync components --all --ext`, `sb-mig` will sync all components, and in the situation above, it will choose proper schema file (is always prefer local schema files over node_modules one).
-
-## Generate whole starter project
-
-1. Create folder with custom name and get inside
-2. Create `storyblok.config.js` file if u want to use custom gatsby storyblok starter, or custom npm component scope
-
-```
-module.exports = {
-  ...
-  boilerplateUrl: "git@github.com:your-custom-gatsby-storyblok-boilerplate.git",
-  componentsDirectories: ["src", "storyblok","node_modules/@custom-scope","node_modules/@storyblok-components"],
-  ...
-}
-
-```
-
-3. Create `.env` file only with your storyblok oauth token (which you can get from your storyblok account - this is needed for script to have access to creating space api)
-
-```
-STORYBLOK_OAUTH_TOKEN=1234567890qwertyuiop
-```
-
-4. Install `generate-project` `sb-mig` plugin.
-```
-sb-mig plugins:install generate-project
-```
-
-5. Run
-
-```
-sb-mig generate "My Greatest Project"
-```
-
-It will generate basic boilerplate.
-
-If u want to specify components you would like to add you can do that by adding parameter to the command, and list of components (list of all public available components in @storyblok-components scope: [npm list](https://www.npmjs.com/settings/storyblok-components/packages)):
-
-```
-sb-mig generate "My Greatest Project" --add @custom-scope/ui-text-block @storyblok-components/ui-surface
-```
-
-6. You can also pass `--copy` flag, which will copy component files from `node_modules` to your local, and add it properly to `components.js` file.
-```
-sb-mig generate "My Greatest Project" --add @custom-scope/ui-text-block @storyblok-components/ui-surface --copy
-```
-
-7. Wait for magic to happen.
-8. Run sync command to sync all components to storyblok.
-
-```
-sb-mig sync components --all --ext
-```
-
-7. `npm start`
-8. Enjoy your new project.
-
 # Usage
 
 ```sh-session
-$ sb-mig help
-CLI to rule the world. (and handle stuff related to Storyblok CMS)
+$ sb-mig --help
+  CLI to rule the world. (and handle stuff related to Storyblok CMS)
 
-VERSION
-  sb-mig/2.0.0-beta.5 darwin-x64 node-v12.16.2
+  USAGE
+    $ sb-mig [command]
 
-USAGE
-  $ sb-mig [COMMAND]
+  COMMANDS
+      sync    Synchronize components, datasources or roles with Storyblok space.
+      backup  Command for backing up anything related to Storyblok
+      debug   Output extra debugging information
+      help    This screen
 
-COMMANDS
-  backup  Command for backing up anything related to Storyblok
-  debug   Output extra debugging
-  help    display help for sb-mig
-  sync    Synchronize components, datasources with Storyblok space.
+  Examples
+    $ sb-migv sync components --all
+    $ sb-mig debug
 ```
 
 # Commands
 
-<!-- commands -->
+* [`sb-mig version`](#sb-mig-version)
 * [`sb-mig backup`](#sb-mig-backup)
 * [`sb-mig debug`](#sb-mig-debug)
-* [`sb-mig help [COMMAND]`](#sb-mig-help-command)
-* [`sb-mig plugins`](#sb-mig-plugins)
-* [`sb-mig plugins:inspect PLUGIN...`](#sb-mig-pluginsinspect-plugin)
-* [`sb-mig plugins:install PLUGIN...`](#sb-mig-pluginsinstall-plugin)
-* [`sb-mig plugins:link PLUGIN`](#sb-mig-pluginslink-plugin)
-* [`sb-mig plugins:uninstall PLUGIN...`](#sb-mig-pluginsuninstall-plugin)
-* [`sb-mig plugins:update`](#sb-mig-pluginsupdate)
-* [`sb-mig sync TYPE [LIST]`](#sb-mig-sync-type-list)
-
-## `sb-mig backup`
-
-Command for backing up anything related to Storyblok
+* [`sb-mig sync`](#sb-mig-sync)
 
+## `sb-mig version`
 ```
-Command for backing up anything related to Storyblok
+$ sb-mig --version
 
-USAGE
-  $ sb-mig backup
-
-OPTIONS
-  -R, --allRoles                                 Backup all roles and permissions.
-  -a, --allComponents                            Backup all components.
-  -d, --allDatasources                           Backup all datasources.
-  -e, --datasourceEntries=datasourceEntries      Backup one datasource entries by datasource name.
-  -f, --oneComponentsGroup=oneComponentsGroup    Backup one components group by name.
-  -g, --allComponentsGroups                      Backup all components groups.
-  -h, --help                                     show CLI help
-  -i, --onePreset=onePreset                      Backup one preset by id.
-  -l, --allPresets                               Backup all presets.
-  -o, --oneComponent=oneComponent                Backup one component by name.
-  -p, --oneComponentPresets=oneComponentPresets  Backup all presets for one component
-  -r, --oneRole=oneRole                          Backup one role by name.
-  -x, --oneDatasource=oneDatasource              Backup one datasource by name.
+3.1.7
 ```
 
-_See code: [lib/commands/backup.js](https://github.com/sb-mig/sb-mig/blob/v2.9.11/lib/commands/backup.js)_
-
-## `sb-mig debug`
-
-Output extra debugging.
-
-```
-Output extra debugging.
-
-USAGE
-  $ sb-mig debug
-
-OPTIONS
-  -h, --help  show CLI help
-```
-
-_See code: [lib/commands/debug.js](https://github.com/sb-mig/sb-mig/blob/v2.9.11/lib/commands/debug.js)_
-
-## `sb-mig help [COMMAND]`
-
-display help for sb-mig
-
-```
-display help for <%= config.bin %>
-
-USAGE
-  $ sb-mig help [COMMAND]
-
-ARGUMENTS
-  COMMAND  command to show help for
-
-OPTIONS
-  --all  see all commands in CLI
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
-
-## `sb-mig plugins`
-
-List installed plugins.
-
-```
-List installed plugins.
-
-USAGE
-  $ sb-mig plugins
-
-OPTIONS
-  --core  Show core plugins.
-
-EXAMPLE
-  $ sb-mig plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
-
-## `sb-mig plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-Displays installation properties of a plugin.
-
-USAGE
-  $ sb-mig plugins:inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN  [default: .] Plugin to inspect.
-
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-EXAMPLE
-  $ sb-mig plugins:inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/inspect.ts)_
-
-## `sb-mig plugins:install PLUGIN...`
-
-Installs a plugin into the CLI.
-
-```
-Installs a plugin into the CLI.
-Can be installed from npm or a git url.
-
-Installation of a user-installed plugin will override a core plugin.
-
-e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
-
-
-USAGE
-  $ sb-mig plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN  Plugin to install.
-
-OPTIONS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
-  the CLI without the need to patch and update the whole CLI.
-
-ALIASES
-  $ sb-mig plugins:add
-
-EXAMPLES
-  $ sb-mig plugins:install myplugin 
-  $ sb-mig plugins:install https://github.com/someuser/someplugin
-  $ sb-mig plugins:install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/install.ts)_
-
-## `sb-mig plugins:link PLUGIN`
+## `sb-mig backup`
 
-Links a plugin into the CLI for development.
+Command for backing up anything related to Storyblok
 
 ```
-Links a plugin into the CLI for development.
-Installation of a linked plugin will override a user-installed or core plugin.
-
-e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
-
-
-USAGE
-  $ sb-mig plugins:link PLUGIN
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
+$ sb-mig backup --help
 
-DESCRIPTION
-  Installation of a linked plugin will override a user-installed or core plugin.
 
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
-  command will override the user-installed or core plugin implementation. This is useful for development work.
 
-EXAMPLE
-  $ sb-mig plugins:link myplugin
-```
+CLI to rule the world. (and handle stuff related to Storyblok CMS)
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/link.ts)_
+  Usage
+      $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names] or --all
+  Description
+      Command for backing up anything related to Storyblok
 
-## `sb-mig plugins:uninstall PLUGIN...`
+  COMMANDS
+      components        - backup components
+      component-groups  - backuo component-groups
+      roles             - backup components
+      datasources       - backup components
+      presets           - backup presets
+      component-presets - backup component presets
 
-Removes a plugin from the CLI.
+  FLAGS
+      --all  - Backup all
+      --one  - Backup one
 
+  EXAMPLES
+      $ sb-mig backup components --all
+      $ sb-mig backup components accordion accordion-item carousel text-block
+      $ sb-mig backup datasources --all
+      $ sb-mig backup roles admin normal-user
 ```
-Removes a plugin from the CLI.
-
-USAGE
-  $ sb-mig plugins:uninstall PLUGIN...
 
-ARGUMENTS
-  PLUGIN  plugin to uninstall
+## `sb-mig debug`
 
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
+Output extra debugging.
 
-ALIASES
-  $ sb-mig plugins:unlink
-  $ sb-mig plugins:remove
 ```
+$ sb-mig debug
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/uninstall.ts)_
-
-## `sb-mig plugins:update`
-
-Update installed plugins.
-
+storyblok.config.js:  {
+  componentsMatchFile: 'src/components/components.js',
+  storyblokComponentsListfile: 'src/components/storyblok-components.componentList.js',
+  storyblokComponentsLocalDirectory: 'src/@storyblok-components',
+  componentsStylesMatchFile: 'src/@storyblok-components/_storyblok-components.scss',
+  boilerplateUrl: 'git@github.com:storyblok-components/gatsby-storyblok-boilerplate.git',
+  sbmigWorkingDirectory: 'sbmig',
+  componentDirectory: 'storyblok',
+  datasourcesDirectory: 'storyblok',
+  componentsDirectories: [ 'src', 'storyblok' ],
+  schemaFileExt: 'sb.js',
+  datasourceExt: 'sb.datasource.js',
+  rolesExt: 'sb.roles.js',
+  storyblokApiUrl: 'https://api.storyblok.com/v1',
+  oauthToken: '',
+  spaceId: '',
+  accessToken: ''
+}
 ```
-Update installed plugins.
-
-USAGE
-  $ sb-mig plugins:update
 
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
-```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/update.ts)_
 
-## `sb-mig sync TYPE [LIST]`
+## `sb-mig sync`
 
 Synchronize components, datasources or roles with Storyblok space.
 
 ```
-Synchronize components, datasources or roles with Storyblok space.
-
-USAGE
-  $ sb-mig sync TYPE [LIST]
-
-ARGUMENTS
-  TYPE  (components|datasources|roles) What to synchronize
-  LIST  Space separated list of component names. Example: card product-card row layout
+$ sb-mig sync --help
 
-OPTIONS
-  -a, --all          Synchronize all components.
-  -e, --ext          Synchronize with file extension. Default extension: '.sb.js'
-  -h, --help         show CLI help
-  -l, --lock         Synchronize based on storyblok.components.lock.js file
-  -n, --packageName  Synchronize based on installed package name.
-  -p, --presets      Synchronize components with presets.
+CLI to rule the world. (and handle stuff related to Storyblok CMS)
 
-EXAMPLES
-  $ sb-mig sync components --all --ext
-  $ sb-mig sync components @storyblok-components/text-block --ext --packageName
-  $ sb-mig sync components @storyblok-components/text-block @storyblok-components/button --ext --packageName
-  $ sb-mig sync components text-block button --ext
-  $ sb-mig sync components text-block button
-  $ sb-mig sync roles
-```
+  Usage
+      $ sb-mig-v3 sync [components|roles|datasources] [space separated file names] or --all --packageName
 
-_See code: [lib/commands/sync.js](https://github.com/sb-mig/sb-mig/blob/v2.9.11/lib/commands/sync.js)_
-<!-- commandsstop -->
+  Description
+      Synchronize components or roles with Storyblok space.
 
-# Plugins
-`sb-mig` core features are part of this repository. But `sb-mig` is build in a way that you can easily add your own command as a plugin. Here will be the list of plugins, which are already supported by `sb-mig`. For installation instructions see: [TBD](#)
+  COMMANDS
+      components    - sync components
+      roles         - sync roles
+      datasources   - sync datasources
 
-- [plugin-add-components](https://github.com/sb-mig/plugin-add-components) - with this plugin, you can easily install storyblok react components to your project ( compliant with `components.js` file syntax: [TBD](#) )
-- [plugin-create-component](https://github.com/sb-mig/plugin-create-component) - with this plugin, you can easily add working dummy component with all needed syntax to monorepos with storyblok components, like this unofficial one [storyblok-components/components](https://github.com/storyblok-components/components) which is deployed to `@storyblok-components` scope of public npm
-- [plugin-generate-project](https://github.com/sb-mig/plugin-generate-project) - with this plugin, you need only one command, to generate and bootstrap whole new Storyblok project with provided list of available components. It is also created storyblok space for you, and after command is done, you are ready to develop, edit and use installed components. ()
+  FLAGS
+      --all         - Sync all components
+      --packageName - Sync based on package name, instead of file name (package can have multiple schema files to sync)
+      --presets     - Pass it, if u want to sync also with presets (will take longer)
 
-To build your own plugin, head over to this instruction: [TBD](#)
+  EXAMPLES
+      $ sb-mig sync components --all
+      $ sb-mig sync components accordion accordion-item
+      $ sb-mig sync components @storyblok-components/accordion --packageName
+```
 
 # Schema documentation:
 
 ## Basics
 
-This is what a basic storyblok `.js` schema file which maps to a component looks like:
+This is what a basic storyblok `.sb.js` schema file which maps to a component looks like:
 
 ```
-module.exports = {
+expport default {
   name: "text-block",
   display_name: "Text block",
   is_root: false,
@@ -596,7 +222,7 @@ module.exports = {
 };
 ```
 
-**Important notice:** name inside `.js` schema need to match `.js` filename.
+**Important notice:** name inside `.sb.js` schema need to match `.sb.js` filename.
 
 You can add anything mentioned here: https://www.storyblok.com/docs/api/management#core-resources/components/components to your component. (with the exception of `component_group_uuid`: insert `component_group_name` and `sb-mig` will resolve `uuid` automagically).
 
@@ -639,21 +265,16 @@ There is also support for `sections` inside components:
 
 ## Syncing components
 
-The main purpose of `sb-mig` is to sync your `.js` component schema files with your `Storyblok` space.
+The main purpose of `sb-mig` is to sync your `.sb.js` component schema files with your `Storyblok` space.
 
-There are 2 ways to sync your schemas, which to use depends on your file structure. If you are keeping all of your schema files in a single folder, use:
+In v3.x.x There is 1 way to sync your schemas, which is to name all your schemas with `.sb.js` extension. You can have them in any place of your repositories, as long as this place is pointed in `storyblok.config.js` `componentDirectories` field, which is set to `componentsDirectories: ["src", "storyblok"],` by default:
 
 ```
 sb-mig sync components row column
 ```
 
-This command will look for `row.js` and `column.js` files inside a directory named `storyblok`. You can change the directory name mapping by modifying `componentDirectory` inside `storyblok.config.js`). [How to install and configure](#how-to-install-and-configure))
-
-```
-sb-mig sync components --ext row column
-```
+This command will look for `row.sb.js` and `column.sb.js` files inside a directories mentioned in `componentDirectories` field. (You can change directories name mapping by modifying `componentDirectories` inside `storyblok.config.js`). You can also change the extension searched by changing `schemaFileExt`. [How to install and configure](#how-to-install-and-configure))
 
-This command will look for any file named `row.sb.js` and `column.sb.js` inside `src` and `storyblok` folders. To modify the directories in this case you can set `componentsDirectories` in the config. You can also change the extension searched by changing `schemaFileExt`. [How to install and configure](#how-to-install-and-configure))
 
 ## Syncing datasources
 
@@ -663,7 +284,7 @@ Add `datasourceExt: "your-own-extension",` to your `storyblok.config.js`. If u w
 
 ```
 // storyblok.config.js
-module.exports = {
+export default {
   ...
   datasourcesDirectory: "mydatasource.ext.js"
   ...
@@ -673,7 +294,7 @@ module.exports = {
 Create file with `.sb.datasource.js` (or your defined one) extension inside it. Basic schema for datasources file:
 
 ```
-module.exports = {
+export default {
   name: "icons",
   slug: "icons",
   datasource_entries: [
@@ -703,7 +324,7 @@ Single `datasource entry` consist of **precisely** 2 fields. But they can be nam
 Command for syncing datasources:
 
 ```
-sb-mig sync datasources icons --ext
+sb-mig sync datasources icons
 ```
 
 Example output from above command
@@ -720,7 +341,7 @@ Trying to get 'icons' datasource.
 Like with syncing component, you can also use syncing multiple datasources at once:
 
 ```
-sb-mig sync datasources icons logos --ext
+sb-mig sync datasources icons logos
 ```
 
 ```
@@ -731,15 +352,13 @@ sb-mig sync datasources icons logos --ext
 You can also sync all datasources, and that's the command we strongly recommend. It will sync all datasources also the one from node_modules, so potentially from `storyblok-components`. But will prefer syncing local ones, if there will be clash of datasources filenames (for example, you can have datasource from node_modules, but wanted to overwrite some fields, you will be able to do that.
 
 ```
-sb-mig sync datasources --all --ext
+sb-mig sync datasources --all
 ```
 
 
 ## Presets support
 
-- Experimental
-
-Writing your own predefined data (presets) for components can be a pain, so with `sb-mig` you can create presets for your components in the storyblok gui, and then export them to a schema based `.js` file to be picked up while syncing.
+Writing your own predefined data (presets) for components can be a pain, so with `sb-mig` you can create presets for your components in the storyblok gui, and then export them to a schema based `.sb.js` file to be picked up while syncing.
 
 To do so, first create a preset for your component in storyblok:
 
@@ -750,7 +369,7 @@ To do so, first create a preset for your component in storyblok:
 then run
 
 ```
-sb-mig backup --oneComponentPresets text-block    // component you've created preset for
+sb-mig backup component-presets --one text-block    // component you've created preset for
 ```
 
 The tool will now download all presets related to the `text-block` component.
@@ -761,9 +380,9 @@ You should remove the id field from the preset (it will be looked up by name)
 Finally, add the `all_presets` field to your `text-block` component schema.
 
 ```
-const allPresets = require('./presets/_text-block-preset.json');
+import allPresets from './presets/_text-block-preset.json'
 
-module.exports = {
+export default {
   ...
   schema: {
     title: {
@@ -818,24 +437,17 @@ Link package to easy test it with `sb-mig` command
 yarn link
 ```
 
-or use it like that without linking:
-
-```
-./bin/run // same as linked `sb-mig` command
-```
-
 ## Roadmap
 
 - [ ] Sync / Migrate content (stories)
 - [ ] Improve preset creation/update
-- ~~[ ] End-to-end solution to add / update components~~ // it will be responsibility of different plugin. Check [here](https://github.com/sb-mig/plugin-generate-project)
 - [x] Sync Roles
 - [x] Sync / Migrate datasources
 - [x] Sync components with extensions
 - [x] Sync presets
 - [x] Sync single component
 - [x] Sync all components
-- [x] Sync components using schema based .js file (based on idea from [storyblok-migrate](https://github.com/maoberlehner/storyblok-migrate))
+- [x] Sync components using schema based .sb.js file (based on idea from [storyblok-migrate](https://github.com/maoberlehner/storyblok-migrate))
 - [x] Component groups
 - [x] Sync custom fields
 

package/dist/cli-descriptions.d.ts

@@ -1,4 +1,4 @@
-export declare const mainDescription = "\n    CLI to rule the world. (and handle stuff related to Storyblok CMS)\n    \n    VERSION\n        sb-mig/3.0.0@beta\n    \n    USAGE\n      $ sb-mig [command]\n    \n    COMMANDS\n        sync Synchronize components, datasources or roles with Storyblok space.\n        backup  Command for backing up anything related to Storyblok\n        debug   Output extra debugging information\n        help    This screen\n    \n    Examples\n      $ sb-migv-3 sync\n      $ sb-mig-v3 debug  \n";
-export declare const syncDescription = "\n    Usage\n        $ sb-mig-v3 sync [components|roles|datasources] [space separated file names] or --all --packageName\n        \n    Description\n        Synchronize components or roles with Storyblok space.\n        \n    COMMANDS\n        components  - sync components\n        roles       - sync roles\n        datasources - sync datasources\n     \n    FLAGS\n        --all         - Sync all components\n        --packageName - Sync based on package name, instead of file name (package can have multiple schema files to sync)\n        --presets     - Pass it, if u want to sync also with presets (will take longer) \n    \n    EXAMPLES\n        $ sb-mig sync components --all\n        $ sb-mig sync components accordion accordion-item\n        $ sb-mig sync components @storyblok-components/accordion --packageName\n    \n";
-export declare const backupDescription = "\n    Usage\n        $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names ] or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components - backup components\n        component-groups - backuo component-groups\n        roles - backup components\n        datasources - backup components\n        presets - backup presets\n        component-presets - backup component presets\n     \n    FLAGS\n        --all  - Backup all \n        --one - Backup one \n    \n    EXAMPLES\n        $ sb-mig backup components --all\n        $ sb-mig backup components accordion accordion-item carousel text-block\n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin normal-user\n";
+export declare const mainDescription = "\n    CLI to rule the world. (and handle stuff related to Storyblok CMS)\n    \n    USAGE\n      $ sb-mig [command]\n    \n    COMMANDS\n        sync Synchronize components, datasources or roles with Storyblok space.\n        backup  Command for backing up anything related to Storyblok\n        debug   Output extra debugging information\n        help    This screen\n    \n    Examples\n      $ sb-migv-3 sync\n      $ sb-mig-v3 debug  \n";
+export declare const syncDescription = "\n    Usage\n        $ sb-mig-v3 sync [components|roles|datasources] [space separated file names] or --all --packageName\n        \n    Description\n        Synchronize components or roles with Storyblok space.\n        \n    COMMANDS\n        components     - sync components\n        roles          - sync roles\n        datasources    - sync datasources\n     \n    FLAGS\n        --all          - Sync all components\n        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync)\n        --presets      - Pass it, if u want to sync also with presets (will take longer) \n    \n    EXAMPLES\n        $ sb-mig sync components --all\n        $ sb-mig sync components accordion accordion-item\n        $ sb-mig sync components @storyblok-components/accordion --packageName\n    \n";
+export declare const backupDescription = "\n    Usage\n        $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names ] or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components        - backup components\n        component-groups  - backuo component-groups\n        roles             - backup components\n        datasources       - backup components\n        presets           - backup presets\n        component-presets - backup component presets\n     \n    FLAGS\n        --all   - Backup all \n        --one   - Backup one \n    \n    EXAMPLES\n        $ sb-mig backup components --all\n        $ sb-mig backup components accordion accordion-item carousel text-block\n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin normal-user\n";
 export declare const debugDescription = "\n    Usage\n        $ sb-mig-v3 debug\n    Description\n        Output extra debugging information\n";

package/dist/cli-descriptions.js

@@ -1,9 +1,6 @@
 export const mainDescription = `
     CLI to rule the world. (and handle stuff related to Storyblok CMS)
     
-    VERSION
-        sb-mig/3.0.0@beta
-    
     USAGE
       $ sb-mig [command]
     
@@ -25,14 +22,14 @@ export const syncDescription = `
         Synchronize components or roles with Storyblok space.
         
     COMMANDS
-        components  - sync components
-        roles       - sync roles
-        datasources - sync datasources
+        components     - sync components
+        roles          - sync roles
+        datasources    - sync datasources
      
     FLAGS
-        --all         - Sync all components
-        --packageName - Sync based on package name, instead of file name (package can have multiple schema files to sync)
-        --presets     - Pass it, if u want to sync also with presets (will take longer) 
+        --all          - Sync all components
+        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync)
+        --presets      - Pass it, if u want to sync also with presets (will take longer) 
     
     EXAMPLES
         $ sb-mig sync components --all
@@ -47,16 +44,16 @@ export const backupDescription = `
         Command for backing up anything related to Storyblok
         
     COMMANDS
-        components - backup components
-        component-groups - backuo component-groups
-        roles - backup components
-        datasources - backup components
-        presets - backup presets
+        components        - backup components
+        component-groups  - backuo component-groups
+        roles             - backup components
+        datasources       - backup components
+        presets           - backup presets
         component-presets - backup component presets
      
     FLAGS
-        --all  - Backup all 
-        --one - Backup one 
+        --all   - Backup all 
+        --one   - Backup one 
     
     EXAMPLES
         $ sb-mig backup components --all

package/dist/config/config.d.ts

@@ -1,12 +1,6 @@
 export interface IStoryblokConfig {
-    componentsMatchFile: string;
-    storyblokComponentsListfile: string;
     storyblokComponentsLocalDirectory: string;
-    componentsStylesMatchFile: string;
-    boilerplateUrl: string;
     sbmigWorkingDirectory: string;
-    componentDirectory: string;
-    datasourcesDirectory: string;
     componentsDirectories: string[];
     schemaFileExt: string;
     datasourceExt: string;

package/dist/config/config.js

@@ -4,14 +4,8 @@ import dotenv from "dotenv";
 import { getFileContent } from "../utils/main.js";
 dotenv.config();
 const defaultConfig = {
-    componentsMatchFile: "src/components/components.js",
-    storyblokComponentsListfile: "src/components/storyblok-components.componentList.js",
     storyblokComponentsLocalDirectory: "src/@storyblok-components",
-    componentsStylesMatchFile: "src/@storyblok-components/_storyblok-components.scss",
-    boilerplateUrl: "git@github.com:storyblok-components/gatsby-storyblok-boilerplate.git",
     sbmigWorkingDirectory: "sbmig",
-    componentDirectory: "storyblok",
-    datasourcesDirectory: "storyblok",
     componentsDirectories: ["src", "storyblok"],
     schemaFileExt: "sb.js",
     datasourceExt: "sb.datasource.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sb-mig",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "CLI to rule the world. (and handle stuff related to Storyblok CMS)",
   "author": "Marcin Krawczyk <marckraw@icloud.com>",
   "license": "MIT",
@@ -57,5 +57,5 @@
     "conventional-changelog-cli": "^2.0.31",
     "typescript": "^4.5.5"
   },
-  "gitHead": "995b2c45f9da0b37eb6cc7530db4b7edfd874fdb"
+  "gitHead": "0965a4b3896f2e94c052d3990fa33f1166747811"
 }