preparations for npm publish

.gitignore

@@ -28,7 +28,6 @@ build/Release
 
 # Dependency directories
 node_modules
-jspm_packages
 
 # Optional npm cache directory
 .npm
@@ -41,5 +40,4 @@ jspm_packages
 *.iml
 
 # built atrifacts
-build
 dist

.istanbul.yml

@@ -1,6 +1,5 @@
 verbose: false
 instrumentation:
-    root: ./build
     extensions:
         - .js
     default-excludes: true
@@ -10,4 +9,3 @@ reporting:
     print: summary
     reports:
         - lcov
-    dir: ./coverage

.npmignore

@@ -0,0 +1,8 @@
+.idea/
+src/
+.travis.yml
+.npmignore
+.istanbul.yml
+.editorconfig
+runTests.js
+tsconfig.json

README.md

@@ -1,12 +1,40 @@
 [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][deps-image]][deps-url] [![dev-dependencies][dev-deps-image]][dev-deps-url]
 
+[![NPM][npm-image]][npm-url]
+
 # tslint-rules
 
 A set of custom [TSLint](https://github.com/palantir/tslint) rules.
 
-## Available Rules
 
-### `import-barrels`
+# Usage
+
+Install from npm to your devDependencies:
+```
+npm install --save-dev custom-tslint-rules
+```
+
+Configure tslint to use the custom-tslint-rules folder:
+
+Add the following path to the `rulesDirectory` setting in your `tslint.json` file:
+
+```json
+{
+   "rulesDirectory": [
+     "node_modules/custom-tslint-rules/dist"
+   ],
+   "rules": {
+     ...
+   }
+}
+```
+
+Now configure some of the new rules.
+
+
+# Available Rules
+
+## `import-barrels`
 
 Enforces usage of barrels (`index.ts`) when importing from a directory that has a barrel file.
 
@@ -33,7 +61,7 @@ An argument object may be optionally provided, with the following properties:
 * `fileExtensions = ['ts', 'js']`: uses the provided file extensions for module and barrel file lookup
 
 
-### `jasmine-no-lambda-expression-callbacks`
+## `jasmine-no-lambda-expression-callbacks`
 
 Disallows usage of ES6-style lambda expressions as callbacks to Jasmine BDD functions.  
 
@@ -74,4 +102,6 @@ Not configurable.
 [deps-image]: https://img.shields.io/david/BendingBender/tslint-rules.svg?style=flat-square
 [deps-url]: https://david-dm.org/BendingBender/tslint-rules
 [dev-deps-image]: https://img.shields.io/david/dev/BendingBender/tslint-rules.svg?style=flat-square
-[dev-deps-url]: https://david-dm.org/BendingBender/tslint-rules?type=dev
+[dev-deps-url]: https://david-dm.org/BendingBender/tslint-rules?type=dev
+[npm-image]: https://nodei.co/npm/custom-tslint-rules.png
+[npm-url]: https://npmjs.org/package/custom-tslint-rules

package.json

@@ -4,16 +4,18 @@
   "description": "Custom rules for tslint",
   "main": "tslint.json",
   "scripts": {
+    "build": "tsc -p tsconfig.json --outDir ./dist",
+    "build:clean": "npm run clean && npm run build",
     "ci": "npm run cover && npm run coveralls && npm run lint",
-    "clean": "rimraf build coverage",
+    "clean": "rimraf dist coverage",
     "coveralls": "cat coverage/lcov.info | coveralls",
     "precover": "npm run build:clean",
-    "cover": "istanbul cover runTests.js -- --coverage && istanbul report",
-    "build": "tsc -p tsconfig.json",
-    "build:clean": "npm run clean && npm run build",
+    "cover": "istanbul cover --root ./dist --dir ./coverage runTests.js -- -b ./dist -c ./coverage && istanbul report --dir ./coverage",
+    "dist": "npm run clean && npm test && npm run lint && rimraf dist/tests",
     "lint": "tslint 'src/**/*.ts'",
-    "pretest": "npm run build:clean",
-    "test": "node runTests.js"
+    "prepublish": "npm run dist",
+    "pretest": "npm run build",
+    "test": "node runTests.js -b ./dist"
   },
   "repository": {
     "type": "git",
@@ -43,5 +45,8 @@
   },
   "dependencies": {
     "lodash": "^4.16.4"
+  },
+  "engines": {
+    "node": ">=4"
   }
 }

runTests.js

@@ -1,14 +1,26 @@
 'use strict';
 
+const argv = require('yargs')
+  .usage('Usage: $0 --buildDir [path] --coverage [path]')
+  .alias({
+    'b': 'buildDir',
+    'c': 'coverage'
+  })
+  .nargs({
+    'b': 1,
+    'c': 1
+  })
+  .demand(['b'])
+  .argv;
+
 const glob = require('glob');
 const path = require('path');
 const child_process = require('child_process');
-const argv = require('yargs').argv;
 
 const tslintCommand = path.resolve('./node_modules/.bin/tslint');
 const istanbulCommand = path.resolve('./node_modules/.bin/istanbul');
-const buildDir = path.resolve('./build');
-const coverageDir = path.resolve('./coverage');
+const buildDir = path.resolve(argv.buildDir);
+const coverageDir = path.resolve(argv.coverage || '');
 
 glob('src/tests/**/*.ts.lint', (error, files) => {
   if (error) {

src/tests/importBarrels/default/tslint.json

@@ -1,6 +1,6 @@
 {
   "rulesDirectory": [
-    "../../../../build"
+    "../../../../dist"
   ],
   "rules": {
     "import-barrels": true

src/tests/importBarrels/no-explicit-barrels/tslint.json

@@ -1,6 +1,6 @@
 {
   "rulesDirectory": [
-    "../../../../build"
+    "../../../../dist"
   ],
   "rules": {
     "import-barrels": [

src/tests/importBarrels/with-extension-list/tslint.json

@@ -1,6 +1,6 @@
 {
   "rulesDirectory": [
-    "../../../../build"
+    "../../../../dist"
   ],
   "rules": {
     "import-barrels": [

src/tests/jasmineNoLambdaExpressionCallback/default/tslint.json

@@ -1,6 +1,6 @@
 {
   "rulesDirectory": [
-    "../../../../build"
+    "../../../../dist"
   ],
   "rules": {
     "jasmine-no-lambda-expression-callbacks": true

tsconfig.json

@@ -12,7 +12,6 @@
     "noImplicitAny": true,
     "suppressImplicitAnyIndexErrors": true,
     "baseUrl": "./src",
-    "outDir": "./build",
     "paths": {},
     "lib": [
       "es6"