Soon: May use extends about tslint-eslint-rules

[buzinas]

Can you explain how it affects this library, please?

[unional]

Currently I'm discussing with @jkillian about how to handle rulesDirectory.
See this comment: palantir/tslint#1016 (comment)
The issue is the relative path through node_modules as it is different between npm 2/3+.

My opinion is that consumer should not reference things in node_modules directly as in your example in README

{
  "rulesDirectory": "node_modules/tslint-eslint-rules/dist/rules"
}

If use the extends feature, then it can be a local path, i.e.:
palantir/tslint#1016 (comment)

Right now I'm waiting for palantir/tslint#1035 to goes in so I can refactor the code. Please feel free to join the discussion. 🍺

[buzinas]

Can't your project be a peer dependency to mine, instead of a true dependency?

[unional]

If it is a peer dependency, that means the user need to aware of using tslint-eslint-rules and also do the rulesDirectory: "node_modules/tslint-eslint-rules/dist/rules" themselves in order for it to work.

i.e., the user need to:

npm i tslint tslint-config-unional tslint-eslint-rules

{
  "extends": "tslint-config-unional",
  "rulesDirectory": "node_modules/tslint-eslint-rules/dist/rules"
}

instead of:

npm i tslint tslint-config-unional

{
  "extends": "tslint-config-unional"
}

[buzinas]

Merged #59, and hopefully @jkillian will be handling that inside TSLint.

[unional]

extends has landed. Now your user can reference your package through:

{
  "extends": "tslint-eslint-rules"
}

What you need is in your own tslint.json:

{
  "rulesDirectory": "./dist/rules"
}

Cheers,
Unional

🌹

[buzinas]

Thanks, @unional! Good job :)

[jkillian]

Just to follow up on this, might be worth making this small tweak! It shouldn't break anything for users who are using your package in other ways, but will let new users use extends if they want to. @unional want to make a PR for this?

[unional]

I'm busy until end of next week. Can do it by then if it is not done sooner. :)