Skip to content

Commit fda898a

Browse files
committed
Update docs and bump version
1 parent c350ce7 commit fda898a

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,15 @@ The [internal `logger`](https://github.com/mrmckeb/typescript-plugin-css-modules
143143
| `less` | `{}` | Set [renderer options for Less](http://lesscss.org/usage/#less-options). |
144144
| `sass` | `{}` | Set [renderer options for Sass](https://sass-lang.com/documentation/js-api#options). |
145145

146+
> For convenience, `includePaths` for Sass are extended, not replaced. The defaults are the path of the current file, and `'node_modules'`.
147+
146148
### Visual Studio Code
147149

148150
#### Recommended usage
149151

150152
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.
151153

152-
For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/languages/typescript#_using-the-workspace-version-of-typescript).
154+
For instructions, see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
153155

154156
#### Alternative usage
155157

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "typescript-plugin-css-modules",
3-
"version": "2.0.2",
3+
"version": "2.1.0",
44
"main": "lib/index.js",
55
"author": "Brody McKee <mrmckeb@hotmail.com>",
66
"license": "MIT",

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
// Jest Snapshot v1, https://goo.gl/fbAQLP
22

3-
exports[`utils / cssSnapshots includePaths in sass options should find external file from includePaths 1`] = `
4-
Object {
5-
"big-font": "include-path-module__big-font---Td7hY",
6-
"class-with-mixin": "include-path-module__class-with-mixin---1u87_",
7-
}
8-
`;
9-
103
exports[`utils / cssSnapshots with a custom renderer should process a file and log 1`] = `
114
Object {
125
"exampleFileContents": "exampleFileContents__exampleFileContents---e3Nf2",
@@ -217,3 +210,10 @@ Object {
217210
"section-9": "test-module__section-9---2EMR_",
218211
}
219212
`;
213+
214+
exports[`utils / cssSnapshots with includePaths in sass options should find external file from includePaths 1`] = `
215+
Object {
216+
"big-font": "include-path-module__big-font---Td7hY",
217+
"class-with-mixin": "include-path-module__class-with-mixin---1u87_",
218+
}
219+
`;

src/helpers/__tests__/getDtsSnapshot.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ describe('utils / cssSnapshots', () => {
6363
});
6464
});
6565

66-
describe(`with a custom renderer`, () => {
66+
describe('with a custom renderer', () => {
6767
const fullFileName = 'exampleFileContents';
6868
const testFile = 'exampleFileName';
6969
const customRenderer = join(__dirname, 'fixtures', 'customRenderer.js');
@@ -81,7 +81,7 @@ describe('utils / cssSnapshots', () => {
8181
});
8282
});
8383

84-
describe('includePaths in sass options', () => {
84+
describe('with includePaths in sass options', () => {
8585
const fullFileName = join(
8686
__dirname,
8787
'fixtures',

0 commit comments

Comments
 (0)