@debitoor/tslint-config-debitoor

tslint-config-debitoor

DEPRECATED! Please use our typescript-eslint-config module instead.

Defines global linting rules for Debitoor typescript porojects

You can find all tslint rules here.

Usage

npm i -DE @debitoor/tslint-config-debitoor
npm i -DE tslint
npm i -DE mocha-tslint
echo "import * as path from 'path';require('mocha-tslint')(path.join(__dirname, '..', 'tslint.json'));" > test/tslint.spec.js
echo "module.exports = { "extends": "@debitoor/tslint-config-debitoor" };" > tslint.json

Or add a tslint.json file in the root of your project, and extend it with the Debitoor config:

{
	'extends': '@debitoor/tslint-config-debitoor'
}

Add tests

Install mocha-tslint:

npm install -DE mocha-tslint

and add a a spec file tslint.spec.js in your test folder, where you specify the path to your tslint config file, and an array of folders to test in:

import * as path from 'path';
require('mocha-tslint')(path.join(__dirname, '..', 'tslint.json')[
	'test',
	'src',
	]);

or lint all files that are placed in a folder in src:

import * as path from 'path';
require('mocha-tslint')(path.join(__dirname, '..', 'tslint.json'), 'src/*');

or leave out the array to just lint everything from the directory of your tslint.json.

import * as path from 'path';
require('mocha-tslint')(path.join(__dirname, '..', 'tslint.json'));

npm mocha-tslint

License

MIT License

Copyright (c) 2018 Debitoor

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.