chore: migrate to typescript

Author: mshima

.blueprint/cli/commands.mjs .blueprint/cli/commands.ts.blueprint/cli/commands.mjs renamed to .blueprint/cli/commands.ts

@@ -16,13 +16,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { JHipsterCommandDefinition } from 'generator-jhipster';
 import { getGithubSamplesGroup, getGithubSamplesGroups } from 'generator-jhipster/ci';
 
+import type Generator from './generator.js';
+
 const DEFAULT_SAMPLES_GROUP = 'samples';
 
-/**
- * @type {import('generator-jhipster').JHipsterCommandDefinition}
- */
 const command = {
   arguments: {
     sampleName: {
@@ -59,7 +59,7 @@ const command = {
         when: !gen.all,
         type: 'select',
         message: 'which sample do you want to generate?',
-        choices: async answers => {
+        choices: async (answers: any) => {
           const samples = await getGithubSamplesGroup(gen.templatePath(), answers.samplesGroup ?? gen.samplesGroup);
           return Object.keys(samples.samples);
         },
@@ -75,6 +75,6 @@ const command = {
     },
   },
   import: ['app'],
-};
+} as const satisfies JHipsterCommandDefinition<Generator>;
 
 export default command;

.blueprint/generate-sample/command.mjs .blueprint/generate-sample/command.ts.blueprint/generate-sample/command.mjs renamed to .blueprint/generate-sample/command.ts

@@ -6,20 +6,13 @@ import { getGithubSamplesGroup } from 'generator-jhipster/ci';
 import BaseCoreGenerator from 'generator-jhipster/generators/base-core';
 
 export default class extends BaseCoreGenerator {
-  /** @type {string | undefined} */
-  samplesFolder;
-  /** @type {string} */
-  samplesGroup;
-  /** @type {string} */
-  sampleName;
-  /** @type {boolean} */
-  all;
-  /** @type {string} */
-  sampleType;
-  /** @type {string} */
-  sampleFile;
-  /** @type {any} */
-  generatorOptions;
+  samplesFolder?: string;
+  samplesGroup!: string;
+  sampleName!: string;
+  all?: boolean;
+  sampleType?: string;
+  sampleFile?: string;
+  generatorOptions: any;
 
   get [BaseCoreGenerator.WRITING]() {
     return this.asAnyTaskGroup({
@@ -40,7 +33,7 @@ export default class extends BaseCoreGenerator {
             'sample-folder': sampleFolder = samplesPath,
             generatorOptions,
             templateOptions = {},
-          } = samples[sampleName];
+          } = samples[sampleName] as any;
 
           this.generatorOptions = generatorOptions;
           this.sampleType = sampleType === 'jdl-ejs' ? 'jdl' : sampleType;
@@ -92,7 +85,7 @@ export default class extends BaseCoreGenerator {
   }
 
   getDefaultComposeOptions() {
-    const packageJson = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)));
+    const packageJson = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url), { encoding: 'utf-8' }));
     const projectVersion = `${packageJson.version}-git`;
     return {
       skipJhipsterDependencies: true,

.blueprint/generate-sample/generator.mjs .blueprint/generate-sample/generator.ts.blueprint/generate-sample/generator.mjs renamed to .blueprint/generate-sample/generator.ts

@@ -0,0 +1,2 @@
+export { default } from './generator.ts';
+export { default as command } from './command.ts';

.blueprint/generate-sample/index.mjs

@@ -1,6 +1,5 @@
-/**
- * @type {import('generator-jhipster').JHipsterCommandDefinition}
- */
+import type { JHipsterCommandDefinition } from 'generator-jhipster';
+
 const command = {
   configs: {
     samplesFolder: {
@@ -19,6 +18,6 @@ const command = {
       scope: 'generator',
     },
   },
-};
+} as const satisfies JHipsterCommandDefinition;
 
 export default command;

.blueprint/generate-sample/index.ts

@@ -1,21 +1,27 @@
 import { beforeAll, describe, expect, it } from 'vitest';
-import { basename, join } from 'path';
+import { basename, join } from 'node:path';
 
 import { getGithubSamplesGroups } from 'generator-jhipster/ci';
-import { defaultHelpers as helpers, runResult } from 'generator-jhipster/testing';
+import { createTestHelpers, typedResult } from 'generator-jhipster/testing';
 
+import type Generator from './index.js';
+
+const helpers = createTestHelpers<Generator>({
+  importMeta: import.meta,
+});
+const result = typedResult<Generator>();
 const generator = basename(import.meta.dirname);
 
 describe(`generator - ${generator}`, async () => {
   const groups = await getGithubSamplesGroups(join(import.meta.dirname, '../generate-sample/templates/'));
   for (const workflow of groups.map(sample => sample.split('.')[0])) {
     describe(`with ${workflow}`, () => {
       beforeAll(async () => {
-        await helpers.runJHipster(join(import.meta.dirname, 'index.mjs'), { prepareEnvironment: true }).withArguments(workflow);
+        await helpers.runDefault().withArguments(workflow);
       });
 
       it('should match matrix value', () => {
-        expect(runResult.generator.matrix).toMatchSnapshot();
+        expect(result.generator.matrix).toMatchSnapshot();
       });
     });
   }

…int/generate-sample/templates/samples.js …int/generate-sample/templates/samples.ts.blueprint/generate-sample/templates/samples.js renamed to .blueprint/generate-sample/templates/samples.ts .blueprint/generate-sample/templates/samples.js renamed to .blueprint/generate-sample/templates/samples.ts

@@ -1,15 +1,18 @@
 import { join } from 'node:path';
 
-import { convertToGitHubMatrix, getGithubOutputFile, getGithubSamplesGroup, setGithubTaskOutput } from 'generator-jhipster/ci';
+import {
+  type GitHubMatrixOutput,
+  convertToGitHubMatrix,
+  getGithubOutputFile,
+  getGithubSamplesGroup,
+  setGithubTaskOutput,
+} from 'generator-jhipster/ci';
 import BaseCoreGenerator from 'generator-jhipster/generators/base-core';
 
 export default class extends BaseCoreGenerator {
-  /** @type {string} */
-  samplesFolder;
-  /** @type {string} */
-  samplesGroup;
-  /** @type {object} */
-  matrix;
+  samplesFolder?: string;
+  samplesGroup?: string;
+  matrix?: GitHubMatrixOutput;
 
   get [BaseCoreGenerator.WRITING]() {
     return this.asAnyTaskGroup({