Skip to content

Switch detailed rule differences to info (file) output #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
JoshuaKGoldberg opened this issue Apr 25, 2020 · 0 comments · Fixed by #408
Closed

Switch detailed rule differences to info (file) output #404

JoshuaKGoldberg opened this issue Apr 25, 2020 · 0 comments · Fixed by #408
Assignees
Labels
status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Apr 25, 2020

🚀 Feature Request

Rule behavior changes are pretty verbose in a lot of configurations. They're the only category of verbose, many-line output with all output written to stdout. Others log a small summary to stdout and put details in the log file.

Existing Behavior

As of #246, typical CLI output might look like this:

λ tslint-to-eslint-config --comments *.ts
✨ 90 rules replaced with their ESLint equivalents. ✨

❗ 7 ESLint rules behave differently from their TSLint counterparts ❗
  * camelcase:
    - Leading undescores in variable names will now be ignored.
    - ESLint's camel-case rule does not allow pascal or snake case variable names. Those cases are reserved for class names and static methods.
  * no-underscore-dangle:
    - Leading and trailing underscores (_) on identifiers will now be ignored.
  * space-before-function-paren:
    - Option "method" is not supported by ESLint.
    - Option "constructor" is not supported by ESLint.
  * no-console:
    - Custom console methods, if they exist, will no longer be allowed.
  * import/no-extraneous-dependencies:
    - ESLint does not support whitelisting modules
  * no-invalid-this:
    - Functions in methods will no longer be ignored.
  * no-unused-expressions:
    - The TSLint optional config "allow-new" is the default ESLint behavior and will no longer be ignored.

❌ 1 error thrown. ❌
  Check ./tslint-to-eslint-config.log for details.
️
❓ 1 rule does not yet have an ESLint equivalent ❓
  See generated log file; defaulting to eslint-plugin-tslint for it.

⚡ 4 packages are required for new ESLint rules. ⚡
  eslint-plugin-import
  import
  eslint-plugin-jsdoc
  prefer-arrow

♻ 2 files of TSLint comment directives converted to ESLint. ♻

✅ All is well! ✅

Change Proposal

Let's print the typical "see *.log for details" file instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant