Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

What's public? #2446

Closed
andy-hanson opened this issue Mar 31, 2017 · 4 comments
Closed

What's public? #2446

andy-hanson opened this issue Mar 31, 2017 · 4 comments

Comments

@andy-hanson
Copy link
Contributor

The tslint npm package contains autogenerated .d.ts files from source file.
Presumably only index.d.ts is public though?
Is there a way that only that can be published?

@adidahiya
Copy link
Contributor

We generally consider the public API to include symbols exported from index.d.ts. Users may import symbols from submodules, but those are not guaranteed to be stable or follow semver.

// ok
import { Linter } from "tslint";

// use at your own risk
import * as LanguageUtils from "tslint/lib/language/utils";

Excluding "non-public" types from the distribution seems like extra effort & complexity that doesn't provide many benefits. We might consider marking certain things we really don't want to make available as /** @internal */ to elide them from typings, but there would have to be a convincing reason to do it.

@JoshuaKGoldberg
Copy link
Contributor

SGTM. Is this documented anywhere?

@JoshuaKGoldberg
Copy link
Contributor

💀 It's time! 💀

TSLint is being deprecated and no longer accepting pull requests for major new changes or features. See #4534. 😱

If you'd like to see this change implemented, you have two choices:

  • Recommended: Check if this is available in ESLint + typescript-eslint
  • Not Recommended: Fork TSLint locally 🤷‍♂️

👋 It was a pleasure open sourcing with you!

If you believe this message was posted here in error, please comment so we can re-open the issue!

@JoshuaKGoldberg
Copy link
Contributor

🤖 Beep boop! 👉 TSLint is deprecated 👈 (#4534) and you should switch to typescript-eslint! 🤖

🔒 This issue is being locked to prevent further unnecessary discussions. Thank you! 👋

@palantir palantir locked and limited conversation to collaborators Mar 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants