Skip to content

Commit

Permalink
chore(docs): enhance README.md documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
imjuni committed Aug 12, 2024
1 parent 8b6cf17 commit c2d7e8f
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,8 @@ The export syntax in the `index.ts` file is determined by the chosen generation

When `ctix` generates the `index.ts` file, it uses [prettier](https://prettier.io/) and [prettier-plugin-organize-imports](https://www.npmjs.com/package/prettier-plugin-organize-imports) to check if the files to be exported are used. During this process, files that only contain `declare module` are excluded. This can cause issues if you intend to bundle type files. However, if you add `@ctix-declaration` to the file, it will be included in the `index.ts` file. Keep in mind that `@ctix-declaration` is applied after the exclude option, so make sure the file is not included in the exclude option.

> @ctix-declaration does not work when used with export statements in the same file.
```ts
/** @ctix-declaration */

Expand Down

0 comments on commit c2d7e8f

Please sign in to comment.