Merge branch 'release/2.1.0'

Author: mrmckeb

README.md

@@ -143,13 +143,15 @@ The [internal `logger`](https://github.com/mrmckeb/typescript-plugin-css-modules
 | `less` | `{}`          | Set [renderer options for Less](http://lesscss.org/usage/#less-options).             |
 | `sass` | `{}`          | Set [renderer options for Sass](https://sass-lang.com/documentation/js-api#options). |
 
+> For convenience, `includePaths` for Sass are extended, not replaced. The defaults are the path of the current file, and `'node_modules'`.
+
 ### Visual Studio Code
 
 #### Recommended usage
 
 To use this plugin with Visual Studio Code, you should set your workspace's version of TypeScript, which will load plugins from your `tsconfig.json` file.
 
-For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/languages/typescript#_using-the-workspace-version-of-typescript).
+For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
 
 #### Alternative usage
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-plugin-css-modules",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "main": "lib/index.js",
   "author": "Brody McKee <[email protected]>",
   "license": "MIT",

src/helpers/__tests__/__snapshots__/getDtsSnapshot.test.ts.snap

@@ -210,3 +210,10 @@ Object {
   "section-9": "test-module__section-9---2EMR_",
 }
 `;
+
+exports[`utils / cssSnapshots with includePaths in sass options should find external file from includePaths 1`] = `
+Object {
+  "big-font": "include-path-module__big-font---Td7hY",
+  "class-with-mixin": "include-path-module__class-with-mixin---1u87_",
+}
+`;

src/helpers/__tests__/external/package/_external.module.scss

@@ -0,0 +1,9 @@
+@import 'mixin';
+
+.class-with-mixin {
+  @include set-margin(0);
+}
+
+.big-font {
+  font-size: 82px;
+}

src/helpers/__tests__/fixtures/include-path.module.scss

@@ -0,0 +1 @@
+@import 'package/external.module.scss';

src/helpers/__tests__/getDtsSnapshot.test.ts

@@ -63,7 +63,7 @@ describe('utils / cssSnapshots', () => {
     });
   });
 
-  describe(`with a custom renderer`, () => {
+  describe('with a custom renderer', () => {
     const fullFileName = 'exampleFileContents';
     const testFile = 'exampleFileName';
     const customRenderer = join(__dirname, 'fixtures', 'customRenderer.js');
@@ -80,4 +80,29 @@ describe('utils / cssSnapshots', () => {
       expect(mockLogger.log).toHaveBeenCalledWith('Example log');
     });
   });
+
+  describe('with includePaths in sass options', () => {
+    const fullFileName = join(
+      __dirname,
+      'fixtures',
+      'include-path.module.scss',
+    );
+    const testFile = readFileSync(fullFileName, 'utf8');
+
+    it('should find external file from includePaths', () => {
+      const classes = getClasses(
+        processor,
+        testFile,
+        fullFileName,
+        {
+          rendererOptions: {
+            sass: { includePaths: [join(__dirname, 'external')] },
+          },
+        },
+        mockLogger,
+      );
+
+      expect(classes).toMatchSnapshot();
+    });
+  });
 });

src/helpers/getClasses.ts

@@ -52,12 +52,13 @@ export const getClasses = (
       );
     } else if (fileType === FileTypes.scss) {
       const filePath = getFilePath(fileName);
+      const { includePaths, ...sassOptions } = rendererOptions.sass || {};
 
       transformedCss = sass
         .renderSync({
           data: css,
-          includePaths: [filePath],
-          ...(rendererOptions.sass || {}),
+          includePaths: [filePath, 'node_modules', ...(includePaths || [])],
+          ...sassOptions,
         })
         .css.toString();
     } else {