add some documentation

Alasdair McLeay · Alasdair McLeay · commit 30b54690cfde · 2019-03-20T18:05:56.000Z
diff --git a/extensions/css-language-features/server/src/utils/documentContext.ts b/extensions/css-language-features/server/src/utils/documentContext.ts
@@ -40,11 +40,15 @@ export function getDocumentContext(documentUri: string, workspaceFolders: Worksp
 					}
 				}
 			}
+			// Following [css-loader](https://github.com/webpack-contrib/css-loader#url)
+			// and [sass-loader's](https://github.com/webpack-contrib/sass-loader#imports)
+			// convention, if an import path starts with ~ then use node module resolution
+			// *unless* it starts with "~/" as this refers to the user's home directory.
 			if (ref[0] === '~' && ref[1] !== '/') {
 				const moduleName = getModuleNameFromPath(ref.substring(1));
 				const modulePath = require.resolve(moduleName, { paths: [base] });
-				const pathInModule = ref.substring(moduleName.length + 2);
-				return url.resolve(modulePath, pathInModule);
+				const pathWithinModule = ref.substring(moduleName.length + 2);
+				return url.resolve(modulePath, pathWithinModule);
 			}
 			return url.resolve(base, ref);
 		},

Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,15 @@ export function getDocumentContext(documentUri: string, workspaceFolders: Worksp`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`}`
	`43`	`+ // Following [css-loader](https://github.com/webpack-contrib/css-loader#url)`
	`44`	`+ // and [sass-loader's](https://github.com/webpack-contrib/sass-loader#imports)`
	`45`	`+ // convention, if an import path starts with ~ then use node module resolution`
	`46`	`+ // unless it starts with "~/" as this refers to the user's home directory.`
`43`	`47`	`if (ref[0] === '~' && ref[1] !== '/') {`
`44`	`48`	`const moduleName = getModuleNameFromPath(ref.substring(1));`
`45`	`49`	`const modulePath = require.resolve(moduleName, { paths: [base] });`
`46`		`- const pathInModule = ref.substring(moduleName.length + 2);`
`47`		`- return url.resolve(modulePath, pathInModule);`
	`50`	`+ const pathWithinModule = ref.substring(moduleName.length + 2);`
	`51`	`+ return url.resolve(modulePath, pathWithinModule);`
`48`	`52`	`}`
`49`	`53`	`return url.resolve(base, ref);`
`50`	`54`	`},`