fix(module-type-aliases): add svg declaration

[MisterFISHUP]

Motivation

Try to fix #3424 (comment) by adding module declarations in packages/docusaurus-module-type-aliases/src/index.d.ts:

Currently, if one uses import ending with .module.scss, .scss, .svg in a .tsx file, VSCode (ESLint) will display errors like:

Cannot find module '[some_file].module.scss' or its corresponding type declarations.
Cannot find module '[some_file].scss' or its corresponding type declarations.
Cannot find module '[some_file].svg' or its corresponding type declarations.

These errors don't appear in .js files.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Just tested with yarn run start (after cd website), yarn prettier, yarn lint, and yarn test.

[armano2]

i can agree with svg being in there, but user should define it themself for scss ans sass

[Josh-Cena]

Thanks, I agree with @armano2—afaik we don't have SASS & SCSS loaders OOTB, do we? Do they work without any extra configuration?

[netlify]

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 6c677b9

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61912aabd2f148000862437d

😎 Browse the preview: https://deploy-preview-5945--docusaurus-2.netlify.app

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	77
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-5945--docusaurus-2.netlify.app/

[MisterFISHUP]

Thanks @Josh-Cena @armano2. Tell me if I should remove the scss/module.scss parts or move them to another file. As I mentioned in the description, any imports ending with .scss or .module.scss in a .tsx file will have Cannot find module... errors, even I set up the project with ts, scss supports.

[Josh-Cena]

@MisterFISHUP You could do it in your own project: add a types.d.ts file in src and declare the scss and module.scss modules.

[MisterFISHUP]

You could do it in your own project: add a types.d.ts file in src and declare the scss and module.scss modules.

That's what I did 😄. Anyway, thanks for your reply @Josh-Cena. I also changed the title of the PR.

[MisterFISHUP]

@Josh-Cena I'm not sure if I did this correctly, so I would like to ask your opinion before making the commit:

// in `packages/docusaurus-module-type-aliases/src/index.d.ts`
declare module '*.svg' {
  import type { ComponentType, SVGProps } from 'react';

  const ReactComponent: ComponentType<SVGProps<SVGSVGElement>>;

  export default ReactComponent;
}

Thank you for your time

[Josh-Cena]

Yeah, I think that looks better