Improve api.

jhipster · Aug 7, 2021 · ac1d23c · ac1d23c
1 parent 30e587e
commit ac1d23c
Show file tree

Hide file tree

Showing 23 changed files with 177 additions and 138 deletions.
diff --git a/generators/gradle/constants.cjs b/generators/gradle/constants.cjs
@@ -17,10 +17,13 @@
  * limitations under the License.
  */
 const GRADLE_VERSION = '7.0.2';
+const GRADLE = 'gradle';
+const GRADLE_DESCRIPTION = 'Gradle';
+const BUILD_DESTINATION_VALUE = 'build';
 
 module.exports = {
-  GRADLE: 'gradle',
-  GRADLE_DESCRIPTION: 'Gradle',
   GRADLE_VERSION,
-  BUILD_DESTINATION_VALUE: 'build',
+  GRADLE,
+  GRADLE_DESCRIPTION,
+  BUILD_DESTINATION_VALUE,
 };
diff --git a/generators/gradle/generator.spec.cjs b/generators/gradle/generator.spec.cjs
@@ -36,7 +36,7 @@ describe(`JHipster ${generator} generator`, () => {
     customPrompts: {},
     generatorPath,
   });
-  describe('blueprint support', () => testBlueprintSupport('gradle'));
+  describe('blueprint support', () => testBlueprintSupport(generator));
   describe('with valid configuration', () => {
     let runResult;
     before(async () => {

diff --git a/generators/gradle/index.cjs b/generators/gradle/index.cjs
@@ -61,7 +61,7 @@ module.exports = class extends MixedChain {
     }
   }
 
-  _initializing() {
+  get initializing() {
     return {
       validateFromCli() {
         this.checkInvocationFromCLI();
@@ -81,10 +81,10 @@ module.exports = class extends MixedChain {
 
   get [INITIALIZING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._initializing();
+    return this.initializing;
   }
 
-  _loading() {
+  get loading() {
     return {
       configureChain() {
         this.configureChain();
@@ -101,7 +101,7 @@ module.exports = class extends MixedChain {
 
   get [LOADING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._loading();
+    return this.loading;
   }
 
   get preparing() {
@@ -117,7 +117,7 @@ module.exports = class extends MixedChain {
     return this.preparing;
   }
 
-  _writing() {
+  get writing() {
     return {
       async writeFiles() {
         if (this.shouldSkipFiles()) return;
@@ -128,6 +128,6 @@ module.exports = class extends MixedChain {
 
   get [WRITING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._writing();
+    return this.writing;
   }
 };
diff --git a/generators/init/config.cjs b/generators/init/config.cjs
@@ -16,16 +16,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const { PRETTIER_DEFAULT_INDENT, SKIP_COMMIT_HOOK } = require('./constants.cjs');
+const {
+  PRETTIER_DEFAULT_INDENT,
+  PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE,
+  SKIP_COMMIT_HOOK,
+  SKIP_COMMIT_HOOK_DEFAULT_VALUE,
+} = require('./constants.cjs');
 
 /** Config required at .yo-rc.json */
 const requiredConfig = {};
 
 /** Default config for templates */
 const defaultConfig = {
   ...requiredConfig,
-  [PRETTIER_DEFAULT_INDENT]: 2,
-  [SKIP_COMMIT_HOOK]: false,
+  [PRETTIER_DEFAULT_INDENT]: PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE,
+  [SKIP_COMMIT_HOOK]: SKIP_COMMIT_HOOK_DEFAULT_VALUE,
 };
 
 module.exports = { requiredConfig, defaultConfig };
diff --git a/generators/init/constants.cjs b/generators/init/constants.cjs
@@ -17,16 +17,19 @@
  * limitations under the License.
  */
 const NODE_VERSION = '14.17.1';
+
 const PRETTIER_DEFAULT_INDENT = 'prettierDefaultIndent';
 const PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE = 2;
+
 const SKIP_COMMIT_HOOK = 'skipCommitHook';
+const SKIP_COMMIT_HOOK_DESCRIPTION = 'Skip adding husky commit hooks';
 const SKIP_COMMIT_HOOK_DEFAULT_VALUE = false;
 
 module.exports = {
   NODE_VERSION,
   PRETTIER_DEFAULT_INDENT,
   PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE,
   SKIP_COMMIT_HOOK,
-  SKIP_COMMIT_HOOK_DESCRIPTION: 'Skip adding husky commit hooks',
+  SKIP_COMMIT_HOOK_DESCRIPTION,
   SKIP_COMMIT_HOOK_DEFAULT_VALUE,
 };
diff --git a/generators/init/generator.spec.cjs b/generators/init/generator.spec.cjs
@@ -16,8 +16,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const path = require('path');
 const expect = require('expect');
+const path = require('path');
 const { access } = require('fs/promises');
 
 const { basicTests, testBlueprintSupport } = require('../../test/support/index.cjs');
@@ -42,6 +42,7 @@ describe(`JHipster ${generator} generator`, () => {
     },
     contextBuilder,
   });
+  describe('blueprint support', () => testBlueprintSupport(generator));
   describe('with', () => {
     describe('default config', () => {
       let runResult;
@@ -108,5 +109,4 @@ describe(`JHipster ${generator} generator`, () => {
       });
     });
   });
-  describe('blueprint support', () => testBlueprintSupport('init'));
 });
diff --git a/generators/init/index.cjs b/generators/init/index.cjs
@@ -23,6 +23,7 @@ const { generateMixedChain } = require('../../lib/support/mixin.cjs');
 const {
   INITIALIZING_PRIORITY,
   PROMPTING_PRIORITY,
+  CONFIGURING_PRIORITY,
   LOADING_PRIORITY,
   PREPARING_PRIORITY,
   WRITING_PRIORITY,
@@ -32,7 +33,7 @@ const {
 } = require('../../lib/support/priorities.cjs');
 
 const { GENERATOR_INIT } = require('../generator-list');
-const { SKIP_COMMIT_HOOK } = require('./constants.cjs');
+const { PRETTIER_DEFAULT_INDENT, SKIP_COMMIT_HOOK } = require('./constants.cjs');
 const { files, commitHooksFiles } = require('./files.cjs');
 const { defaultConfig } = require('./config.cjs');
 const { dependencyChain } = require('./mixin.cjs');
@@ -66,7 +67,7 @@ module.exports = class extends MixedChain {
     }
   }
 
-  _initializing() {
+  get initializing() {
     return {
       validateFromCli() {
         this.checkInvocationFromCLI();
@@ -86,19 +87,18 @@ module.exports = class extends MixedChain {
 
   get [INITIALIZING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._initializing();
+    return this.initializing;
   }
 
-  _prompting() {
+  get prompting() {
     return {
       async showPrompts() {
         if (this.shouldSkipPrompts()) return;
         await this.prompt(
           [
             {
-              name: 'prettierDefaultIndent',
-              when: () => !this.abort,
-              type: 'number',
+              name: PRETTIER_DEFAULT_INDENT,
+              type: 'input',
               message: 'What is the default indentation?',
               default: defaultConfig.prettierDefaultIndent,
             },
@@ -111,23 +111,23 @@ module.exports = class extends MixedChain {
 
   get [PROMPTING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._prompting();
+    return this.prompting;
   }
 
-  _configuring() {
+  get configuring() {
     return {
       configure() {
         this.configureInit();
       },
     };
   }
 
-  get configuring() {
+  get [CONFIGURING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._configuring();
+    return this.configuring;
   }
 
-  _loading() {
+  get loading() {
     return {
       configureChain() {
         this.configureChain();
@@ -146,7 +146,7 @@ module.exports = class extends MixedChain {
 
   get [LOADING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._loading();
+    return this.loading;
   }
 
   get preparing() {
@@ -162,7 +162,7 @@ module.exports = class extends MixedChain {
     return this.preparing;
   }
 
-  _writing() {
+  get writing() {
     return {
       async writeFiles() {
         if (this.shouldSkipFiles()) return;
@@ -177,10 +177,10 @@ module.exports = class extends MixedChain {
 
   get [WRITING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._writing();
+    return this.writing;
   }
 
-  _postWriting() {
+  get postWriting() {
     return {
       addCommitHookDependencies() {
         if (this.shouldSkipFiles() || this[SKIP_COMMIT_HOOK]) return;
@@ -196,10 +196,10 @@ module.exports = class extends MixedChain {
 
   get [POST_WRITING_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._postWriting();
+    return this.postWriting;
   }
 
-  _install() {
+  get install() {
     return {
       // Initialize git repository before package manager install for commit hooks
       async initGitRepo() {
@@ -221,10 +221,10 @@ module.exports = class extends MixedChain {
 
   get [INSTALL_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._install();
+    return this.install;
   }
 
-  _end() {
+  get end() {
     return {
       /** Initial commit to git repository after package manager install for package-lock.json */
       async gitCommit() {
@@ -266,7 +266,7 @@ module.exports = class extends MixedChain {
 
   get [END_PRIORITY]() {
     if (this.delegateToBlueprint) return;
-    return this._end();
+    return this.end;
   }
 
   /*

diff --git a/generators/init/mixin.cjs b/generators/init/mixin.cjs
@@ -20,7 +20,13 @@ const { defaults } = require('lodash');
 
 const { requiredConfig, defaultConfig } = require('./config.cjs');
 const { options } = require('./options.cjs');
-const { PRETTIER_DEFAULT_INDENT, SKIP_COMMIT_HOOK, NODE_VERSION } = require('./constants.cjs');
+const {
+  NODE_VERSION,
+  PRETTIER_DEFAULT_INDENT,
+  PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE,
+  SKIP_COMMIT_HOOK,
+  SKIP_COMMIT_HOOK_DEFAULT_VALUE,
+} = require('./constants.cjs');
 
 const { GENERATOR_PROJECT_NAME } = require('../generator-list');
 
@@ -31,7 +37,10 @@ module.exports.mixin = parent =>
     /**
      * Load init options constants.
      */
-    loadInitOptionsConstants(into = this) {}
+    loadInitOptionsConstants(into = this) {
+      into.PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE = PRETTIER_DEFAULT_INDENT_DEFAULT_VALUE;
+      into.SKIP_COMMIT_HOOK_DEFAULT_VALUE = SKIP_COMMIT_HOOK_DEFAULT_VALUE;
+    }
 
     /**
      * Register and parse init options.
@@ -61,17 +70,16 @@ module.exports.mixin = parent =>
     }
 
     /**
-     * Load derived init configs into fromInto.
+     * Prepare derived init properties into fromInto.
      * @param {any} fromInto - source/destination context
      */
-    // eslint-disable-next-line no-empty-pattern
     prepareDerivedInitProperties(fromInto = this) {}
 
     /**
-     * Load derived init configs into 'into'.
+     * Load init constants into 'into'.
      * @param {Object} into - destination context
      */
     loadInitConstants(into = this) {
-      this.NODE_VERSION = NODE_VERSION;
+      into.NODE_VERSION = NODE_VERSION;
     }
   };
diff --git a/generators/java/generator.spec.cjs b/generators/java/generator.spec.cjs
@@ -19,13 +19,19 @@
 const expect = require('expect');
 const path = require('path');
 
-const { basicTests, testBlueprintSupport } = require('../../test/support/index.cjs');
 const { skipPrettierHelpers: helpers } = require('../../test/utils/utils');
-const { requiredConfig, defaultConfig } = require('./config.cjs');
+
+const { basicTests, testBlueprintSupport } = require('../../test/support/index.cjs');
+const { defaultConfig, requiredConfig } = require('./config.cjs');
+const { GENERATOR_JAVA } = require('../generator-list');
 
 const generatorPath = path.join(__dirname, 'index.cjs');
+const generator = path.basename(__dirname);
 
-describe('JHipster java generator', () => {
+describe(`JHipster ${generator} generator`, () => {
+  it('generator-list constant matches folder name', () => {
+    expect(GENERATOR_JAVA).toBe(generator);
+  });
   basicTests({
     requiredConfig,
     defaultConfig,