Typescript support on nodejs
3axap4eHko opened this issue · 15 comments
Initial checklist
- I read the support docs
- I read the contributing guide
- I agree to follow the code of conduct
- I searched issues and couldn’t find anything (or linked relevant results below)
Affected packages and versions
14.0.1
Link to runnable example
Steps to reproduce
- Install
remark,remark-html,typescript - execute the following code using
ts-node
import { remark } from 'remark';
import remarkHTML from 'remark-html';
const htmlContent = `
### Hello world!
`;
(async () => {
const content = await remark().use(remarkHTML).process(htmlContent);
console.log(content);
})();
Expected behavior
I expect to see <h3>Hello world!</h3>
Actual behavior
Error Cannot use import statement outside a module
Runtime
Node v16
Package manager
yarn v2
OS
Linux
Build and bundle tools
No response
Hi there!
This is because of ESM.
Please see the changelog for v14 and the resources linked from there (which is also references from the install sections in the readmes): https://github.com/remarkjs/remark/releases/tag/14.0.0.
Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.
Hi! Thanks for reaching out! Because we treat issues as our backlog, we close issues that are questions since they don’t represent a task to be completed.
See our support docs for how and where to ask questions.
Thanks,
— bb
@wooorm any suggestions on how can I handle this on typescript?
Sure. See the TS section in that linked post: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#how-can-i-make-my-typescript-project-output-esm
@wooorm it does not help, I'm facing the same error message in my app and ts playground
I even can simplify the code
import { remark } from 'remark';
remark()
It sounds like you don't have a package.json with a type: 'module' field?
@wooorm this is an example https://gist.github.com/3axap4eHko/5b787dae3ad3c07473ed0d424fefff99
Thanks, right, that’s still missing "type": "module" in package.json
Exactly, and it does not work if I set "type": "module"
Could you please post the issue that arises when you do?
Jeez, my friend, you are not just using TypeScript. You are using Jest and ts-node, which (most importantly Jest) are bad at modules.
It’s okay using TS and ts-node with modules, but Jest is really really bad at it.
There are lots of ways around it, as can be seen in that FAQ, but I’d say: use the previous version of remark for now. It’s all possible, but a bit of a messy situation, which might not be worth your time now
To add on, using remark with TypeScript is fairly straight forward https://stackblitz.com/edit/http-server-quvryg?file=example.ts is an example of how it works, just the few configuration tweaks mentioned in https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#how-can-i-make-my-typescript-project-output-esm makes TypeScript happy, plus it can also use top level await.
As @wooorm notes, using Jest with ESM currently can a bit more involved, but the Jest team is working to improve ESM support, you can track the progress of that initiative here: jestjs/jest#9430
Hi there!
This is because of ESM. Please see the changelog for v14 and the resources linked from there (which is also references from the install sections in the readmes): https://github.com/remarkjs/remark/releases/tag/14.0.0.
I think it's best to provide a commonJS version, otherwise libraries like Jest won't work.
Many well-known libraries provide both ESM and commonjs versions, and UMD versions suitable for browsers if necessary.
I recommend using a different test framework that Jest. Dual doesn’t work well in my experience.
We’ve had this discussion already. This isn’t bringing new information to that discussion. To prevent that from happening further, I’m locking this issue.