Merge pull request #21 from roydukkey/issue/20

Add TypeScript support for Sass/SCSS modules

README.md

@@ -78,7 +78,16 @@ function MyComponent() {
 }
 ```
 
+### TypeScript support
 
+To enable TypeScript support for Sass/SCSS modules, the TypeScript configuration should be updated to add the `docusaurus-plugin-sass` type definitions. This can be done in the `tsconfig.json` file:
 
-
-
+```diff
+{
+  "extends": "@tsconfig/docusaurus/tsconfig.json",
+  "compilerOptions": {
+    ...
++    "types": ["docusaurus-plugin-sass"]
+  }
+}
+```

docusaurus-plugin-sass.d.ts

@@ -0,0 +1,19 @@
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const src: string;
+  export default src;
+}
+
+declare module '*.sass' {
+  const src: string;
+  export default src;
+}

package.json

@@ -3,6 +3,7 @@
   "version": "0.2.4",
   "description": "Docusaurus plugin to provide support for SASS/SCSS",
   "main": "docusaurus-plugin-sass.js",
+  "types": "docusaurus-plugin-sass.d.ts",
   "dependencies": {
     "sass-loader": "^10.1.1"
   },