sb-mig 4.0.4 → 4.0.5

package/README.md

@@ -7,6 +7,12 @@ 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)
 
+# 4.x.x version released!
+
+- Whole deployment now, is handled by [semantic-release](https://github.com/semantic-release/semantic-release). And is just normal repository, instead of Lerna monorepo which is not needed anymore, and it was recently unmaintained (now it was passed to `nrwl` to maintain (https://github.com/lerna/lerna/issues/3121) will see what will happen in future with it :)
+- Fromt the code perspective, there are no **breaking changes** between **3.x.x** and **4.x.x** but i'm going to fix some stuff now and add some more functionalities to it. So stay tuned!
+- This Readme, which is also kinda documentation, will also be updated. Cause in some places there is misleading information. The best documentation though is just `sb-mig --help` command.
+
 # 3.x.x version released!
 
 - 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)
@@ -37,11 +43,19 @@ If you've found an issue or you have feature request - <a href="https://github.c
 npm install --global sb-mig
 ```
 
-You have to create a `.env` file with your variables:
+In your working directory (usually root of your repo where u have your app/webpage using Storyblok), you have to create a `.env` file with your variables:
 
 ```
 STORYBLOK_OAUTH_TOKEN=1234567890qwertyuiop
 STORYBLOK_SPACE_ID=12345
+
+# For nextjs
+# NEXT_PUBLIC_STORYBLOK_ACCESS_TOKEN=zxcvbnmasdfghjkl
+
+# For gatsby
+# GATSBY_STORYBLOK_ACCESS_TOKEN=zxcvbnmasdfghjkl
+
+# any other (you have to handle '.env' access in frontend yourself (for example with dotenv package)
 STORYBLOK_ACCESS_TOKEN=zxcvbnmasdfghjkl
 ```
 
@@ -88,13 +102,13 @@ $ sb-mig --help
       help    This screen
 
   Examples
-    $ sb-migv sync components --all
+    $ sb-mig sync components --all
     $ sb-mig debug
 ```
 
 # Commands
 
-* [`sb-mig version`](#sb-mig-version)
+* [`sb-mig --version`](#sb-mig-version)
 * [`sb-mig backup`](#sb-mig-backup)
 * [`sb-mig debug`](#sb-mig-debug)
 * [`sb-mig sync`](#sb-mig-sync)
@@ -103,7 +117,7 @@ $ sb-mig --help
 ```
 $ sb-mig --version
 
-3.1.7
+4.0.4
 ```
 
 ## `sb-mig backup`
@@ -118,7 +132,7 @@ $ sb-mig backup --help
 CLI to rule the world. (and handle stuff related to Storyblok CMS)
 
   Usage
-      $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names] or --all
+      $ sb-mig backup [components|component-groups|roles|datasources|presets|component-presets] component-name --one or --all
   Description
       Command for backing up anything related to Storyblok
 
@@ -148,6 +162,7 @@ Output extra debugging.
 ```
 $ sb-mig debug
 
+✓ Found storyblok.config.js!
 storyblok.config.js:  {
   componentsMatchFile: 'src/components/components.js',
   storyblokComponentsListfile: 'src/components/storyblok-components.componentList.js',
@@ -197,8 +212,14 @@ CLI to rule the world. (and handle stuff related to Storyblok CMS)
 
   EXAMPLES
       $ sb-mig sync components --all
+      $ sb-mig sync components --all --presets
       $ sb-mig sync components accordion accordion-item
+      $ sb-mig sync components accordion accordion-item --presets
       $ sb-mig sync components @storyblok-components/accordion --packageName
+      $ sb-mig sync components @storyblok-components/accordion --packageName --presets
+      $ sb-mig sync roles --all
+      $ sb-mig sync datasources --all
+
 ```
 
 # Schema documentation:
@@ -267,7 +288,7 @@ There is also support for `sections` inside components:
 
 The main purpose of `sb-mig` is to sync your `.sb.js` component schema files with your `Storyblok` space.
 
-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:
+In v4.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
@@ -398,7 +419,7 @@ export default {
 Now, sync your component
 
 ```
-sb-mig sync components --presets text-block
+sb-mig sync components text-block --presets
 ```
 
 output:
@@ -431,12 +452,29 @@ Install packages
 yarn
 ```
 
-Link package to easy test it with `sb-mig` command
+Run development command
+```bash
+yarn build:dev
+```
+
+It will watch a file change, and on every change, will rebuild typescript and build the whole lib/cli.
+
+The you can use 
+```
+node dist/index.js debug 
+```
+to access `sb-mig`
 
+For your conveniece, you can also, link it to proper `sb-mi` name:
 ```
 yarn link
 ```
 
+And then you can use it like that:
+```
+sb-mig debug
+```
+
 ## Roadmap
 
 - [ ] Sync / Migrate content (stories)

package/dist/cli-descriptions.d.ts

@@ -1,4 +1,4 @@
-export declare const mainDescription = "\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-mig sync\n      $ sb-mig debug  \n";
+export declare const mainDescription = "\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-mig sync components --all\n      $ sb-mig debug  \n";
 export declare const syncDescription = "\n    Usage\n        $ sb-mig 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 --all --presets\n        $ sb-mig sync components accordion accordion-item\n        $ sb-mig sync components accordion accordion-item --presets\n        $ sb-mig sync components @storyblok-components/accordion --packageName\n        $ sb-mig sync components @storyblok-components/accordion --packageName --presets\n        $ sb-mig sync roles --all\n        $ sb-mig sync datasources --all\n";
 export declare const backupDescription = "\n    Usage\n        $ sb-mig backup [components|component-groups|roles|datasources|presets|component-presets] component-name --one or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components        - backup components\n        component-groups  - backup 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 --one  \n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin --one\n";
 export declare const debugDescription = "\n    Usage\n        $ sb-mig debug\n    Description\n        Output extra debugging information\n";

package/dist/cli-descriptions.js

@@ -3,13 +3,13 @@ export const mainDescription = `
       $ sb-mig [command]
     
     COMMANDS
-        sync Synchronize components, datasources or roles with Storyblok space.
+        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
     
     Examples
-      $ sb-mig sync
+      $ sb-mig sync components --all
       $ sb-mig debug  
 `;
 export const syncDescription = `

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sb-mig",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "CLI to rule the world. (and handle stuff related to Storyblok CMS)",
   "author": "Marcin Krawczyk <marckraw@icloud.com>",
   "license": "MIT",