Documenting objects with TsInfo? about vite-plugin-react-pages HOT 5 CLOSED

Thanks @csr632 , I will look into adding the features this week. Would you prefer that I add a PR to the dev/v4 branch? Also, is the CONTRIBUTING.md up to date on the steps needed to run / test locally?

from vite-plugin-react-pages.

Sorry for the late response!

For your use case, I think you can achieve you goal like this:

export interface Style {
  /** Style for the button */
  button: React.CSSProperties;
  /** @private */
  private: Object;
}

export interface TestIds {
  /** Test id for the root container */
  ROOT: "root-test-id";
}

export const styles = (theme): Style => {
  return {
    /** Style for the button */
    button: {},
    /** @private */
    private: {},
  };
};

export const testIds: TestIds = {
  /** Test id for the root container */
  ROOT: "root-test-id",
};

And you can extract the ts info like this:

<TsInfo src="./index.ts" name="Style" />
<TsInfo src="./index.ts" name="TestIds" />

This code may looks "repeated", because you need to define the properites twice, once in the type world and once in the value world.
But I think the repetition is ok because the typescript will make sure your type and your value are always consistant. So it will not become a maintenance burden. And the explicit type declaration make it more stable because you will be more careful when you make breaking changes to it, which is a great quality for documented features. What do you think?

Hiding @private or @internal properities is a great feature to have!

If you want to know how ts info extraction works and improve it, here is its implementation:

This is a very self-contained file (no external code dependency), so you can read and develop it without knowing too much context.

from vite-plugin-react-pages.

Would you prefer that I add a PR to the dev/v4 branch?

Yes, it will be easier to merge. Thanks!

is the CONTRIBUTING.md up to date on the steps needed to run / test locally?

The test setup has been migrated to playwright test. I will add more info to CONTRIBUTING.md this week.

from vite-plugin-react-pages.

CONTRIBUTING.md is updated on both main and dev/v4 branches.

from vite-plugin-react-pages.

TsInfo has been improved. Checkout #117 and https://stackblitz.com/fork/github/vitejs/vite-plugin-react-pages/tree/main/packages/create-project/template-lib?file=README.md&terminal=dev

from vite-plugin-react-pages.