New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CLI #292
Comments
What does this refer to? Solution: you list several ideas. Which are most important?
Why should this CLI also do things that TS does for |
type safety
Type checking to begin with. I think most people use MDX with a framework to build a website. For such cases emitting files is not really important, that would be mostly for libraries.
The language service already needs all of these files to get a full context of the project. I don’t think it will take any extra effort to emit the JavaScript files. In fact, flags that clean the output directory might get in the way when using both |
YES!! This is a dream come true to see these discussions happening. I have a project with a bunch of .mdx files with complex data imports etc, and for a long time I have wished there was a pipeline for type checking these files. This kind of thing will let mdx fly as a first class citizen in the growing world of TypeScript development! 🚀 |
Potentially related to #298, Volar is working on a Scripts API:
|
Do you know of an example of a library that has several MDX files that it exposes?
Couldn’t TypeScript perform type checking? What’s the reason a different program is needed to do that?
Maybe it isn’t a lot of work to implement your ideas, but I would also like to hear a benefit for why code should exists?
What is the reason for one CLI ( |
No.
TypeScript can’t handle MDX, not for editor features, nor type checking.
I don’t consider this doing two things. Type checking and emitting both fall in the category of making a CLI like
I consider the first two points to be more or less the same thing, with slightly different options. The last point is more interesting. Currently we have MDX and
I think this issue will become redundant and we should hook into Volar at some point to get all their TypeScript related features, including a CLI, without having to maintain this separately. |
I don’t think I understand you at all, because as far as I understand, TypeScript can check types if someone authors types. You yourself have documented that it works: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/b92231c3ef87e84860ea674ec38d8e694e5dc64e/types/mdx/index.d.ts#L47-L53. |
Initial checklist
Problem
In addition to type safety in editors, it would be nice if this can be validated in CI, similar to
tsc
.Solution
Create a new package,
@mdx-js/cli
.Some potential features of the CLI are:
.d.ts
and.js
files for TypeScript, JavaScript, JSX, and MDXunified-engine
Alternatives
The idea is pretty vague still. There are many potential additional features and alternatives.
The text was updated successfully, but these errors were encountered: