Feature: Recursive directory copying for files in template/

[ms14981]

What:

• The forge can now copy and transform files that are nested in sub-directories inside the template/ directory.
• Some unit tests written for the forge's JS code.
• Small git, eslint and npm package fixes.

Why:

• When starting to create a Java (Maven) generator, we realised that if we want to minimise our users' effort to get an initial working example, we need to output our transformed files in Maven's directory structure (src/main/java//). This PR adds support for this.

Caveats:

• No CI/CD setup for these new tests.

[ColinEberhardt]

Nice work, the refactor and addition of unit tests are great 👍

Before merging, can you consider a possible change to the tests? I find the code that mocks the folder structure a little hard to read:

fs.readdirSync.mockImplementation((filePath, { withFileTypes } = {}) => {
      if (filePath.includes("helpers") || filePath.includes("partials")) {
        return [];
      } else if (withFileTypes) {
        return [
          {
            name: `${fileName}.${fileExtension}`,
            isDirectory: () => false,
          },
        ];
      } else {
        return [`${fileName}.${fileExtension}`];
      }
    });

How easy do you think it would be to create something more 'visual'. For example:

const readdirMock = mockReadDir({
   helpers: [],
   partials: [],
   [${fileName}.${fileExtension}]: ""
});

I know that's not quite right - but basically represent the mocked folder structure as an object literal.

Colin E.

[ColinEberhardt]

One other small point:

we need to output our transformed files in Maven's directory structure (src/main/java//)

I presume you've seen the -o CLI option that specifies the output folder? regardless, allowing a nested structure within the template folder is a very useful feature.

[ms14981]

One other small point:

we need to output our transformed files in Maven's directory structure (src/main/java//)

I presume you've seen the -o CLI option that specifies the output folder? regardless, allowing a nested structure within the template folder is a very useful feature.

Yes, the -o option will definitely cover most cases. However, it won't cover the case where we might want to generate a pom.xml file in the top level directory, and the rest of the files elsewhere. Currently, the forge will crash if there are any folders nested in the template folder.

[ms14981]

Nice work, the refactor and addition of unit tests are great 👍

Before merging, can you consider a possible change to the tests? I find the code that mocks the folder structure a little hard to read:

fs.readdirSync.mockImplementation((filePath, { withFileTypes } = {}) => {
      if (filePath.includes("helpers") || filePath.includes("partials")) {
        return [];
      } else if (withFileTypes) {
        return [
          {
            name: `${fileName}.${fileExtension}`,
            isDirectory: () => false,
          },
        ];
      } else {
        return [`${fileName}.${fileExtension}`];
      }
    });

How easy do you think it would be to create something more 'visual'. For example:

const readdirMock = mockReadDir({
   helpers: [],
   partials: [],
   [${fileName}.${fileExtension}]: ""
});

I know that's not quite right - but basically represent the mocked folder structure as an object literal.

Colin E.

Good shout, I've made a few changes which hopefully will make those mocks easier to read and work with :)

[gkocak-scottlogic]

All seems fine to me! I tried the the branch locally as well 👍

[github-actions[bot]]

:tada: This PR is included in version 1.3.1 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: