test(react-query): add tsd

[manudeli]

ISSUE CLOSED: #86

This is continuous PR along #73 to add tsd for testing typescript type
#73 (comment)

TSD set up with some code

import { expectType } from 'tsd';
import { SuspendedUseQueryResultOnIdle, SuspendedUseQueryResultOnSuccess, useSuspendedQuery } from '../dist';

const queryKey = ['example'] as const;
const queryFn = async () => 'response';

/* eslint-disable react-hooks/rules-of-hooks */
expectType<SuspendedUseQueryResultOnSuccess<'response'>>(useSuspendedQuery(queryKey, queryFn));
expectType<SuspendedUseQueryResultOnSuccess<'response'>>(useSuspendedQuery(queryKey, queryFn, { enabled: true }));
expectType<SuspendedUseQueryResultOnIdle<undefined>>(useSuspendedQuery(queryKey, queryFn, { enabled: false }));
expectType<SuspendedUseQueryResultOnSuccess<'response'> | SuspendedUseQueryResultOnIdle<undefined>>(
  useSuspendedQuery(queryKey, queryFn, { enabled: Boolean(Math.random() > 0.5) })
);

Could you together check that tsd really require @yarnpkg/pnpify in yarn/berry please?

I think TSD need @yarnpkg/pnpify in yarn/berry environment. but I can't be confident on it

when i first setup tsd in my personal project using yarn classic, tsd worked really fine.
but if no @yarnpkg/pnpify in yarn/berry environment like @toss/slash, when I exucute yarn tsd, I met cannot find module tsd, react-query error.

after paying to find proper solution, I met this solution on issue in SamVerschueren/tsd using @yarnpkg/pnpify

PR Checklist

• I read and included theses actions below

1. I have read the Contributing Guide
2. I have written documents and tests, if needed.

[netlify]

👷 Deploy request for slash-libraries pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	7089f51

[manudeli]

I chained pnpify tsd after original build
It will make error in process of build if there is error in tsd code.

check that it is fine please

[raon0211]

Why not running tests in the test script, rather than build? We always check if the test passes before a PR is merged.

[manudeli]

@raon0211
I want to split it(pnpify tsd) from yarn build too.
but cannot find any code that execute just only test before a PR is merged.
Where can i check that code?

I found only circleci using jest in .circleci/config.yml, not yarn test.
Isn't test just used as just naming, right?

Is there any setting executing yarn test not visible for me?
or Could you help me check it out please?

[hoseungme]

Yes, It looks so @manudeli .

But, despite it, I think running tsd in build script is not appropriate.
We can do other better things like adding tsd test step to Circle CI config, or etc.

We will tell you about it soon, thanks!

[manudeli]

@hoseungjang Okay.
I removed tsd in script:build and added a script:tsd seperately in this commit fb022af.
this script:tsd is intended to be easy to use whether anyone know pnpify is required to use tsd on yarn berry project or not.

  "scripts": {
    "build": "rm -rf dist esm && tsc --declaration --emitDeclarationOnly --declarationDir dist && rollup -c rollup.config.js",
    "prepack": "yarn build",
    "test": "echo \"no test specified.\"",
    "tsd": "pnpify tsd", // added: to use tsd on yarn berry
    "typecheck": "tsc --noEmit"
  },

If anyone have used script build, it will make definition files so you can use tsd after.
How about next new Pull Request for doing better thing that you said after merging this Pull Request?

[raon0211]

We are discussing this. Please wait a bit 🙏

[artechventure]

Seperating tsd script and adding that in prepack lifecycle seems good to me.
But like you said, it would be better to do it in the new PR.
This seems fine to merge.

  "scripts": {
    "prepack": "yarn build && yarn tsd",
    "tsd": "pnpify tsd"
  },

[manudeli]

I fixed scripts as what you comment in a42814c

thanks for your guide :)

[manudeli]

if no eslint-disable comment, eslint emit error like below. so I added it