add support to typescriptEslint

mshima · Jul 16, 2024 · 7424f42 · 7424f42
1 parent f4d76df
commit 7424f42
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 13 deletions.
diff --git a/generators/base-application/support/task-type-inference.ts b/generators/base-application/support/task-type-inference.ts
@@ -23,6 +23,7 @@ export function asWriteFilesSection<Data = GeneratorDefinition['writingTaskParam
 ) {
   return section;
 }
+
 export function asWriteFilesBlock<Data = GeneratorDefinition['writingTaskParam']['application']>(
   section: WriteFileBlock<CoreGenerator, Data>,
 ) {

diff --git a/generators/base-core/generator.ts b/generators/base-core/generator.ts
@@ -1062,7 +1062,12 @@ templates: ${JSON.stringify(existingTemplates, null, 2)}`;
 
             const normalizedFile = resolveCallback(sourceFile || file);
             sourceFile = join(blockPath, normalizedFile);
-            destinationFile = this.destinationPath(blockTo, join(resolveCallback(destinationFile || renameTo, normalizedFile)));
+            destinationFile = join(resolveCallback(destinationFile || renameTo, normalizedFile));
+            if (blockRenameTo) {
+              destinationFile = this.destinationPath(blockRenameTo.call(this, context, destinationFile, this));
+            } else {
+              destinationFile = this.destinationPath(blockTo, destinationFile);
+            }
 
             const override = resolveCallback(fileSpec.override);
             if (override !== undefined && !override && (this as any).fs.exists(destinationFile)) {

diff --git a/generators/client/support/files.ts b/generators/client/support/files.ts
@@ -1,6 +1,7 @@
 import type { WriteFileBlock } from '../../base/api.js';
 import type CoreGenerator from '../../base-core/index.js';
 import { CLIENT_MAIN_SRC_DIR, CLIENT_TEST_SRC_DIR } from '../../generator-constants.js';
+import type { CommonClientServerApplication } from '../../base-application/types.js';
 
 export const replaceEntityFilePath = (data: any, filepath: string) =>
   filepath
@@ -10,7 +11,9 @@ export const replaceEntityFilePath = (data: any, filepath: string) =>
 
 const CLIENT_TEMPLATES_SRC_DIR = CLIENT_MAIN_SRC_DIR;
 
-type RelativeWriteFileBlock = WriteFileBlock & { relativePath?: string };
+type RelativeWriteFileBlock = WriteFileBlock<CoreGenerator, CommonClientServerApplication & Record<string, any>> & {
+  relativePath?: string;
+};
 
 export function clientRootTemplatesBlock(blockOrRelativePath?: string): Pick<WriteFileBlock, 'path' | 'renameTo'>;
 export function clientRootTemplatesBlock(blockOrRelativePath: RelativeWriteFileBlock): WriteFileBlock;

diff --git a/generators/generate-blueprint/generator.spec.js b/generators/generate-blueprint/generator.spec.js
@@ -21,7 +21,7 @@ import { fileURLToPath } from 'url';
 import { before, it, describe, expect } from 'esmocha';
 import { snakeCase } from 'lodash-es';
 
-import { defaultHelpers as helpers } from '../../testing/index.js';
+import { defaultHelpers as helpers, runResult } from '../../testing/index.js';
 import { shouldSupportFeatures, testBlueprintSupport } from '../../test/support/tests.js';
 import Generator from './index.js';
 
@@ -43,9 +43,8 @@ describe(`generator - ${generator}`, () => {
 
   describe('with', () => {
     describe('default config', () => {
-      let runResult;
       before(async () => {
-        runResult = await helpers.run(generatorPath).withJHipsterConfig().withMockedGenerators(mockedGenerators);
+        await helpers.run(generatorPath).withJHipsterConfig().withMockedGenerators(mockedGenerators);
       });
       it('should compose with init generator', () => {
         expect(runResult.mockedGenerators['jhipster:init'].calledOnce).toBe(true);
@@ -55,9 +54,8 @@ describe(`generator - ${generator}`, () => {
       });
     });
     describe('all option', () => {
-      let runResult;
       before(async () => {
-        runResult = await helpers.run(generatorPath).withOptions({ allGenerators: true }).withMockedGenerators(mockedGenerators);
+        await helpers.run(generatorPath).withOptions({ allGenerators: true }).withMockedGenerators(mockedGenerators);
       });
       it('should compose with init generator', () => {
         expect(runResult.mockedGenerators['jhipster:init'].calledOnce).toBe(true);

diff --git a/generators/generate-blueprint/templates/eslint.config.js.jhi.blueprint.ejs b/generators/generate-blueprint/templates/eslint.config.js.jhi.blueprint.ejs
@@ -16,7 +16,7 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -%>
-<&_ if (fragment.developmentSection) { -&>
+<&_ if (fragment.importsSection) { -&>
 import jhipster from 'generator-jhipster/eslint/recommended';
 <&_ } -&>
 <&_ if (fragment.configSection) { -&>

diff --git a/generators/javascript/generators/bootstrap/__snapshots__/generator.spec.ts.snap b/generators/javascript/generators/bootstrap/__snapshots__/generator.spec.ts.snap
@@ -73,7 +73,8 @@ exports[`generator - javascript:bootstrap packageJsonNodeEngine(true) should mat
   "engines": {
     "node": "^18.19.0 || >= 20.6.1"
   },
-  "scripts": {}
+  "scripts": {},
+  "type": "commonjs"
 }
 ",
     "stateCleared": "modified",

diff --git a/generators/javascript/generators/bootstrap/command.ts b/generators/javascript/generators/bootstrap/command.ts
@@ -34,6 +34,7 @@ const command: JHipsterCommandDefinition = {
         hide: true,
       },
       choices: ['commonjs', 'module'],
+      default: 'commonjs',
       scope: 'storage',
     },
   },

diff --git a/generators/javascript/generators/eslint/command.ts b/generators/javascript/generators/eslint/command.ts
@@ -19,7 +19,13 @@
 import type { JHipsterCommandDefinition } from '../../../base/api.js';
 
 const command: JHipsterCommandDefinition = {
-  configs: {},
+  configs: {
+    typescriptEslint: {
+      cli: {
+        type: Boolean,
+      },
+    },
+  },
   import: [],
 };
 

diff --git a/generators/javascript/generators/eslint/generator.ts b/generators/javascript/generators/eslint/generator.ts
@@ -69,7 +69,11 @@ export default class EslintGenerator extends BaseApplicationGenerator {
     return this.asWritingTaskGroup({
       async writing({ application }) {
         await this.writeFiles({
-          blocks: [{ templates: [{ sourceFile: 'eslint.config.js.jhi', destinationFile: ctx => `${ctx.eslintConfigFile}.jhi` }] }],
+          blocks: [
+            {
+              templates: [{ sourceFile: 'eslint.config.js.jhi', destinationFile: ctx => `${ctx.eslintConfigFile}.jhi` }],
+            },
+          ],
           context: application,
         });
       },

diff --git a/generators/javascript/generators/eslint/templates/eslint.config.js.jhi.ejs b/generators/javascript/generators/eslint/templates/eslint.config.js.jhi.ejs
@@ -19,16 +19,27 @@
 <&_
  // Register sections and max allowed fragments, 0 for unlimited.
  fragments.registerSections({
-   importSection: 0,
+   importsSection: 0,
    configSection: 0,
  });
 _&>
+<%_ if (typescriptEslint) { _%>
+// @ts-check
+
+<%_ } _%>
 import globals from 'globals';
 import prettier from 'eslint-plugin-prettier/recommended';
-<&- fragments.importSection() &>
+<%_ if (typescriptEslint) { _%>
+import tseslint from 'typescript-eslint';
+<%_ } _%>
+<&- fragments.importsSection() &>
 // jhipster-needle-eslint-add-import - JHipster will add additional import here
 
+<%_ if (typescriptEslint) { _%>
+export default tseslint.config(
+<%_ } else { _%>
 export default [
+<%_ } _%>
   {
     languageOptions: {
       globals: {
@@ -39,4 +50,8 @@ export default [
 <&- fragments.configSection() &>
   // jhipster-needle-eslint-add-config - JHipster will add additional config here
   prettier,
+<%_ if (typescriptEslint) { _%>
+);
+<%_ } else { _%>
 ];
+<%_ } _%>