v2.0.0-beta.0

Author: edtoken

.eslintrc.json

@@ -1 +1,3 @@
-{ "root": true }
+{
+  "root": true
+}

.github/workflows/publish.yml

@@ -17,6 +17,6 @@ jobs:
       - name: Install dependencies and build 🔧
         run: yarn --frozen-lockfile && yarn build
       - name: Publish package on NPM 📦
-        run: npm publish
+        run: npm publish --tag beta
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+## [Unreleased]
+
+
+## [2.0.0-beta.0] - 2023-10-01
+
+### Migrate to version 2.0.0-beta.0
+1. Bundle environments with `1.0.0` version
+2. Extract environments with `2.0.0-beta.0` version
+
+### Breaking changes
+- The `method` directory template was changed `__:[method]` -> `___method` to make it compatible with windows machine. 
+- The `responses` directory name was changed `__:[responses]` -> `___responses` to make it compatible with windows machine. 
+- The route paths now ignore special characters and multiple spaces.
+  > The output file name and path is still related to the route endpoint, but the escape function has fully changed, so it is not backward compatible with the previous one
+- Test scripts and test structure were changed.
+
+### Added
+- Argument to enable the markdown docs generation (disabled by default)
+- `--verbose` mode with extra details about bundle/extract progress
+- POC usage flow on CI see [Use Cases](./README.md#use-cases)
+
+### Changed
+- Tests structure changed and improved
+- Refactored escapePath method, improved performance, fixed windows special chars issues
+
+### Deprecated
+...
+
+### Removed
+- Automatic `documentation.md` file generation, use new arg `-d, --doc` for documentation generation see updated [CLI args](./README.md#cli)
+
+### Fixed
+- Issues with filenames on windows, `:,{,},...` special chars not removed from the dirname.
+
+### Security
+- Changed path of Mockoon routes with `../../` in the URI, fixed ability to override files not related to the project.
+
+
+## [1.0.0] - 2023-09-25
+
+### Added
+...
+
+### Changed
+... 
+
+### Deprecated
+...
+
+### Removed
+...
+
+### Fixed
+...
+
+### Security
+...

README.md

@@ -7,7 +7,7 @@
 A CLI tool to bundle/extract [Mockoon](https://mockoon.com/) environment files in a git-friendly files tree with 100% backward compatibility.
 
 
-![lifecycle](./public/assets/lifecycle.jpg)
+![lifecycle](./public/assets/lifecycle.png)
 
 ## Features
 - Extracts the original big Mockoon environment file into a user-friendly (git-friendly) file tree.
@@ -68,6 +68,8 @@ Options:
   -f, --force                          Force override directories and files if exists
   -i, --input  <relative-path or url>  Input path or URL
   -o, --output  <relative-path>        Output file or dir path
+      --verbose                        Show progress logs
+  -d, --doc                            Generate Markdown documentation (extract only, default=false)
   -h, --help                           display help for command
 
 Commands:
@@ -78,6 +80,13 @@ Commands:
 
 ## Usage
 
+### Help
+``` 
+yarn mockoon-config-transformer --help
+yarn mockoon-config-transformer bundle --help
+yarn mockoon-config-transformer extract --help
+```
+
 ### Extract
 > Extracts the original Mockoon environment file into user-friendly file tree. 
 
@@ -95,13 +104,21 @@ yarn mockoon-config-transformer extract \
   -o ./output-dir
 ```
 
+```
+# Extract environment.json into output-dir + docs generation
+
+yarn mockoon-config-transformer extract -i ./environment.json -o ./output-dir --doc
+```
+
+
 ### Bundle
 > Bundle extracted directory to the environment file that equals the original file.
 
 ```
 yarn mockoon-config-transformer bundle -i ./output-dir/index.json -o ./environment.json
 ```
 
+
 ## Extracted files tree structure details
 To make the extracted structure safe for duplicates special chars, future Mockoon releases, etc. the "bundle" functionality is based not on the directories tree, but on the file's content.
 
@@ -122,3 +139,8 @@ When the `index.json` data is object then `includes` is key:value  extend object
 
 When the `index.json` data is an array, then `includes` is a ordered file paths of where the array items stored is.
 
+
+## Use cases
+
+### Use with CI
+![usage](./public/assets/usage.jpg)