feat(Core,Cli): Better path-prefix support

Entering non exitsting path-prefix will now result with scaffolder
notifying the user about the missing paths and creating them
automaticlly

Closes #33

.eslintrc.js

@@ -19,6 +19,7 @@ module.exports = {
 	'rules': {
 		'@typescript-eslint/no-empty-function': 'off',
 		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/no-var-requires':'off',
 		'@typescript-eslint/explicit-module-boundary-types': 'off',
 		'indent': [
 			'error',

lerna.json

@@ -3,5 +3,4 @@
     "packages/*"
   ],
   "version": "independent"
-
 }

package.json

@@ -4,7 +4,7 @@
   "scripts": {
     "bootstrap": "lerna bootstrap --hoist",
     "build": "tsc -b packages/scaffolder-cli packages/scaffolder-core",
-    "test": "lerna run test",
+    "test": "npm run build && lerna run test --stream",
     "version": "lerna version --conventional-commits",
     "publish": "lerna publish from-package",
     "lint": "eslint packages/scaffolder-cli packages/scaffolder-core",

packages/scaffolder-cli/jest.config.js

@@ -1,4 +1,5 @@
 const baseJestConfig = require('../../jest.base.config.js');
+
 module.exports = {
 	...baseJestConfig
 };

packages/scaffolder-cli/tests/e2e/index.spec.js

@@ -84,6 +84,13 @@ describe('e2e', () => {
 		).toBeTruthy();
 	});
 
+	it('should create the missing directories in the prefix-path', () => {
+		execOnTestDir(
+			'create not-nested key1=awesome key5=awesome --folder not-nested --path-prefix prefix/not-existing'
+		);
+		expect(isFolderExists('prefix/not-existing/not-nested')).toBeTruthy();
+	});
+
 	it('should create the template with the right values as keys', () => {
 		execOnTestDir(
 			'create not-nested key1=awesome key5=awesome --folder not-nested'

packages/scaffolder-core/src/TemplatesBuilder/createMissingFoldersInPath.ts

@@ -0,0 +1,17 @@
+import * as fs from 'fs';
+
+export const createMissingFoldersInPath = (basePath: string, toPath: string) => {
+	const missingFoldersPaths = [];
+	if (!toPath) {
+		return missingFoldersPaths;
+	}
+	let currentPath = basePath;
+	toPath.split('/').forEach((part) => {
+		currentPath += `/${part}`;
+		if (!fs.existsSync(currentPath)) {
+			missingFoldersPaths.push(currentPath);
+			fs.mkdirSync(currentPath);
+		}
+	});
+	return missingFoldersPaths;
+};

packages/scaffolder-core/src/TemplatesBuilder/index.spec.ts

@@ -41,4 +41,14 @@ describe('TemplatesBuilder', () => {
 			expect(p).toBeInstanceOf(Promise);
 		});
 	});
+
+	it('should create the missing path parts', () => {
+		const folder = 'add/here';
+		(existsSync as jest.Mock).mockReturnValue(false);
+		const templateBuilder = new TemplatesBuilder([]);
+		templateBuilder.withPathPrefix(folder).build();
+		console.log(join(process.cwd(), folder));
+		expect(mkdirSync).toHaveBeenCalledWith(join(process.cwd(), 'add'));
+		expect(mkdirSync).toHaveBeenCalledWith(join(process.cwd(), folder));
+	});
 });

packages/scaffolder-core/src/TemplatesBuilder/index.ts

@@ -2,6 +2,8 @@ import fs from 'fs';
 import { mkdir } from 'fs-extra';
 import { FolderAlreadyExists } from '../Errors';
 import { join, TYPES } from '../filesUtils';
+import {path as pathColor, boldGreen, bold} from '../cliHelpers/colors';
+import {createMissingFoldersInPath} from './createMissingFoldersInPath';
 
 const writeFilePromise = (path: string, content: string) =>
 	new Promise((resolve, reject) => {
@@ -42,6 +44,7 @@ export class TemplatesBuilder {
 		if (this.onFileWrite) {
 			this.onFileWrite(this.counter);
 		}
+
 		return data;
 	}
 
@@ -60,7 +63,12 @@ export class TemplatesBuilder {
 		return this;
 	}
 
-	createFolderIfNeeded() {
+	createMissingPathPartsIfNeeded() {
+		this.createMissingPathPrefixFolders();
+		this.createContainingFolder();
+	}
+
+	private createContainingFolder() {
 		if (this.folder) {
 			const newFolderPath = this.getFullPath();
 			if (fs.existsSync(newFolderPath)) {
@@ -74,6 +82,22 @@ export class TemplatesBuilder {
 		}
 	}
 
+	private createMissingPathPrefixFolders() {
+		const missingPaths = createMissingFoldersInPath(this.entryPoint, this.pathPrefix);
+		if (missingPaths.length) {
+			this.logMissingFoldersInPrefixPathDetected(missingPaths);
+		}
+	}
+
+	private logMissingFoldersInPrefixPathDetected(missingPaths) {
+		const colorEndOfPath = (path) => {
+			const [last, ...restOfPath] = path.split('/').reverse();
+			return `${restOfPath.reverse().join('/')}/${boldGreen(last)}`;
+		};
+		const missingPathsString = missingPaths.reduce((paths, path) => `${paths}\n${colorEndOfPath(path)}`, '');
+		console.log(bold(`Scaffolder Detected that your prefix path (${pathColor(this.pathPrefix)}) contains non existing folders and will automatically create them for you.`), missingPathsString);
+	}
+
 	createTemplateFolder(folderDescriptor, root) {
 		return mkdir(join(root, folderDescriptor.name)).then(() => {
 			return Promise.all(
@@ -100,7 +124,7 @@ export class TemplatesBuilder {
 	}
 
 	build(): Promise<any>[] {
-		this.createFolderIfNeeded();
+		this.createMissingPathPartsIfNeeded();
 		const promises = [];
 		this.templates.forEach((template) => {
 			const path = join(

packages/scaffolder-core/src/createTemplateStructure/tests/index.spec.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 import { createTemplateStructure } from '../index';
 
-const expectedTemplate = [
+const expectedTemplateStructure = [
 	{
 		content: '',
 		name: 'another.js',
@@ -29,10 +29,11 @@ const expectedTemplate = [
 		type: 'FOLDER',
 	},
 ];
+
 describe('template reader', () => {
 	it('should create a tree structure matching the provided template', () => {
 		const {templatesStructure, filesCount} = createTemplateStructure(path.join(__dirname, '/example'));
-		expect(templatesStructure).toEqual(expectedTemplate);
+		expect(templatesStructure).toEqual(expectedTemplateStructure);
 		expect(filesCount).toBe(4);
 	});
 });