@fimbul/bifrost

Bifröst

Compatiblity layer for TSLint rules and formatters.

Make sure to also read the full documentation of all available modules.

Purpose

Allows TSLint rule authors to provide the same rules for Wotan without any refactoring. Although @fimbul/heimdall already allows users to use your rules and formatters in Wotan, they still need to remember to use -m @fimbul/heimdall when running Wotan. You can help these users by providing your rules in a format that Wotan understands without any plugin.

It also provides the exact opposite functionality: using rules originally written for Fimbullinter (wotan) as TSLint rule.

Installation

npm install --save @fimbul/bifrost
# or
yarn add @fimbul/bifrost

Using TSLint Rules and Formatters in Wotan

Rules

Given a TSLint rule my-foo in a file myFooRule.ts, you simply create a file my-foo.ts with the following content:

import {wrapTslintRule} from '@fimbul/bifrost';
import {Rule} from './myFooRule.ts';

const Wrapped = wrapTslintRule(Rule, 'my-foo');
export {Wrapped as Rule};

If you want to use a different directory for your TSLint rules and their Wotan wrapper, you just need to adjust the paths in the above example.

Formatters

Given a TSLint formatter my-foo in a file myFooFormatter.ts, you simply create a file my-foo.ts with the following content:

import {wrapTslintFormatter} from '@fimbul/bifrost';
import {Formatter} from './myFooFormatter.ts';

const Wrapped = wrapTslintFormatter(Formatter);
export {Wrapped as Formatter};

Note that findings with severity suggestion are reported as warning through TSLint formatters.

Using Fimbullinter Rules in TSLint

Given a Fimbullinter rule my-foo in a file my-foo.ts, you simply create a file myFooRule.ts with the following content:

import {wrapRuleForTslint} from '@fimbul/bifrost';
import {Rule} from './my-foo.ts';

const Wrapped = wrapRuleForTslint(Rule);
export {Wrapped as Rule};

License

Apache-2.0 © Klaus Meinhardt

Changelog

v0.17.0

:tada: This release introduces a plugin for TypeScript's LanguageService. This enables in-editor linting while you type. See the docs for more details.

:warning: Breaking Changes:

• TypeScript 2.8 and 2.9 is no longer supported
• API:
  • Failure was renamed to Finding throughout the codebase
  • Resolver adds a new required method getDefaultExtensions
  • Resolver#resolve makes parameters basedir and extensions optional
  • Runner requires a new service FileFilterFactory
  • added severity suggestion

Features:

• new package @fimbul/mithotyn provides in-editor linting through a TypeScript LanguageService Plugin
• new severity: suggestion
• --fix can no longer introduce syntax errors
• async-function-assignability: checks methods and properties with computed names
• async-function-assignability: checks method overloads individually
• new service abstraction FileFilterFactory and FileFilter allow customizing which files are linted
• @fimbul/ve no longer includes the line break after the opening tag in the linted code
• @fimbul/ve correctly adjusts the column of findings in the first line if there is no line break after the opening tag
• prefer-number-methods: fixed finding location

Bugfixes:

• declaration files no longer contain const enum
• core services no longer rely on the existence of require
• YAML configuration can now contain YAML-specific types