Merge pull request #19 from bci-oss/feature/optizmize-options-list-for-selecting-config-files

Optimize prompt that only wizard configs are shown

Author: michelu89

.gitignore

@@ -14,7 +14,7 @@ jest-stare/
 node_modules/
 npm-debug.log*
 yarn-error.log*
-wizard-config.json
+*wizard.config.json
 
 # Mac OSX Finder files.
 **/.DS_Store

README.md

@@ -558,7 +558,7 @@ If you want to use a pre-existing config file, without going through the generat
 .json config using the 'configFile' flag by running the command like this:
 
 ```bash
-ng generate @esmf/semantic-ui-schematics:table --configFile=wizard-configs/<config-file-name>.json
+ng generate @esmf/semantic-ui-schematics:table --configFile=<config-file-name>-wizard.configs.json
 ```
 
 Example of configuration file:
@@ -567,7 +567,7 @@ Example of configuration file:
 {
     "aspectModelTFiles": ["FOLDER\\Movement.ttl"],
     "excludedProperties": [],
-    "configFile": "wizard-config.json",
+    "configFile": "wizard.config.json",
     "complexProps": [
         {
             "prop": "position",

documentation/js-sdk-guide/modules/tooling-guide/images/schema.enter-name-for-config-file.png

@@ -46,11 +46,19 @@ auto-generated. The first prompt allows you to load a config file or start from
 
 image::config-file-loading.png[width=100%]
 
-Loading pre-existing config file will result into this:
+When you decide to create a new configuration file, you will be prompted to specify a name for your config file. This provided name will be integrated into the default naming structure for the config file.
+
+The naming structure is <config-file-name>-wizard.config.json. Here, <config-file-name> is the name that you provide when prompted.
+
+For example, if you enter myConfig when prompted for the config file name, your new config file will be named myConfig-wizard.config.json.
+
+image::schema.enter-name-for-config-file.png[width=100%]
+
+When you decide to load a pre-existing config file, the system will display the result as follows:
 
 image::schema.load-config-file.yes.png[width=100%]
 
-This will give access to the folder structure and by using a FUZZY search mechanism can provide the possibility to input the pre-existing config file. By default, the config file is called _wizard-config.json_ and can be found in the root folder of the project.
+This will give access to the folder structure and by using a FUZZY search mechanism can provide the possibility to input the pre-existing config file. The config file will now be named based on your input _<config-file-name>_-wizard.config.json, and can be found in the root folder of the project.
 
 === _Aspect Model selection_
 If no pre-existing config file is loaded, then there is an option to choose for one or multiple Aspect Model files from the folder structure, using the same FUZZY search mechanism.

documentation/js-sdk-guide/modules/tooling-guide/images/schema.load-config-file.yes.png

@@ -29,7 +29,6 @@ import {
 import * as fs from 'fs';
 import inquirer, {Answers, Question, QuestionAnswer} from 'inquirer';
 import {Observable, Subject, Subscriber} from 'rxjs';
-import {WIZARD_CONFIG_FILE} from '../../utils/file';
 import {TemplateHelper} from '../../utils/template-helper';
 import {Schema} from '../table/schema';
 import * as locale from 'locale-codes';
@@ -38,6 +37,8 @@ inquirer.registerPrompt('fuzzypath', require('inquirer-fuzzy-path'));
 inquirer.registerPrompt('suggest', require('inquirer-prompt-suggest'));
 inquirer.registerPrompt('search-list', require('inquirer-search-list'));
 
+export let WIZARD_CONFIG_FILE = 'wizard.config.json';
+
 const loader = new AspectModelLoader();
 
 let aspect: Aspect;
@@ -144,14 +145,23 @@ function getTtlPaths(promptSubj: Subject<any>, allAnswers: Schema, subscriber: S
         default: false,
     };
 
+    const configFileName = {
+        type: 'input',
+        name: 'configFileName',
+        message: 'Please enter a name for your config file. It will be automatically appended to (<config-file-name>-wizard.config.json):',
+        validate: function (input: string) {
+            return input.length === 0 ? 'The config file name cannot be empty. Please provide a valid name.' : true;
+        }
+    };
+
     const importConfigFile = {
         type: 'fuzzypath',
         name: 'importConfigFile',
-        excludeFilter: (nodePath: any) => !nodePath.endsWith('.json'),
+        excludeFilter: (nodePath: any) => !nodePath.endsWith('wizard.config.json'),
         excludePath: (nodePath: any) => nodePath.startsWith('node_modules'),
         itemType: 'file',
-        message: 'Choose the path to an existing wizard config file(.json). Start writing file name for suggestions:',
-        default: './',
+        message: 'Choose the path to an existing wizard config file which ends with "wizard.config.json". Start writing file name for suggestions:',
+        rootPath: './',
         suggestOnly: false,
         depthLimit: 5,
     };
@@ -163,7 +173,7 @@ function getTtlPaths(promptSubj: Subject<any>, allAnswers: Schema, subscriber: S
         excludePath: (nodePath: any) => nodePath.startsWith('node_modules'),
         itemType: 'file',
         message: 'Choose the path to a .ttl file. Start writing file name for suggestions:',
-        default: './',
+        rootPath: './',
         suggestOnly: false,
         depthLimit: 5,
     };
@@ -181,20 +191,27 @@ function getTtlPaths(promptSubj: Subject<any>, allAnswers: Schema, subscriber: S
             switch (true) {
                 case singleAnswer.name === createOrImport.name: {
                     if (singleAnswer.answer) {
-                        promptSubj.next(pathDecision);
+                        promptSubj.next(configFileName);
                     } else {
                         promptSubj.next(importConfigFile);
                     }
                     break;
                 }
+                case singleAnswer.name === configFileName.name: {
+                    if (singleAnswer.answer !== WIZARD_CONFIG_FILE) {
+                        WIZARD_CONFIG_FILE = `${singleAnswer.answer}-${WIZARD_CONFIG_FILE}`;
+                    }
+                    promptSubj.next(pathDecision);
+                    break;
+                }
                 case singleAnswer.name === importConfigFile.name: {
-                    const configFileName = singleAnswer.answer;
-                    if (!configFileName) {
+                    const fileName = singleAnswer.answer;
+                    if (!fileName) {
                         console.log('Error loading config file. Try again with a different file ! ');
                         promptSubj.complete();
                     }
                     try {
-                        const data = fs.readFileSync(configFileName, 'utf8');
+                        const data = fs.readFileSync(fileName, 'utf8');
                         fromImport = true;
                         promptSubj.complete();
                         writeConfigAndExit(subscriber, tree, JSON.parse(data), true);
@@ -212,7 +229,6 @@ function getTtlPaths(promptSubj: Subject<any>, allAnswers: Schema, subscriber: S
                         promptSubj.next(pathDecision);
                     }
                     break;
-
                 case singleAnswer.name === pathDecision.name: {
                     const ttlFileName = singleAnswer.answer;
                     if (!ttlFileName) {

documentation/js-sdk-guide/modules/tooling-guide/pages/table-generation.adoc

@@ -24,7 +24,7 @@ import {
     wrapBuildComponentExecution,
 } from '../../utils/angular';
 import {generateTranslationFiles, generateTranslationModule, loadAspectModel, loadRDF} from '../../utils/aspect-model';
-import {createOrOverwrite, formatGeneratedFiles, loadAndApplyConfigFile, WIZARD_CONFIG_FILE} from '../../utils/file';
+import {createOrOverwrite, formatGeneratedFiles, loadAndApplyConfigFile} from '../../utils/file';
 import {addPackageJsonDependencies, DEFAULT_DEPENDENCIES} from '../../utils/package-json';
 import {TemplateHelper} from '../../utils/template-helper';
 import {HtmlGenerator} from './generators/html.generator';
@@ -35,6 +35,7 @@ import {Schema} from './schema';
 import {TsComponentGenerator} from './generators/ts-component.generator';
 import {addModuleImportToModule} from '@angular/cdk/schematics';
 import ora from 'ora';
+import {WIZARD_CONFIG_FILE} from "../table-prompter/index";
 
 export default function (options: Schema): Rule {
     return (tree: Tree, context: SchematicContext): void => {

src/ng-generate/table-prompter/index.ts

@@ -21,8 +21,6 @@ const prettier = require('prettier');
 // this resolves the config provided by the schematics lib
 const defaultPrettierConfigPath = require.resolve('../../.prettierrc');
 
-export const WIZARD_CONFIG_FILE = 'wizard-config.json';
-
 export function loadAndApplyConfigFile(configFile: string, options: any): void {
     try {
         if (options.configFile && options.configFile !== '') {