Prepare package for publishing

Author: mrmckeb

.npmignore

@@ -0,0 +1,9 @@
+/.vscode
+/node_modules
+/src
+.editorconfig
+npm-debug.log
+tsconfig.json
+tslint.json
+yarn-error.log
+yarn.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Brody McKee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,72 @@
+# typescript-plugin-css-modules
+
+A [TypeScript language service plugin](https://github.com/Microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin)
+for [CSS Modules](https://github.com/css-modules/css-modules).
+
+This project was inspired by this [`create-react-app` issue](https://github.com/facebook/create-react-app/issues/5677)
+and is heavily based on [`css-module-types`](https://github.com/timothykang/css-module-types).
+
+## Usage
+
+To install with Yarn:
+
+```sh
+yarn add typescript-plugin-css-modules
+```
+
+To install with npm:
+
+```sh
+npm install --save typescript-plugin-css-modules
+```
+
+Once installed, add this plugin to your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [{ "name": "typescript-plugin-css-modules" }]
+  }
+}
+```
+
+You can also pass in your own file extension matcher (the default matcher is shown as an example):
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "typescript-plugin-css-modules",
+        "options": {
+          "customMatcher": "\\.module\\.(sa|sc|c)ss$"
+        }
+      }
+    ]
+  }
+}
+```
+
+### Custom definitions
+
+Depending on your project configuration, you may also need to declare modules. Where you store this is up to you. An
+example might look like: `src/@types/custom.d.ts`.
+
+The below is an example that you can modify if you use a `customMatcher`.
+
+```ts
+declare module '*.module.css' {
+  const classes: { [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.scss' {
+  const classes: { [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.sass' {
+  const classes: { [key: string]: string };
+  export default classes;
+}
+```

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "typescript-css-modules",
-  "version": "1.0.0",
+  "name": "typescript-plugin-css-modules",
+  "version": "0.1.0",
   "main": "lib/index.js",
-  "repository": "git@github.com:mrmckeb/typescript-css-modules.git",
+  "repository": "git@github.com:mrmckeb/typescript-plugin-css-modules.git",
   "author": "Brody McKee <mrmckeb@hotmail.com>",
   "license": "MIT",
   "description": "CSS modules support for TypeScript",
@@ -15,12 +15,14 @@
     "typescript"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf ./lib && tsc",
+    "prepublish": "yarn build",
     "test": "jest"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "pretty-quick --staged"
+      "pre-commit": "pretty-quick --staged",
+      "pre-push": "yarn test"
     }
   },
   "jest": {

src/index.ts

@@ -1,6 +1,5 @@
 import * as path from 'path';
 import * as ts_module from 'typescript/lib/tsserverlibrary';
-import { types } from 'util';
 import { isCSS as _isCSS, isRelativeCSS } from './helpers/cssExtensions';
 import { getDtsSnapshot } from './helpers/cssSnapshots';
 
@@ -18,7 +17,7 @@ function init({ typescript: ts }: { typescript: typeof ts_module }) {
         isCSS = (fileName) => new RegExp(customMatcher).test(fileName);
       }
     } catch (e) {
-      // There doesn't appear to be a way to throw warnings yet.
+      // TODO: Provide error/warning to user.
     }
 
     // Creates new virtual source files for the CSS modules.

tsconfig.json

@@ -14,5 +14,6 @@
     "strict": true,
     "strictNullChecks": true,
     "target": "es5"
-  }
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
 }