docs(typescript): readme copy/paste mistake

[emme1444]

Rollup Plugin Name: typescript

This PR contains:

• bugfix
• feature
• refactor
• documentation
• other

Are tests included?

• yes (bugfixes and features will not be merged without tests)
• no

Breaking Changes?

• yes (breaking changes will not be merged unless absolutely necessary)
• no

If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.

List any relevant issue numbers:

Description

Fix typescript readme copy/paste mistake.

What is Wrong?

1. In the factory of type: 'typeChecker' I do not see a declaration for the variable program, which is passed into the TypeCheckerRequiringTransformerFactory.
2. TypeCheckerRequiringTransformerFactory seems, to me, to require a TypeChecker, however is receiving a Program.
3. The factory's parameter typeChecker is unused.

[shellscape]

This doesn't look like a typo. We'll need far more information on why you feel this is a "typo"

[dnalborczyk]

just a bad guess, but it surely looks like a copy/paste mistake. there's no reference to program for type: 'typeChecker'

before: [
      {
        // Allow the transformer to get a Program reference in it's factory
        type: 'program',
        factory: (program) => {
          return ProgramRequiringTransformerFactory(program);
        }
      },
      {
        type: 'typeChecker',
        factory: (typeChecker) => {
          // Allow the transformer to get a Program reference in it's factory
          return TypeCheckerRequiringTransformerFactory(program);
        }
      }
    ],

[emme1444]

@shellscape are you asking strictly about the wording? Is a "copy/paste mistake" better? Otherwise I don't see why you would need more information?

@dnalborczyk correct. This was the problem I was trying to solve.

1. In the factory of type: 'typeChecker' I do not see a declaration for the variable program, which is passed into the TypeCheckerRequiringTransformerFactory.
2. TypeCheckerRequiringTransformerFactory seems, to me, to require a TypeChecker, however is receiving a Program.
3. The factory's parameter typeChecker is unused.

I could have misunderstood something.

[shellscape]

@emme1444 it doesn't look like you have much public repo activity, so that might mean limited experience in contributing to a repo like this: "Fix typescript readme typo." is not an acceptable description of a pull request. I want to see why you feel the change was necessary and why the thing that exists is incorrect. That means people looking at the blame or commit log will be able to reference the PR and have context for the change. That is the bar we have set for this repo and the quality of our pull requests and commits.

[emme1444]

I will fix the commit in the morning.

@shellscape please let me know if there is more information to provide.

I do feel like you could have helped someone less experienced, like me, more in your first comment.

I also feel like an issue like this would rarely be sought after or even remotely cared about when sifting through the logs. Thus I did not feel the need to clearly explain myself. However I do think that calling it a "typo" was a mistake.

Thanks!