feat: allow index files customization

[maastrich]

Status

READY

Related

Fix #2044

Description

add a way to customize index files:

export default defineConfig({
  output: {
    // ....rest of the config
    indexFiles: {
      schema: (schema) => schemaPaths.filter(schema => schema.name === "Dog"),
      workspace: (implementationPaths) => implementationPaths.filter(path => path.includes('do-not-expose-this-file')),
    },
  },
});

add a way to expose custom files:

export default defineConfig({
  output: {
    // ....rest of the config
    client() {
        return {
            // ... client definition
            extraFiles() {
                return [
                    {
                        path: 'src/file-to-expose.ts',
                        content: 'export default function () {}',
                        exposeIndexFile: true,
                    },
                    {
                        path: 'src/file-to-not-expose.ts',
                        content: 'export default function () {}',
                        exposeIndexFile: false,
                    },
                    {
                        path: 'src/file-to-not-expose-2.ts',
                        content: 'export default function () {}',
                    }
                ]
            }
        }
    }
});

Steps to Test or Reproduce

> git pull --prune
> git checkout feat/customize-index-files
> grunt jasmine
> yarn
> yarn build
> cd tests
> yarn
> yarn generate:multi-client

1. check generated clients in generated/multi-client/*
2. check index.ts in each client, it should only include files that were exposed (no models)
3. check zod client and see exports for ./extrafiles/index

[maastrich]

I've an update for the readme if you want me to add it in the pull request 👀

[melloware]

Sure

[maastrich]

Hey @melloware, I've pushed it with my last commit
b1b956f

[melloware]

OK i have added some others for review

[AllieJonsson]

Thanks for your contribution, I added a few comments!

[AllieJonsson]

We don't need to have the default value of the param here

[AllieJonsson]

Add a const defaultIndexFiles or similar and use it here and in the case where indexFiles is not a boolean

[AllieJonsson]

I'm not sure we should have a file like this, why not just add these cases to their respective config file react-query.config.ts and zod.config.ts?

[AllieJonsson]

If a user puts

{
  schemas: undefined
}

in the config, we will get undefined here. I'd suggest doing something like

const defaultIndex = {
  workspace: (implementations: string[]) => implementations,
  schemas: (schemas: GeneratorSchema[]) => schemas,
};

return {
  workspace: indexFiles.workspace ?? defaultIndex.workspace,
  schemas: indexFiles.schemas ?? defaultIndex.schemas,
};